From f6086b8054d8a07ed0c9bf81d44df0d813219c69 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Mon, 19 Aug 2019 00:40:37 +0200 Subject: [PATCH] Update the MDX files for each tool --- .../tools/@0x/asset-buyer/v6.1.10/README.md | 83 - .../@0x/asset-buyer/v6.1.10/reference.mdx | 1352 - .../@0x/asset-buyer/v6.1.11/reference.mdx | 675 +- .../tools/@0x/asset-swapper/v1.0.0/README.md | 84 - .../@0x/asset-swapper/v1.0.0/reference.mdx | 3385 -- .../@0x/asset-swapper/v1.0.1/reference.mdx | 1575 +- .../mdx/tools/@0x/connect/v5.0.15/README.md | 74 - .../tools/@0x/connect/v5.0.15/reference.mdx | 647 - .../tools/@0x/connect/v5.0.16/reference.mdx | 248 +- .../@0x/contract-wrappers/v10.1.0/README.md | 89 - .../contract-wrappers/v10.1.0/reference.mdx | 5657 --- .../contract-wrappers/v11.0.0/reference.mdx | 32879 ++++++++++++++-- .../tools/@0x/json-schemas/v3.1.12/README.md | 83 - .../@0x/json-schemas/v3.1.12/reference.mdx | 107 - .../@0x/json-schemas/v3.1.13/reference.mdx | 44 +- .../tools/@0x/migrations/v4.1.11/README.md | 104 - .../@0x/migrations/v4.1.11/reference.mdx | 228 - .../tools/@0x/migrations/v4.2.0/reference.mdx | 139 +- .../tools/@0x/order-utils/v8.2.4/README.md | 65 - .../@0x/order-utils/v8.2.4/reference.mdx | 1688 - .../@0x/order-utils/v8.2.5/reference.mdx | 699 +- .../tools/@0x/sol-compiler/v3.1.11/README.md | 97 - .../@0x/sol-compiler/v3.1.11/reference.mdx | 401 - .../@0x/sol-compiler/v3.1.12/reference.mdx | 235 +- .../tools/@0x/sol-coverage/v3.0.8/README.md | 75 - .../@0x/sol-coverage/v3.0.8/reference.mdx | 212 - .../@0x/sol-coverage/v3.0.9/reference.mdx | 91 +- .../tools/@0x/sol-profiler/v3.1.10/README.md | 75 - .../@0x/sol-profiler/v3.1.10/reference.mdx | 175 - .../@0x/sol-profiler/v3.1.11/reference.mdx | 69 +- .../mdx/tools/@0x/sol-trace/v2.0.16/README.md | 75 - .../tools/@0x/sol-trace/v2.0.16/reference.mdx | 161 - .../tools/@0x/sol-trace/v2.0.17/reference.mdx | 63 +- .../tools/@0x/subproviders/v5.0.0/README.md | 100 - .../@0x/subproviders/v5.0.0/reference.mdx | 3232 -- .../@0x/subproviders/v5.0.1/reference.mdx | 1199 +- .../@0x/web3-wrapper/v6.0.10/reference.mdx | 864 +- .../tools/@0x/web3-wrapper/v6.0.9/README.md | 71 - .../@0x/web3-wrapper/v6.0.9/reference.mdx | 2026 - .../tools/ethereum-types/v2.1.4/reference.mdx | 2890 +- packages/website/ts/utils/algolia_helpers.ts | 6 +- packages/website/ts/utils/algolia_meta.json | 26 +- 42 files changed, 32046 insertions(+), 30002 deletions(-) delete mode 100644 packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/README.md delete mode 100644 packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/README.md delete mode 100644 packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/connect/v5.0.15/README.md delete mode 100644 packages/website/mdx/tools/@0x/connect/v5.0.15/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/README.md delete mode 100644 packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/json-schemas/v3.1.12/README.md delete mode 100644 packages/website/mdx/tools/@0x/json-schemas/v3.1.12/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/migrations/v4.1.11/README.md delete mode 100644 packages/website/mdx/tools/@0x/migrations/v4.1.11/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/order-utils/v8.2.4/README.md delete mode 100644 packages/website/mdx/tools/@0x/order-utils/v8.2.4/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/README.md delete mode 100644 packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/README.md delete mode 100644 packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/README.md delete mode 100644 packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/sol-trace/v2.0.16/README.md delete mode 100644 packages/website/mdx/tools/@0x/sol-trace/v2.0.16/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/subproviders/v5.0.0/README.md delete mode 100644 packages/website/mdx/tools/@0x/subproviders/v5.0.0/reference.mdx delete mode 100644 packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/README.md delete mode 100644 packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/reference.mdx diff --git a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/README.md b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/README.md deleted file mode 100644 index 50a2c3ae0e..0000000000 --- a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/README.md +++ /dev/null @@ -1,83 +0,0 @@ -## @0x/asset-buyer - -Convenience package for buying assets represented on the Ethereum blockchain using 0x. In its simplest form, the package helps in the usage of the [0x forwarder contract](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md), which allows users to execute [Wrapped Ether](https://weth.io/) based 0x orders without having to set allowances, wrap Ether or own ZRX, meaning they can buy tokens with Ether alone. Given some liquidity (0x signed orders), it helps estimate the Ether cost of buying a certain asset (giving a range) and then buying that asset. - -In its more advanced and useful form, it integrates with the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) and takes care of sourcing liquidity for you given an SRA compliant endpoint. The final result is a library that tells you what assets are available, provides an Ether based quote for any asset desired, and allows you to buy that asset using Ether alone. - -## Installation - -```bash -yarn add @0x/asset-buyer -``` - -**Import** - -```typescript -import { AssetBuyer } from '@0x/asset-buyer'; -``` - -or - -```javascript -var AssetBuyer = require('@0x/asset-buyer').AssetBuyer; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/asset-buyer yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/asset-buyer yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/reference.mdx b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/reference.mdx deleted file mode 100644 index 81dec0d125..0000000000 --- a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.10/reference.mdx +++ /dev/null @@ -1,1352 +0,0 @@ -> # Class: AssetBuyer - -## Hierarchy - -* **AssetBuyer** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [expiryBufferSeconds](#expirybufferseconds) -* [networkId](#networkid) -* [orderProvider](#orderprovider) -* [orderRefreshIntervalMs](#orderrefreshintervalms) -* [provider](#provider) - -### Methods - -* [executeBuyQuoteAsync](#executebuyquoteasync) -* [getAvailableAssetDatasAsync](#getavailableassetdatasasync) -* [getBuyQuoteAsync](#getbuyquoteasync) -* [getBuyQuoteForERC20TokenAddressAsync](#getbuyquoteforerc20tokenaddressasync) -* [getLiquidityForAssetDataAsync](#getliquidityforassetdataasync) -* [getOrdersAndFillableAmountsAsync](#getordersandfillableamountsasync) -* [getAssetBuyerForProvidedOrders](#static-getassetbuyerforprovidedorders) -* [getAssetBuyerForStandardRelayerAPIUrl](#static-getassetbuyerforstandardrelayerapiurl) - -## Constructors - -### constructor - -\+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-assetbuyer)* - -*Defined in [asset_buyer.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L84)* - -Instantiates a new AssetBuyer instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L41)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L39)* - -___ - -### orderProvider - -• **orderProvider**: *[OrderProvider](#interface-orderprovider)* - -*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L38)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L40)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L37)* - -## Methods - -### executeBuyQuoteAsync - -▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial`): *`Promise`* - -*Defined in [asset_buyer.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L227)* - -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.ts:297](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L297)* - -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.ts:126](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L126)* - -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.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L174)* - -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.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L193)* - -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.ts:306](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L306)* - -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`, `orders`: `SignedOrder`[], `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* - -*Defined in [asset_buyer.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L54)* - -Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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`, `sraApiUrl`: string, `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* - -*Defined in [asset_buyer.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L73)* - -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` | - | The Provider instance you would like to use for interacting with the Ethereum network. | -`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. | -`options` | `Partial` | {} | Initialization options for the AssetBuyer. See type definition for details. | - -**Returns:** *[AssetBuyer](#class-assetbuyer)* - -An instance of AssetBuyer - -
- -> # Class: InsufficientAssetLiquidityError - -Error class representing insufficient asset liquidity - -## Hierarchy - -* `Error` - - * **InsufficientAssetLiquidityError** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [amountAvailableToFill](#amountavailabletofill) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor - -\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* - -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`amountAvailableToFill` | `BigNumber` | The amount availabe to fill (in base units) factoring in slippage | - -**Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* - -## Properties - -### amountAvailableToFill - -• **amountAvailableToFill**: *`BigNumber`* - -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)* - -The amount availabe to fill (in base units) factoring in slippage. - -___ - -### message - -• **message**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### `Static` Error - -▪ **Error**: *`ErrorConstructor`* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 - -
- -> # Class: BasicOrderProvider - -## Hierarchy - -* **BasicOrderProvider** - -## Implements - -* [OrderProvider](#interface-orderprovider) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [orders](#orders) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor - -\+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)* - -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* - -Instantiates a new BasicOrderProvider instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects that conform to SignedOrder to fetch from. | - -**Returns:** *[BasicOrderProvider](#class-basicorderprovider)* - -An instance of BasicOrderProvider - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* - -## Methods - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`takerAssetData` | string | A string representing the taker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be purchased using takerAssetData. - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | An instance of OrderFetcherRequest. See type for more information. | - -**Returns:** *`Promise`* - -An instance of OrderProviderResponse. See type for more information. - -
- -> # Class: StandardRelayerAPIOrderProvider - -## Hierarchy - -* **StandardRelayerAPIOrderProvider** - -## Implements - -* [OrderProvider](#interface-orderprovider) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [apiUrl](#apiurl) -* [networkId](#networkid) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor - -\+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)* - -Instantiates a new StandardRelayerAPIOrderProvider instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`apiUrl` | string | The standard relayer API base HTTP url you would like to source orders from. | -`networkId` | number | The ethereum network id. | - -**Returns:** *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* - -An instance of StandardRelayerAPIOrderProvider - -## Properties - -### apiUrl - -• **apiUrl**: *string* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)* - -## Methods - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`takerAssetData` | string | A string representing the taker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be purchased using takerAssetData. - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | An instance of OrderProviderRequest. See type for more information. | - -**Returns:** *`Promise`* - -An instance of OrderProviderResponse. See type for more information. - -
- -> # Enumeration: AssetBuyerError - -Possible error messages thrown by an AssetBuyer instance or associated static methods. - -## Index - -### Enumeration members - -* [AssetUnavailable](#assetunavailable) -* [InsufficientAssetLiquidity](#insufficientassetliquidity) -* [InsufficientZrxLiquidity](#insufficientzrxliquidity) -* [InvalidOrderProviderResponse](#invalidorderproviderresponse) -* [NoAddressAvailable](#noaddressavailable) -* [NoEtherTokenContractFound](#noethertokencontractfound) -* [NoZrxTokenContractFound](#nozrxtokencontractfound) -* [SignatureRequestDenied](#signaturerequestdenied) -* [StandardRelayerApiError](#standardrelayerapierror) -* [TransactionValueTooLow](#transactionvaluetoolow) - -## Enumeration members - -### AssetUnavailable - -• **AssetUnavailable**: = "ASSET_UNAVAILABLE" - -*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L122)* - -___ - -### InsufficientAssetLiquidity - -• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" - -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L118)* - -___ - -### InsufficientZrxLiquidity - -• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" - -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L119)* - -___ - -### InvalidOrderProviderResponse - -• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" - -*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L121)* - -___ - -### NoAddressAvailable - -• **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" - -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L120)* - -___ - -### NoEtherTokenContractFound - -• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" - -*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L115)* - -___ - -### NoZrxTokenContractFound - -• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" - -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L116)* - -___ - -### SignatureRequestDenied - -• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" - -*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L123)* - -___ - -### StandardRelayerApiError - -• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" - -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L117)* - -___ - -### TransactionValueTooLow - -• **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" - -*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L124)* - -
- -> # Interface: AssetBuyerOpts - -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). -expiryBufferSeconds: The number of seconds to add when calculating whether an order is expired or not. Defaults to 300s (5m). - -## Hierarchy - -* **AssetBuyerOpts** - -## Index - -### Properties - -* [expiryBufferSeconds](#expirybufferseconds) -* [networkId](#networkid) -* [orderRefreshIntervalMs](#orderrefreshintervalms) - -## Properties - -### expiryBufferSeconds - -• **expiryBufferSeconds**: *number* - -*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L108)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L106)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L107)* - -
- -> # Interface: BuyQuote - -assetData: String that represents a specific asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). -assetBuyAmount: The amount of asset to buy. -orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested assetBuyAmount plus slippage. -feeOrders: An array of objects conforming to SignedOrder. These orders can be used to cover the fees for the orders param above. -feePercentage: Optional affiliate fee percentage used to calculate the eth amounts above. -bestCaseQuoteInfo: Info about the best case price for the asset. -worstCaseQuoteInfo: Info about the worst case price for the asset. - -## Hierarchy - -* **BuyQuote** - -## Index - -### Properties - -* [assetBuyAmount](#assetbuyamount) -* [assetData](#assetdata) -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#optional-feepercentage) -* [orders](#orders) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### assetBuyAmount - -• **assetBuyAmount**: *`BigNumber`* - -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L48)* - -___ - -### assetData - -• **assetData**: *string* - -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L47)* - -___ - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)* - -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L52)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L50)* - -___ - -### `Optional` feePercentage - -• **feePercentage**? : *undefined | number* - -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L51)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L49)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)* - -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L53)* - -
- -> # Interface: BuyQuoteExecutionOpts - -ethAmount: The desired amount of eth to spend. Defaults to buyQuote.worstCaseQuoteInfo.totalEthAmount. -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 -feeRecipient: The address where affiliate fees are sent. Defaults to null address (0x000...000). - -## Hierarchy - -* **BuyQuoteExecutionOpts** - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L93)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L97)* - -___ - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L95)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L96)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L94)* - -
- -> # Interface: BuyQuoteInfo - -assetEthAmount: The amount of eth required to pay for the requested asset. -feeEthAmount: The amount of eth required to pay the affiliate fee. -totalEthAmount: The total amount of eth required to complete the buy (filling orders, feeOrders, and paying affiliate fee). - -## Hierarchy - -* **BuyQuoteInfo** - -## Index - -### Properties - -* [assetEthAmount](#assetethamount) -* [feeEthAmount](#feeethamount) -* [totalEthAmount](#totalethamount) - -## Properties - -### assetEthAmount - -• **assetEthAmount**: *`BigNumber`* - -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L62)* - -___ - -### feeEthAmount - -• **feeEthAmount**: *`BigNumber`* - -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L63)* - -___ - -### totalEthAmount - -• **totalEthAmount**: *`BigNumber`* - -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L64)* - -
- -> # Interface: BuyQuoteRequestOpts - -feePercentage: The affiliate fee percentage. Defaults to 0. -shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false. -slippagePercentage: The percentage buffer to add to account for slippage. Affects max ETH price estimates. Defaults to 0.2 (20%). - -## Hierarchy - -* **BuyQuoteRequestOpts** - -## Index - -### Properties - -* [feePercentage](#feepercentage) -* [shouldForceOrderRefresh](#shouldforceorderrefresh) -* [slippagePercentage](#slippagepercentage) - -## Properties - -### feePercentage - -• **feePercentage**: *number* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L73)* - -___ - -### shouldForceOrderRefresh - -• **shouldForceOrderRefresh**: *boolean* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L74)* - -___ - -### slippagePercentage - -• **slippagePercentage**: *number* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L75)* - -
- -> # Interface: LiquidityForAssetData - -Represents available liquidity for a given assetData - -## Hierarchy - -* **LiquidityForAssetData** - -## Index - -### Properties - -* [ethValueAvailableInWei](#ethvalueavailableinwei) -* [tokensAvailableInBaseUnits](#tokensavailableinbaseunits) - -## Properties - -### ethValueAvailableInWei - -• **ethValueAvailableInWei**: *`BigNumber`* - -*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L141)* - -___ - -### tokensAvailableInBaseUnits - -• **tokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L140)* - -
- -> # Interface: OrderProvider - -gerOrdersAsync: Given an OrderProviderRequest, get an OrderProviderResponse. -getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all availabled paired maker asset data strings. - -## Hierarchy - -* **OrderProvider** - -## Implemented by - -* [BasicOrderProvider](#class-basicorderprovider) -* [StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - -## Index - -### Properties - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Properties - -### getAvailableMakerAssetDatasAsync - -• **getAvailableMakerAssetDatasAsync**: *function* - -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L34)* - -#### Type declaration: - -▸ (`takerAssetData`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`takerAssetData` | string | - -___ - -### getOrdersAsync - -• **getOrdersAsync**: *function* - -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L33)* - -#### Type declaration: - -▸ (`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | - -
- -> # Interface: OrderProviderRequest - -makerAssetData: The assetData representing the desired makerAsset. -takerAssetData: The assetData representing the desired takerAsset. -networkId: The networkId that the desired orders should be for. - -## Hierarchy - -* **OrderProviderRequest** - -## Index - -### Properties - -* [makerAssetData](#makerassetdata) -* [takerAssetData](#takerassetdata) - -## Properties - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L10)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L11)* - -
- -> # Interface: OrderProviderResponse - -orders: An array of orders with optional remaining fillable makerAsset amounts. See type for more info. - -## Hierarchy - -* **OrderProviderResponse** - -## Index - -### Properties - -* [orders](#orders) - -## Properties - -### orders - -• **orders**: *[SignedOrderWithRemainingFillableMakerAssetAmount](#interface-signedorderwithremainingfillablemakerassetamount)[]* - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L18)* - -
- -> # Interface: OrdersAndFillableAmounts - -orders: An array of signed orders -remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order. - -## Hierarchy - -* **OrdersAndFillableAmounts** - -## Index - -### Properties - -* [orders](#orders) -* [remainingFillableMakerAssetAmounts](#remainingfillablemakerassetamounts) - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L132)* - -___ - -### remainingFillableMakerAssetAmounts - -• **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* - -*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L133)* - -
- -> # Interface: SignedOrderWithRemainingFillableMakerAssetAmount - -A normal SignedOrder with one extra optional property `remainingFillableMakerAssetAmount` -remainingFillableMakerAssetAmount: The amount of the makerAsset that is available to be filled - -## Hierarchy - -* `SignedOrder` - - * **SignedOrderWithRemainingFillableMakerAssetAmount** - -## Index - -### Properties - -* [exchangeAddress](#exchangeaddress) -* [expirationTimeSeconds](#expirationtimeseconds) -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetAmount](#makerassetamount) -* [makerAssetData](#makerassetdata) -* [makerFee](#makerfee) -* [remainingFillableMakerAssetAmount](#optional-remainingfillablemakerassetamount) -* [salt](#salt) -* [senderAddress](#senderaddress) -* [signature](#signature) -* [takerAddress](#takeraddress) -* [takerAssetAmount](#takerassetamount) -* [takerAssetData](#takerassetdata) -* [takerFee](#takerfee) - -## Properties - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:14 - -___ - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:16 - -___ - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:15 - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:5 - -___ - -### makerAssetAmount - -• **makerAssetAmount**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:9 - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:11 - -___ - -### makerFee - -• **makerFee**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:7 - -___ - -### `Optional` remainingFillableMakerAssetAmount - -• **remainingFillableMakerAssetAmount**? : *`BigNumber`* - -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L26)* - -___ - -### salt - -• **salt**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:13 - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:4 - -___ - -### signature - -• **signature**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:33 - -___ - -### takerAddress - -• **takerAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:6 - -___ - -### takerAssetAmount - -• **takerAssetAmount**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:10 - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:12 - -___ - -### takerFee - -• **takerFee**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:8 - -
- -* [Globals](globals.md) -* [External Modules]() - * [asset_buyer](modules/_asset_buyer_.md) - * [asset_buyer.AssetBuyer](#class-assetbuyer) - * [constants](modules/_constants_.md) - * [errors](modules/_errors_.md) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [index](modules/_index_.md) - * [order_providers/basic_order_provider](modules/_order_providers_basic_order_provider_.md) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider](modules/_order_providers_standard_relayer_api_order_provider_.md) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [types](modules/_types_.md) - * [types.AssetBuyerError](#class-assetbuyererror) - * [types.AssetBuyerOpts](#class-assetbuyeropts) - * [types.BuyQuote](#class-buyquote) - * [types.BuyQuoteExecutionOpts](#class-buyquoteexecutionopts) - * [types.BuyQuoteInfo](#class-buyquoteinfo) - * [types.BuyQuoteRequestOpts](#class-buyquoterequestopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [utils/assert](modules/_utils_assert_.md) - * [utils/asset_data_utils](modules/_utils_asset_data_utils_.md) - * [utils/buy_quote_calculator](modules/_utils_buy_quote_calculator_.md) - * [utils/calculate_liquidity](modules/_utils_calculate_liquidity_.md) - * [utils/order_provider_response_processor](modules/_utils_order_provider_response_processor_.md) -* [Classes]() - * [asset_buyer.AssetBuyer](#class-assetbuyer) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) -* [Enums]() - * [types.AssetBuyerError](#class-assetbuyererror) -* [Interfaces]() - * [types.AssetBuyerOpts](#class-assetbuyeropts) - * [types.BuyQuote](#class-buyquote) - * [types.BuyQuoteExecutionOpts](#class-buyquoteexecutionopts) - * [types.BuyQuoteInfo](#class-buyquoteinfo) - * [types.BuyQuoteRequestOpts](#class-buyquoterequestopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - -
- diff --git a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx index 81dec0d125..e901ff0f65 100644 --- a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx +++ b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx @@ -1,41 +1,17 @@ -> # Class: AssetBuyer +# Class: AssetBuyer -## Hierarchy +### Hierarchy * **AssetBuyer** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Properties +\+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* -* [expiryBufferSeconds](#expirybufferseconds) -* [networkId](#networkid) -* [orderProvider](#orderprovider) -* [orderRefreshIntervalMs](#orderrefreshintervalms) -* [provider](#provider) - -### Methods - -* [executeBuyQuoteAsync](#executebuyquoteasync) -* [getAvailableAssetDatasAsync](#getavailableassetdatasasync) -* [getBuyQuoteAsync](#getbuyquoteasync) -* [getBuyQuoteForERC20TokenAddressAsync](#getbuyquoteforerc20tokenaddressasync) -* [getLiquidityForAssetDataAsync](#getliquidityforassetdataasync) -* [getOrdersAndFillableAmountsAsync](#getordersandfillableamountsasync) -* [getAssetBuyerForProvidedOrders](#static-getassetbuyerforprovidedorders) -* [getAssetBuyerForStandardRelayerAPIUrl](#static-getassetbuyerforstandardrelayerapiurl) - -## Constructors - -### constructor - -\+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-assetbuyer)* - -*Defined in [asset_buyer.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L84)* +*Defined in [asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L83)* Instantiates a new AssetBuyer instance @@ -51,53 +27,53 @@ Name | Type | Default | Description | An instance of AssetBuyer -## Properties +### Properties -### expiryBufferSeconds +## expiryBufferSeconds • **expiryBufferSeconds**: *number* -*Defined in [asset_buyer.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L41)* +*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L40)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L39)* +*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L38)* ___ -### orderProvider +## orderProvider • **orderProvider**: *[OrderProvider](#interface-orderprovider)* -*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L38)* +*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L37)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L40)* +*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L39)* ___ -### provider +## provider • **provider**: *`ZeroExProvider`* -*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L37)* +*Defined in [asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L36)* -## Methods +### Methods -### executeBuyQuoteAsync +## executeBuyQuoteAsync ▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial`): *`Promise`* -*Defined in [asset_buyer.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L227)* +*Defined in [asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L226)* Given a BuyQuote and desired rate, attempt to execute the buy. @@ -114,11 +90,11 @@ A promise of the txHash. ___ -### getAvailableAssetDatasAsync +## getAvailableAssetDatasAsync ▸ **getAvailableAssetDatasAsync**(): *`Promise`* -*Defined in [asset_buyer.ts:297](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L297)* +*Defined in [asset_buyer.ts:302](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -128,11 +104,11 @@ An array of asset data strings that can be purchased using wETH. ___ -### getBuyQuoteAsync +## getBuyQuoteAsync ▸ **getBuyQuoteAsync**(`assetData`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset_buyer.ts:126](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L126)* +*Defined in [asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -151,11 +127,11 @@ An object that conforms to BuyQuote that satisfies the request. See type definit ___ -### getBuyQuoteForERC20TokenAddressAsync +## getBuyQuoteForERC20TokenAddressAsync ▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset_buyer.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L174)* +*Defined in [asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -174,11 +150,11 @@ An object that conforms to BuyQuote that satisfies the request. See type definit ___ -### getLiquidityForAssetDataAsync +## getLiquidityForAssetDataAsync ▸ **getLiquidityForAssetDataAsync**(`assetData`: string, `options`: `Partial`): *`Promise`* -*Defined in [asset_buyer.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L193)* +*Defined in [asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L192)* Returns information about available liquidity for an asset Does not factor in slippage or fees @@ -196,11 +172,11 @@ An object that conforms to LiquidityForAssetData that satisfies the request. See ___ -### getOrdersAndFillableAmountsAsync +## getOrdersAndFillableAmountsAsync ▸ **getOrdersAndFillableAmountsAsync**(`assetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise`* -*Defined in [asset_buyer.ts:306](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L306)* +*Defined in [asset_buyer.ts:311](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -215,11 +191,11 @@ Name | Type | Description | ___ -### `Static` getAssetBuyerForProvidedOrders +## `Static` getAssetBuyerForProvidedOrders ▸ **getAssetBuyerForProvidedOrders**(`supportedProvider`: `SupportedProvider`, `orders`: `SignedOrder`[], `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* -*Defined in [asset_buyer.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L54)* +*Defined in [asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/asset_buyer.ts#L53)* Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders. @@ -237,11 +213,11 @@ An instance of AssetBuyer ___ -### `Static` getAssetBuyerForStandardRelayerAPIUrl +## `Static` getAssetBuyerForStandardRelayerAPIUrl ▸ **getAssetBuyerForStandardRelayerAPIUrl**(`supportedProvider`: `SupportedProvider`, `sraApiUrl`: string, `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* -*Defined in [asset_buyer.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L73)* +*Defined in [asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -259,37 +235,24 @@ An instance of AssetBuyer
-> # Class: InsufficientAssetLiquidityError +# Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity -## Hierarchy +### Hierarchy * `Error` * **InsufficientAssetLiquidityError** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [amountAvailableToFill](#amountavailabletofill) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor +## constructer \+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/errors.ts#L12)* **Parameters:** @@ -299,90 +262,76 @@ Name | Type | Description | **Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -## Properties +### Properties -### amountAvailableToFill +## amountAvailableToFill • **amountAvailableToFill**: *`BigNumber`* -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/errors.ts#L12)* The amount availabe to fill (in base units) factoring in slippage. ___ -### message +## message • **message**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 + + ___ -### name +## name • **name**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 + + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 + ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 +
-> # Class: BasicOrderProvider +# Class: BasicOrderProvider -## Hierarchy +### Hierarchy * **BasicOrderProvider** -## Implements +### Implements * [OrderProvider](#interface-orderprovider) -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [orders](#orders) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor +## constructer \+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)* -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* Instantiates a new BasicOrderProvider instance @@ -396,21 +345,21 @@ Name | Type | Description | An instance of BasicOrderProvider -## Properties +### Properties -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)* -## Methods +### Methods -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L37)* +*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -426,11 +375,11 @@ An array of asset data strings that can be purchased using takerAssetData. ___ -### getOrdersAsync +## getOrdersAsync ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L24)* +*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -446,39 +395,24 @@ An instance of OrderProviderResponse. See type for more information.
-> # Class: StandardRelayerAPIOrderProvider +# Class: StandardRelayerAPIOrderProvider -## Hierarchy +### Hierarchy * **StandardRelayerAPIOrderProvider** -## Implements +### Implements * [OrderProvider](#interface-orderprovider) -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [apiUrl](#apiurl) -* [networkId](#networkid) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor +## constructer \+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)* Instantiates a new StandardRelayerAPIOrderProvider instance @@ -493,29 +427,29 @@ Name | Type | Description | An instance of StandardRelayerAPIOrderProvider -## Properties +### Properties -### apiUrl +## apiUrl • **apiUrl**: *string* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)* -## Methods +### Methods -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L91)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -531,11 +465,11 @@ An array of asset data strings that can be purchased using takerAssetData. ___ -### getOrdersAsync +## getOrdersAsync ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L67)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -551,152 +485,131 @@ An instance of OrderProviderResponse. See type for more information.
-> # Enumeration: AssetBuyerError +# Enumeration: AssetBuyerError Possible error messages thrown by an AssetBuyer instance or associated static methods. -## Index ### Enumeration members -* [AssetUnavailable](#assetunavailable) -* [InsufficientAssetLiquidity](#insufficientassetliquidity) -* [InsufficientZrxLiquidity](#insufficientzrxliquidity) -* [InvalidOrderProviderResponse](#invalidorderproviderresponse) -* [NoAddressAvailable](#noaddressavailable) -* [NoEtherTokenContractFound](#noethertokencontractfound) -* [NoZrxTokenContractFound](#nozrxtokencontractfound) -* [SignatureRequestDenied](#signaturerequestdenied) -* [StandardRelayerApiError](#standardrelayerapierror) -* [TransactionValueTooLow](#transactionvaluetoolow) - -## Enumeration members - -### AssetUnavailable +## AssetUnavailable • **AssetUnavailable**: = "ASSET_UNAVAILABLE" -*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L122)* +*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L122)* ___ -### InsufficientAssetLiquidity +## InsufficientAssetLiquidity • **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L118)* ___ -### InsufficientZrxLiquidity +## InsufficientZrxLiquidity • **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L119)* ___ -### InvalidOrderProviderResponse +## InvalidOrderProviderResponse • **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" -*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L121)* ___ -### NoAddressAvailable +## NoAddressAvailable • **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L120)* ___ -### NoEtherTokenContractFound +## NoEtherTokenContractFound • **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" -*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L115)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L115)* ___ -### NoZrxTokenContractFound +## NoZrxTokenContractFound • **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L116)* ___ -### SignatureRequestDenied +## SignatureRequestDenied • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L123)* +*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L123)* ___ -### StandardRelayerApiError +## StandardRelayerApiError • **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L117)* ___ -### TransactionValueTooLow +## TransactionValueTooLow • **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" -*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L124)*
-> # Interface: AssetBuyerOpts +# Interface: AssetBuyerOpts 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). expiryBufferSeconds: The number of seconds to add when calculating whether an order is expired or not. Defaults to 300s (5m). -## Hierarchy +### Hierarchy * **AssetBuyerOpts** -## Index ### Properties -* [expiryBufferSeconds](#expirybufferseconds) -* [networkId](#networkid) -* [orderRefreshIntervalMs](#orderrefreshintervalms) - -## Properties - -### expiryBufferSeconds +## expiryBufferSeconds • **expiryBufferSeconds**: *number* -*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L108)* +*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L108)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L106)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L106)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L107)*
-> # Interface: BuyQuote +# Interface: BuyQuote assetData: String that represents a specific asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). assetBuyAmount: The amount of asset to buy. @@ -706,81 +619,70 @@ feePercentage: Optional affiliate fee percentage used to calculate the eth amoun bestCaseQuoteInfo: Info about the best case price for the asset. worstCaseQuoteInfo: Info about the worst case price for the asset. -## Hierarchy +### Hierarchy * **BuyQuote** -## Index ### Properties -* [assetBuyAmount](#assetbuyamount) -* [assetData](#assetdata) -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#optional-feepercentage) -* [orders](#orders) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### assetBuyAmount +## assetBuyAmount • **assetBuyAmount**: *`BigNumber`* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L48)* ___ -### assetData +## assetData • **assetData**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L47)* ___ -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)* -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L52)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L50)* ___ -### `Optional` feePercentage +## `Optional` feePercentage • **feePercentage**? : *undefined | number* -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L51)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L49)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)* -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L53)*
-> # Interface: BuyQuoteExecutionOpts +# Interface: BuyQuoteExecutionOpts ethAmount: The desired amount of eth to spend. Defaults to buyQuote.worstCaseQuoteInfo.totalEthAmount. takerAddress: The address to perform the buy. Defaults to the first available address from the provider. @@ -788,211 +690,176 @@ gasLimit: The amount of gas to send with a transaction (in Gwei). Defaults to an gasPrice: Gas price in Wei to use for a transaction feeRecipient: The address where affiliate fees are sent. Defaults to null address (0x000...000). -## Hierarchy +### Hierarchy * **BuyQuoteExecutionOpts** -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* -*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L93)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L97)* +*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L97)* ___ -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* -*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L95)* +*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L95)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L96)* +*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L96)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* -*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L94)*
-> # Interface: BuyQuoteInfo +# Interface: BuyQuoteInfo assetEthAmount: The amount of eth required to pay for the requested asset. feeEthAmount: The amount of eth required to pay the affiliate fee. totalEthAmount: The total amount of eth required to complete the buy (filling orders, feeOrders, and paying affiliate fee). -## Hierarchy +### Hierarchy * **BuyQuoteInfo** -## Index ### Properties -* [assetEthAmount](#assetethamount) -* [feeEthAmount](#feeethamount) -* [totalEthAmount](#totalethamount) - -## Properties - -### assetEthAmount +## assetEthAmount • **assetEthAmount**: *`BigNumber`* -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L62)* ___ -### feeEthAmount +## feeEthAmount • **feeEthAmount**: *`BigNumber`* -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L63)* ___ -### totalEthAmount +## totalEthAmount • **totalEthAmount**: *`BigNumber`* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L64)*
-> # Interface: BuyQuoteRequestOpts +# Interface: BuyQuoteRequestOpts feePercentage: The affiliate fee percentage. Defaults to 0. shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false. slippagePercentage: The percentage buffer to add to account for slippage. Affects max ETH price estimates. Defaults to 0.2 (20%). -## Hierarchy +### Hierarchy * **BuyQuoteRequestOpts** -## Index ### Properties -* [feePercentage](#feepercentage) -* [shouldForceOrderRefresh](#shouldforceorderrefresh) -* [slippagePercentage](#slippagepercentage) - -## Properties - -### feePercentage +## feePercentage • **feePercentage**: *number* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L73)* ___ -### shouldForceOrderRefresh +## shouldForceOrderRefresh • **shouldForceOrderRefresh**: *boolean* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L74)* ___ -### slippagePercentage +## slippagePercentage • **slippagePercentage**: *number* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L75)*
-> # Interface: LiquidityForAssetData +# Interface: LiquidityForAssetData Represents available liquidity for a given assetData -## Hierarchy +### Hierarchy * **LiquidityForAssetData** -## Index ### Properties -* [ethValueAvailableInWei](#ethvalueavailableinwei) -* [tokensAvailableInBaseUnits](#tokensavailableinbaseunits) - -## Properties - -### ethValueAvailableInWei +## ethValueAvailableInWei • **ethValueAvailableInWei**: *`BigNumber`* -*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L141)* ___ -### tokensAvailableInBaseUnits +## tokensAvailableInBaseUnits • **tokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L140)*
-> # Interface: OrderProvider +# Interface: OrderProvider gerOrdersAsync: Given an OrderProviderRequest, get an OrderProviderResponse. getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all availabled paired maker asset data strings. -## Hierarchy +### Hierarchy * **OrderProvider** -## Implemented by +### Implemented by * [BasicOrderProvider](#class-basicorderprovider) * [StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) -## Index ### Properties -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Properties - -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync • **getAvailableMakerAssetDatasAsync**: *function* -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L34)* #### Type declaration: @@ -1006,11 +873,11 @@ Name | Type | ___ -### getOrdersAsync +## getOrdersAsync • **getOrdersAsync**: *function* -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L33)* #### Type declaration: @@ -1024,329 +891,241 @@ Name | Type |
-> # Interface: OrderProviderRequest +# Interface: OrderProviderRequest makerAssetData: The assetData representing the desired makerAsset. takerAssetData: The assetData representing the desired takerAsset. networkId: The networkId that the desired orders should be for. -## Hierarchy +### Hierarchy * **OrderProviderRequest** -## Index ### Properties -* [makerAssetData](#makerassetdata) -* [takerAssetData](#takerassetdata) - -## Properties - -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L10)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L11)*
-> # Interface: OrderProviderResponse +# Interface: OrderProviderResponse orders: An array of orders with optional remaining fillable makerAsset amounts. See type for more info. -## Hierarchy +### Hierarchy * **OrderProviderResponse** -## Index ### Properties -* [orders](#orders) - -## Properties - -### orders +## orders • **orders**: *[SignedOrderWithRemainingFillableMakerAssetAmount](#interface-signedorderwithremainingfillablemakerassetamount)[]* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L18)*
-> # Interface: OrdersAndFillableAmounts +# Interface: OrdersAndFillableAmounts orders: An array of signed orders remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order. -## Hierarchy +### Hierarchy * **OrdersAndFillableAmounts** -## Index ### Properties -* [orders](#orders) -* [remainingFillableMakerAssetAmounts](#remainingfillablemakerassetamounts) - -## Properties - -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L132)* +*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L132)* ___ -### remainingFillableMakerAssetAmounts +## remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L133)* +*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L133)*
-> # Interface: SignedOrderWithRemainingFillableMakerAssetAmount +# Interface: SignedOrderWithRemainingFillableMakerAssetAmount A normal SignedOrder with one extra optional property `remainingFillableMakerAssetAmount` remainingFillableMakerAssetAmount: The amount of the makerAsset that is available to be filled -## Hierarchy +### Hierarchy * `SignedOrder` * **SignedOrderWithRemainingFillableMakerAssetAmount** -## Index ### Properties -* [exchangeAddress](#exchangeaddress) -* [expirationTimeSeconds](#expirationtimeseconds) -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetAmount](#makerassetamount) -* [makerAssetData](#makerassetdata) -* [makerFee](#makerfee) -* [remainingFillableMakerAssetAmount](#optional-remainingfillablemakerassetamount) -* [salt](#salt) -* [senderAddress](#senderaddress) -* [signature](#signature) -* [takerAddress](#takeraddress) -* [takerAssetAmount](#takerassetamount) -* [takerAssetData](#takerassetdata) -* [takerFee](#takerfee) - -## Properties - -### exchangeAddress +## exchangeAddress • **exchangeAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:14 + + ___ -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:16 + + ___ -### feeRecipientAddress +## feeRecipientAddress • **feeRecipientAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:15 + + ___ -### makerAddress +## makerAddress • **makerAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:5 + + ___ -### makerAssetAmount +## makerAssetAmount • **makerAssetAmount**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:9 + + ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:11 + + ___ -### makerFee +## makerFee • **makerFee**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:7 + + ___ -### `Optional` remainingFillableMakerAssetAmount +## `Optional` remainingFillableMakerAssetAmount • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-buyer/src/types.ts#L26)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:13 + + ___ -### senderAddress +## senderAddress • **senderAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:4 + + ___ -### signature +## signature • **signature**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:33 + + ___ -### takerAddress +## takerAddress • **takerAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:6 + + ___ -### takerAssetAmount +## takerAssetAmount • **takerAssetAmount**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:10 + + ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:12 + + ___ -### takerFee +## takerFee • **takerFee**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:8 - -
- -* [Globals](globals.md) -* [External Modules]() - * [asset_buyer](modules/_asset_buyer_.md) - * [asset_buyer.AssetBuyer](#class-assetbuyer) - * [constants](modules/_constants_.md) - * [errors](modules/_errors_.md) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [index](modules/_index_.md) - * [order_providers/basic_order_provider](modules/_order_providers_basic_order_provider_.md) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider](modules/_order_providers_standard_relayer_api_order_provider_.md) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [types](modules/_types_.md) - * [types.AssetBuyerError](#class-assetbuyererror) - * [types.AssetBuyerOpts](#class-assetbuyeropts) - * [types.BuyQuote](#class-buyquote) - * [types.BuyQuoteExecutionOpts](#class-buyquoteexecutionopts) - * [types.BuyQuoteInfo](#class-buyquoteinfo) - * [types.BuyQuoteRequestOpts](#class-buyquoterequestopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [utils/assert](modules/_utils_assert_.md) - * [utils/asset_data_utils](modules/_utils_asset_data_utils_.md) - * [utils/buy_quote_calculator](modules/_utils_buy_quote_calculator_.md) - * [utils/calculate_liquidity](modules/_utils_calculate_liquidity_.md) - * [utils/order_provider_response_processor](modules/_utils_order_provider_response_processor_.md) -* [Classes]() - * [asset_buyer.AssetBuyer](#class-assetbuyer) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) -* [Enums]() - * [types.AssetBuyerError](#class-assetbuyererror) -* [Interfaces]() - * [types.AssetBuyerOpts](#class-assetbuyeropts) - * [types.BuyQuote](#class-buyquote) - * [types.BuyQuoteExecutionOpts](#class-buyquoteexecutionopts) - * [types.BuyQuoteInfo](#class-buyquoteinfo) - * [types.BuyQuoteRequestOpts](#class-buyquoterequestopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) + +
diff --git a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/README.md b/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/README.md deleted file mode 100644 index e41ed60627..0000000000 --- a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/README.md +++ /dev/null @@ -1,84 +0,0 @@ -## @0x/asset-swapper - -Convenience package for swapping assets represented on the Ethereum blockchain using 0x. The package helps to perform all the off-chain computations to execute a marketBuy or marketSell function execution with 0x exchange contracts, or 0x extension contracts. Given some liquidity (0x signed orders), it helps estimate the cost of buying or selling a certain asset (giving a range) and then provide varying consumable outputs to execute the buy or sell. - -Asset-swapper integrates with the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)(in the future Mesh as well) and takes care of sourcing liquidity, order-pruning, and order-validation. The final result is a library that tells you what assets are available, provides a quote based on specified assets, and provide varying consumable metadata that can be used both on-chain in smart contracts or off-chain through web3 to swap a desired amount of ERC20 for another ERC20 asset. - -## Installation - -```bash -yarn add @0x/asset-swapper -``` - -**Import** - -```typescript -import { SwapQuoter } from '@0x/asset-swapper'; -``` - -or - -```javascript -var SwapQuoter = require('@0x/asset-swapper').SwapQuoter; -var SwapQuoteConsumer = require('@0x/asset-swapper').SwapQuoteConsumer; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/asset-swapper yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/asset-swapper yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/reference.mdx b/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/reference.mdx deleted file mode 100644 index d34f78e4be..0000000000 --- a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.0/reference.mdx +++ /dev/null @@ -1,3385 +0,0 @@ -> # Class: InsufficientAssetLiquidityError - -Error class representing insufficient asset liquidity - -## Hierarchy - -* `Error` - - * **InsufficientAssetLiquidityError** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [amountAvailableToFill](#amountavailabletofill) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor - -\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* - -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/errors.ts#L12)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`amountAvailableToFill` | `BigNumber` | The amount availabe to fill (in base units) factoring in slippage | - -**Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* - -## Properties - -### amountAvailableToFill - -• **amountAvailableToFill**: *`BigNumber`* - -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/errors.ts#L12)* - -The amount availabe to fill (in base units) factoring in slippage. - -___ - -### message - -• **message**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### `Static` Error - -▪ **Error**: *`ErrorConstructor`* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 - -
- -> # Class: BasicOrderProvider - -## Hierarchy - -* **BasicOrderProvider** - -## Implements - -* [OrderProvider](#interface-orderprovider) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [orders](#orders) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor - -\+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)* - -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* - -Instantiates a new BasicOrderProvider instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects that conform to SignedOrder to fetch from. | - -**Returns:** *[BasicOrderProvider](#class-basicorderprovider)* - -An instance of BasicOrderProvider - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* - -## Methods - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L37)* - -Given a taker asset data string, return all availabled paired maker asset data strings. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`takerAssetData` | string | A string representing the taker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be purchased using takerAssetData. - -___ - -### getAvailableTakerAssetDatasAsync - -▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* - -*Defined in [order_providers/basic_order_provider.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L46)* - -Given a maker asset data string, return all availabled paired taker asset data strings. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`makerAssetData` | string | A string representing the maker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be used to purchased makerAssetData. - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L24)* - -Given an object that conforms to OrderFetcherRequest, return the corresponding OrderProviderResponse that satisfies the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | An instance of OrderFetcherRequest. See type for more information. | - -**Returns:** *`Promise`* - -An instance of OrderProviderResponse. See type for more information. - -
- -> # Class: StandardRelayerAPIOrderProvider - -## Hierarchy - -* **StandardRelayerAPIOrderProvider** - -## Implements - -* [OrderProvider](#interface-orderprovider) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [apiUrl](#apiurl) -* [networkId](#networkid) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor - -\+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L49)* - -Instantiates a new StandardRelayerAPIOrderProvider instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`apiUrl` | string | The standard relayer API base HTTP url you would like to source orders from. | -`networkId` | number | The ethereum network id. | - -**Returns:** *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* - -An instance of StandardRelayerAPIOrderProvider - -## Properties - -### apiUrl - -• **apiUrl**: *string* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L18)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L19)* - -## Methods - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L92)* - -Given a taker asset data string, return all available paired maker asset data strings. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`takerAssetData` | string | A string representing the taker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be purchased using takerAssetData. - -___ - -### getAvailableTakerAssetDatasAsync - -▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L120)* - -Given a maker asset data string, return all availabled paired taker asset data strings. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`makerAssetData` | string | A string representing the maker asset data. | - -**Returns:** *`Promise`* - -An array of asset data strings that can be used to purchased makerAssetData. - -___ - -### getOrdersAsync - -▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -*Defined in [order_providers/standard_relayer_api_order_provider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L68)* - -Given an object that conforms to OrderProviderRequest, return the corresponding OrderProviderResponse that satisfies the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | An instance of OrderProviderRequest. See type for more information. | - -**Returns:** *`Promise`* - -An instance of OrderProviderResponse. See type for more information. - -
- -> # Class: ExchangeSwapQuoteConsumer - -## Hierarchy - -* **ExchangeSwapQuoteConsumer** - -## Implements - -* [SwapQuoteConsumerBase](#exchangesmartcontractparams)*› - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor - -\+ **new ExchangeSwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer)* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L28)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`supportedProvider` | `SupportedProvider` | - | -`options` | `Partial` | {} | - -**Returns:** *[ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer)* - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L26)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L25)* - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L121)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getCalldataOrThrowAsync - -▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L42)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `_opts`: `Partial`): *`Promise>`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L70)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`_opts` | `Partial` | - -**Returns:** *`Promise>`* - -
- -> # Class: ForwarderSwapQuoteConsumer - -## Hierarchy - -* **ForwarderSwapQuoteConsumer** - -## Implements - -* [SwapQuoteConsumerBase](#forwardersmartcontractparams)*› - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor - -\+ **new ForwarderSwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer)* - -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L31)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`supportedProvider` | `SupportedProvider` | - | -`options` | `Partial` | {} | - -**Returns:** *[ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer)* - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L29)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L28)* - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:163](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L163)* - -Given a SwapQuote and desired rate (in Eth), attempt to execute the swap. - -**Parameters:** - -Name | Type | 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 [quote_consumers/forwarder_swap_quote_consumer.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L50)* - -Given a SwapQuote, returns 'CalldataInfo' for a forwarder extension call. See type definition of CalldataInfo for more information. - -**Parameters:** - -Name | Type | 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`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L82)* - -Given a SwapQuote, returns 'SmartContractParamsInfo' for a forwarder extension call. See type definition of CalldataInfo for more information. - -**Parameters:** - -Name | Type | 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: SwapQuoteConsumer - -## Hierarchy - -* **SwapQuoteConsumer** - -## Implements - -* [SwapQuoteConsumerBase](#smartcontractparams)*› - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor - -\+ **new SwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[SwapQuoteConsumer](#class-swapquoteconsumer)* - -*Defined in [quote_consumers/swap_quote_consumer.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L30)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`supportedProvider` | `SupportedProvider` | - | -`options` | `Partial` | {} | - -**Returns:** *[SwapQuoteConsumer](#class-swapquoteconsumer)* - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [quote_consumers/swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L25)* - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/swap_quote_consumer.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L80)* - -Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. - -**Parameters:** - -Name | Type | 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 [quote_consumers/swap_quote_consumer.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L52)* - -Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information. - -**Parameters:** - -Name | Type | 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`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* - -*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* - -*Defined in [quote_consumers/swap_quote_consumer.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L66)* - -Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information. - -**Parameters:** - -Name | Type | 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 - -## Hierarchy - -* **SwapQuoter** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [expiryBufferMs](#expirybufferms) -* [networkId](#networkid) -* [orderProvider](#orderprovider) -* [orderRefreshIntervalMs](#orderrefreshintervalms) -* [provider](#provider) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getLiquidityForMakerTakerAssetDataPairAsync](#getliquidityformakertakerassetdatapairasync) -* [getMarketBuySwapQuoteAsync](#getmarketbuyswapquoteasync) -* [getMarketBuySwapQuoteForAssetDataAsync](#getmarketbuyswapquoteforassetdataasync) -* [getMarketSellSwapQuoteAsync](#getmarketsellswapquoteasync) -* [getMarketSellSwapQuoteForAssetDataAsync](#getmarketsellswapquoteforassetdataasync) -* [getOrdersAndFillableAmountsAsync](#getordersandfillableamountsasync) -* [isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync](#istakeraddressallowanceenoughforbestandworstquoteinfoasync) -* [isTakerMakerAssetDataPairAvailableAsync](#istakermakerassetdatapairavailableasync) -* [getSwapQuoterForProvidedOrders](#static-getswapquoterforprovidedorders) -* [getSwapQuoterForStandardRelayerAPIUrl](#static-getswapquoterforstandardrelayerapiurl) - -## Constructors - -### constructor - -\+ **new SwapQuoter**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-swapquoter)* - -*Defined in [swap_quoter.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L93)* - -Instantiates a new SwapQuoter instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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 SwapQuoter. See type definition for details. | - -**Returns:** *[SwapQuoter](#class-swapquoter)* - -An instance of SwapQuoter - -## Properties - -### expiryBufferMs - -• **expiryBufferMs**: *number* - -*Defined in [swap_quoter.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L41)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [swap_quoter.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L39)* - -___ - -### orderProvider - -• **orderProvider**: *[OrderProvider](#interface-orderprovider)* - -*Defined in [swap_quoter.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L38)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L40)* - -___ - -### provider - -• **provider**: *`ZeroExProvider`* - -*Defined in [swap_quoter.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L37)* - -## Methods - -### getAvailableMakerAssetDatasAsync - -▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* - -*Defined in [swap_quoter.ts:291](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L291)* - -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 [swap_quoter.ts:280](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L280)* - -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, `options`: `Partial`): *`Promise`* - -*Defined in [swap_quoter.ts:246](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L246)* - -Returns information about available liquidity for an asset -Does not factor in slippage or fees - -**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). | -`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. - -___ - -### getMarketBuySwapQuoteAsync - -▸ **getMarketBuySwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* - -*Defined in [swap_quoter.ts:187](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L187)* - -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 [swap_quoter.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L162)* - -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 [swap_quoter.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L217)* - -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 [swap_quoter.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L136)* - -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, `shouldForceOrderRefresh`: boolean): *`Promise`* - -*Defined in [swap_quoter.ts:320](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L320)* - -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). | -`shouldForceOrderRefresh` | boolean | If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. | - -**Returns:** *`Promise`* - -___ - -### isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync - -▸ **isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync**(`swapQuote`: [SwapQuote](#swapquote), `takerAddress`: string): *`Promise<[boolean, boolean]>`* - -*Defined in [swap_quoter.ts:381](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L381)* - -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 [swap_quoter.ts:302](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L302)* - -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` getSwapQuoterForProvidedOrders - -▸ **getSwapQuoterForProvidedOrders**(`supportedProvider`: `SupportedProvider`, `orders`: `SignedOrder`[], `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* - -*Defined in [swap_quoter.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L54)* - -Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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`, `sraApiUrl`: string, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* - -*Defined in [swap_quoter.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L74)* - -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` | - | 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 - -
- -> # Enumeration: ConsumerType - -Represents the varying smart contracts that can consume a valid swap quote - -## Index - -### Enumeration members - -* [Exchange](#exchange) -* [Forwarder](#forwarder) - -## Enumeration members - -### Exchange - -• **Exchange**: - -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L102)* - -___ - -### Forwarder - -• **Forwarder**: - -*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L101)* - -
- -> # Enumeration: SwapQuoteConsumerError - -Possible error messages thrown by an SwapQuoterConsumer instance or associated static methods. - -## Index - -### Enumeration members - -* [InvalidForwarderSwapQuote](#invalidforwarderswapquote) -* [InvalidMarketSellOrMarketBuySwapQuote](#invalidmarketsellormarketbuyswapquote) -* [NoAddressAvailable](#noaddressavailable) -* [SignatureRequestDenied](#signaturerequestdenied) -* [TransactionValueTooLow](#transactionvaluetoolow) - -## Enumeration members - -### InvalidForwarderSwapQuote - -• **InvalidForwarderSwapQuote**: = "INVALID_FORWARDER_SWAP_QUOTE_PROVIDED" - -*Defined in [types.ts:304](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L304)* - -___ - -### InvalidMarketSellOrMarketBuySwapQuote - -• **InvalidMarketSellOrMarketBuySwapQuote**: = "INVALID_MARKET_BUY_SELL_SWAP_QUOTE" - -*Defined in [types.ts:303](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L303)* - -___ - -### NoAddressAvailable - -• **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" - -*Defined in [types.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L305)* - -___ - -### SignatureRequestDenied - -• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" - -*Defined in [types.ts:306](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L306)* - -___ - -### TransactionValueTooLow - -• **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" - -*Defined in [types.ts:307](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L307)* - -
- -> # Enumeration: SwapQuoterError - -Possible error messages thrown by an SwapQuoter instance or associated static methods. - -## Index - -### Enumeration members - -* [AssetUnavailable](#assetunavailable) -* [InsufficientAssetLiquidity](#insufficientassetliquidity) -* [InsufficientZrxLiquidity](#insufficientzrxliquidity) -* [InvalidOrderProviderResponse](#invalidorderproviderresponse) -* [NoEtherTokenContractFound](#noethertokencontractfound) -* [NoZrxTokenContractFound](#nozrxtokencontractfound) -* [StandardRelayerApiError](#standardrelayerapierror) - -## Enumeration members - -### AssetUnavailable - -• **AssetUnavailable**: = "ASSET_UNAVAILABLE" - -*Defined in [types.ts:320](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L320)* - -___ - -### InsufficientAssetLiquidity - -• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" - -*Defined in [types.ts:317](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L317)* - -___ - -### InsufficientZrxLiquidity - -• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" - -*Defined in [types.ts:318](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L318)* - -___ - -### InvalidOrderProviderResponse - -• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" - -*Defined in [types.ts:319](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L319)* - -___ - -### NoEtherTokenContractFound - -• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" - -*Defined in [types.ts:314](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L314)* - -___ - -### NoZrxTokenContractFound - -• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" - -*Defined in [types.ts:315](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L315)* - -___ - -### StandardRelayerApiError - -• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" - -*Defined in [types.ts:316](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L316)* - -
- -> # 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. - -## Hierarchy - -* **CalldataInfo** - -## Index - -### Properties - -* [calldataHexString](#calldatahexstring) -* [ethAmount](#optional-ethamount) -* [methodAbi](#methodabi) -* [toAddress](#toaddress) - -## Properties - -### calldataHexString - -• **calldataHexString**: *string* - -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L50)* - -___ - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L53)* - -___ - -### methodAbi - -• **methodAbi**: *`MethodAbi`* - -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L51)* - -___ - -### toAddress - -• **toAddress**: *string* - -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L52)* - -
- -> # Interface: ExchangeMarketBuySmartContractParams - -makerAssetFillAmount: The amount of makerAsset to swap for. -type: String specifiying which market operation will be performed with the provided parameters. (In this case a market buy operation) - -## Hierarchy - -* [SmartContractParamsBase](#interface-smartcontractparamsbase) - - * **ExchangeMarketBuySmartContractParams** - - * [ForwarderMarketBuySmartContractParams](#interface-forwardermarketbuysmartcontractparams) - -## Index - -### Properties - -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [signatures](#signatures) -* [type](#type) - -## Properties - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L84)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SmartContractParamsBase](#orders)* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Inherited from [SmartContractParamsBase](#signatures)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* - -___ - -### type - -• **type**: *`Buy`* - -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L85)* - -
- -> # Interface: ExchangeMarketSellSmartContractParams - -takerAssetFillAmount: The amount of takerAsset swapped for makerAsset. -type: String specifiying which market operation will be performed with the provided parameters. (In this case a market sell operation) - -## Hierarchy - -* [SmartContractParamsBase](#interface-smartcontractparamsbase) - - * **ExchangeMarketSellSmartContractParams** - -## Index - -### Properties - -* [orders](#orders) -* [signatures](#signatures) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SmartContractParamsBase](#orders)* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Inherited from [SmartContractParamsBase](#signatures)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L93)* - -___ - -### type - -• **type**: *`Sell`* - -*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L94)* - -
- -> # Interface: ForwarderMarketBuySmartContractParams - -## Hierarchy - - * [ExchangeMarketBuySmartContractParams](#interface-exchangemarketbuysmartcontractparams) - -* [ForwarderSmartContractParamsBase](#interface-forwardersmartcontractparamsbase) - - * **ForwarderMarketBuySmartContractParams** - -## Index - -### Properties - -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [signatures](#signatures) -* [type](#type) - -## Properties - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [ForwarderSmartContractParamsBase](#feeorders)* - -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* - -___ - -### feePercentage - -• **feePercentage**: *`BigNumber`* - -*Inherited from [ForwarderSmartContractParamsBase](#feepercentage)* - -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSmartContractParamsBase](#feerecipient)* - -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* - -___ - -### feeSignatures - -• **feeSignatures**: *string[]* - -*Inherited from [ForwarderSmartContractParamsBase](#feesignatures)* - -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* - -___ - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Inherited from [ExchangeMarketBuySmartContractParams](#makerassetfillamount)* - -*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L84)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SmartContractParamsBase](#orders)* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Inherited from [SmartContractParamsBase](#signatures)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* - -___ - -### type - -• **type**: *`Buy`* - -*Inherited from [ExchangeMarketBuySmartContractParams](#type)* - -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L85)* - -
- -> # Interface: ForwarderMarketSellSmartContractParams - -## Hierarchy - -* object - -* [ForwarderSmartContractParamsBase](#interface-forwardersmartcontractparamsbase) - - * **ForwarderMarketSellSmartContractParams** - -## Index - -### Properties - -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) - -## Properties - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [ForwarderSmartContractParamsBase](#feeorders)* - -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* - -___ - -### feePercentage - -• **feePercentage**: *`BigNumber`* - -*Inherited from [ForwarderSmartContractParamsBase](#feepercentage)* - -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSmartContractParamsBase](#feerecipient)* - -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* - -___ - -### feeSignatures - -• **feeSignatures**: *string[]* - -*Inherited from [ForwarderSmartContractParamsBase](#feesignatures)* - -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* - -
- -> # Interface: ForwarderSmartContractParamsBase - -feeOrders: An array of objects conforming to SignedOrder. These orders can be used to cover the fees for the orders param above. -feeSignatures: An array of signatures that attest that the maker of the orders in fact made the orders. -feePercentage: Optional affiliate fee percentage used to calculate the eth amount paid to fee recipient. -feeRecipient: The address where affiliate fees are sent. Defaults to null address (0x000...000). - -## Hierarchy - -* **ForwarderSmartContractParamsBase** - - * [ForwarderMarketBuySmartContractParams](#interface-forwardermarketbuysmartcontractparams) - - * [ForwarderMarketSellSmartContractParams](#interface-forwardermarketsellsmartcontractparams) - -## Index - -### Properties - -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) - -## Properties - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* - -___ - -### feePercentage - -• **feePercentage**: *`BigNumber`* - -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* - -___ - -### feeSignatures - -• **feeSignatures**: *string[]* - -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* - -
- -> # Interface: ForwarderSwapQuoteExecutionOpts - -## Hierarchy - - * [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts) - - * [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase) - - * **ForwarderSwapQuoteExecutionOpts** - - * [SwapQuoteExecutionOpts](#interface-swapquoteexecutionopts) - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* - -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* - -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* - -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* - -___ - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [SwapQuoteExecutionOptsBase](#optional-gaslimit)* - -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [SwapQuoteExecutionOptsBase](#optional-gasprice)* - -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Inherited from [SwapQuoteExecutionOptsBase](#optional-takeraddress)* - -*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L179)* - -
- -> # 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. - -## Hierarchy - -* [SwapQuoteGetOutputOptsBase](#interface-swapquotegetoutputoptsbase) - - * **ForwarderSwapQuoteGetOutputOpts** - - * [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts) - - * [ForwarderSwapQuoteExecutionOpts](#interface-forwarderswapquoteexecutionopts) - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* - -
- -> # Interface: LiquidityForAssetData - -Represents available liquidity for a given assetData - -## Hierarchy - -* **LiquidityForAssetData** - -## Index - -### Properties - -* [makerTokensAvailableInBaseUnits](#makertokensavailableinbaseunits) -* [takerTokensAvailableInBaseUnits](#takertokensavailableinbaseunits) - -## Properties - -### makerTokensAvailableInBaseUnits - -• **makerTokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [types.ts:336](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L336)* - -___ - -### takerTokensAvailableInBaseUnits - -• **takerTokensAvailableInBaseUnits**: *`BigNumber`* - -*Defined in [types.ts:337](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L337)* - -
- -> # Interface: MarketBuySwapQuote - -makerAssetFillAmount: The amount of makerAsset bought with takerAsset. -type: Specified MarketOperation the SwapQuote is provided for - -## Hierarchy - -* [SwapQuoteBase](#interface-swapquotebase) - - * **MarketBuySwapQuote** - - * [MarketBuySwapQuoteWithAffiliateFee](#interface-marketbuyswapquotewithaffiliatefee) - -## Index - -### Properties - -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#bestcasequoteinfo)* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#feeorders)* - -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#makerassetdata)* - -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* - -___ - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L244)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#orders)* - -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#takerassetdata)* - -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* - -___ - -### type - -• **type**: *`Buy`* - -*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L245)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#worstcasequoteinfo)* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* - -
- -> # Interface: MarketBuySwapQuoteWithAffiliateFee - -## Hierarchy - -* [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase) - - * [MarketBuySwapQuote](#interface-marketbuyswapquote) - - * **MarketBuySwapQuoteWithAffiliateFee** - -## Index - -### Properties - -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [makerAssetData](#makerassetdata) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#bestcasequoteinfo)* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#feeorders)* - -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [SwapQuoteWithAffiliateFeeBase](#feepercentage)* - -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#makerassetdata)* - -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* - -___ - -### makerAssetFillAmount - -• **makerAssetFillAmount**: *`BigNumber`* - -*Inherited from [MarketBuySwapQuote](#makerassetfillamount)* - -*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L244)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#orders)* - -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#takerassetdata)* - -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* - -___ - -### type - -• **type**: *`Buy`* - -*Inherited from [MarketBuySwapQuote](#type)* - -*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L245)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#worstcasequoteinfo)* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* - -
- -> # Interface: MarketSellSwapQuote - -takerAssetFillAmount: The amount of takerAsset sold for makerAsset. -type: Specified MarketOperation the SwapQuote is provided for - -## Hierarchy - -* [SwapQuoteBase](#interface-swapquotebase) - - * **MarketSellSwapQuote** - - * [MarketSellSwapQuoteWithAffiliateFee](#interface-marketsellswapquotewithaffiliatefee) - -## Index - -### Properties - -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#bestcasequoteinfo)* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#feeorders)* - -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#makerassetdata)* - -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#orders)* - -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#takerassetdata)* - -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L235)* - -___ - -### type - -• **type**: *`Sell`* - -*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L236)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#worstcasequoteinfo)* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* - -
- -> # Interface: MarketSellSwapQuoteWithAffiliateFee - -## Hierarchy - -* [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase) - - * [MarketSellSwapQuote](#interface-marketsellswapquote) - - * **MarketSellSwapQuoteWithAffiliateFee** - -## Index - -### Properties - -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#bestcasequoteinfo)* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#feeorders)* - -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [SwapQuoteWithAffiliateFeeBase](#feepercentage)* - -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#makerassetdata)* - -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Inherited from [SwapQuoteBase](#orders)* - -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from [SwapQuoteBase](#takerassetdata)* - -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Inherited from [MarketSellSwapQuote](#takerassetfillamount)* - -*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L235)* - -___ - -### type - -• **type**: *`Sell`* - -*Inherited from [MarketSellSwapQuote](#type)* - -*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L236)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Inherited from [SwapQuoteBase](#worstcasequoteinfo)* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* - -
- -> # Interface: OrderProvider - -gerOrdersAsync: Given an OrderProviderRequest, get an OrderProviderResponse. -getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all availabled paired maker asset data strings. -getAvailableTakerAssetDatasAsync: Given a maker asset data string, return all availabled paired taker asset data strings. - -## Hierarchy - -* **OrderProvider** - -## Implemented by - -* [BasicOrderProvider](#class-basicorderprovider) -* [StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - -## Index - -### Properties - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Properties - -### getAvailableMakerAssetDatasAsync - -• **getAvailableMakerAssetDatasAsync**: *function* - -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L38)* - -#### Type declaration: - -▸ (`takerAssetData`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`takerAssetData` | string | - -___ - -### getAvailableTakerAssetDatasAsync - -• **getAvailableTakerAssetDatasAsync**: *function* - -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L39)* - -#### Type declaration: - -▸ (`makerAssetData`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`makerAssetData` | string | - -___ - -### getOrdersAsync - -• **getOrdersAsync**: *function* - -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L37)* - -#### Type declaration: - -▸ (`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderProviderRequest` | [OrderProviderRequest](#interface-orderproviderrequest) | - -
- -> # Interface: OrderProviderRequest - -makerAssetData: The assetData representing the desired makerAsset. -takerAssetData: The assetData representing the desired takerAsset. -networkId: The networkId that the desired orders should be for. - -## Hierarchy - -* **OrderProviderRequest** - -## Index - -### Properties - -* [makerAssetData](#makerassetdata) -* [networkId](#networkid) -* [takerAssetData](#takerassetdata) - -## Properties - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L11)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L13)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L12)* - -
- -> # Interface: OrderProviderResponse - -orders: An array of orders with optional remaining fillable makerAsset amounts. See type for more info. - -## Hierarchy - -* **OrderProviderResponse** - -## Index - -### Properties - -* [orders](#orders) - -## Properties - -### orders - -• **orders**: *[SignedOrderWithRemainingFillableMakerAssetAmount](#interface-signedorderwithremainingfillablemakerassetamount)[]* - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L20)* - -
- -> # Interface: OrdersAndFillableAmounts - -orders: An array of signed orders -remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order. - -## Hierarchy - -* **OrdersAndFillableAmounts** - -## Index - -### Properties - -* [orders](#orders) -* [remainingFillableMakerAssetAmounts](#remainingfillablemakerassetamounts) - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [types.ts:328](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L328)* - -___ - -### remainingFillableMakerAssetAmounts - -• **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* - -*Defined in [types.ts:329](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L329)* - -
- -> # Interface: SignedOrderWithRemainingFillableMakerAssetAmount - -A normal SignedOrder with one extra optional property `remainingFillableMakerAssetAmount` -remainingFillableMakerAssetAmount: The amount of the makerAsset that is available to be filled - -## Hierarchy - -* `SignedOrder` - - * **SignedOrderWithRemainingFillableMakerAssetAmount** - -## Index - -### Properties - -* [exchangeAddress](#exchangeaddress) -* [expirationTimeSeconds](#expirationtimeseconds) -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetAmount](#makerassetamount) -* [makerAssetData](#makerassetdata) -* [makerFee](#makerfee) -* [remainingFillableMakerAssetAmount](#optional-remainingfillablemakerassetamount) -* [salt](#salt) -* [senderAddress](#senderaddress) -* [signature](#signature) -* [takerAddress](#takeraddress) -* [takerAssetAmount](#takerassetamount) -* [takerAssetData](#takerassetdata) -* [takerFee](#takerfee) - -## Properties - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:14 - -___ - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:16 - -___ - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:15 - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:5 - -___ - -### makerAssetAmount - -• **makerAssetAmount**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:9 - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:11 - -___ - -### makerFee - -• **makerFee**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:7 - -___ - -### `Optional` remainingFillableMakerAssetAmount - -• **remainingFillableMakerAssetAmount**? : *`BigNumber`* - -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L28)* - -___ - -### salt - -• **salt**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:13 - -___ - -### senderAddress - -• **senderAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:4 - -___ - -### signature - -• **signature**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:33 - -___ - -### takerAddress - -• **takerAddress**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:6 - -___ - -### takerAssetAmount - -• **takerAssetAmount**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:10 - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:12 - -___ - -### takerFee - -• **takerFee**: *`BigNumber`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:8 - -
- -> # Interface: SmartContractParamsBase - -orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested assetBuyAmount plus slippage. -signatures: An array of signatures that attest that the maker of the orders in fact made the orders. - -## Hierarchy - -* **SmartContractParamsBase** - - * [ExchangeMarketBuySmartContractParams](#interface-exchangemarketbuysmartcontractparams) - - * [ExchangeMarketSellSmartContractParams](#interface-exchangemarketsellsmartcontractparams) - -## Index - -### Properties - -* [orders](#orders) -* [signatures](#signatures) - -## Properties - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* - -
- -> # 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** - -## Hierarchy - -* **SmartContractParamsInfo** - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [methodAbi](#methodabi) -* [params](#params) -* [toAddress](#toaddress) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L66)* - -___ - -### methodAbi - -• **methodAbi**: *`MethodAbi`* - -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L67)* - -___ - -### params - -• **params**: *`T`* - -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L64)* - -___ - -### toAddress - -• **toAddress**: *string* - -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L65)* - -
- -> # Interface: SwapQuoteBase - -takerAssetData: String that represents a specific taker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). -makerAssetData: String that represents a specific maker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). -orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested assetBuyAmount plus slippage. -feeOrders: An array of objects conforming to SignedOrder. These orders can be used to cover the fees for the orders param above. -bestCaseQuoteInfo: Info about the best case price for the asset. -worstCaseQuoteInfo: Info about the worst case price for the asset. - -## Hierarchy - -* **SwapQuoteBase** - - * [MarketSellSwapQuote](#interface-marketsellswapquote) - - * [MarketBuySwapQuote](#interface-marketbuyswapquote) - -## Index - -### Properties - -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo - -• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* - -___ - -### feeOrders - -• **feeOrders**: *`SignedOrder`[]* - -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* - -___ - -### orders - -• **orders**: *`SignedOrder`[]* - -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* - -___ - -### takerAssetData - -• **takerAssetData**: *string* - -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* - -___ - -### worstCaseQuoteInfo - -• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* - -
- -> # 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** - -## Hierarchy - -* **SwapQuoteConsumerBase** - -## Implemented by - -* [ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) -* [ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) -* [SwapQuoteConsumer](#class-swapquoteconsumer) - -## Index - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Methods - -### executeSwapQuoteOrThrowAsync - -▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L158)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getCalldataOrThrowAsync - -▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* - -*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L153)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getSmartContractParamsOrThrowAsync - -▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* - -*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L154)* - -**Parameters:** - -Name | Type | ------- | ------ | -`quote` | [SwapQuote](#swapquote) | -`opts` | `Partial` | - -**Returns:** *`Promise>`* - -
- -> # Interface: SwapQuoteConsumerOpts - -networkId: The networkId that the desired orders should be for. - -## Hierarchy - -* **SwapQuoteConsumerOpts** - -## Index - -### Properties - -* [networkId](#networkid) - -## Properties - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L165)* - -
- -> # Interface: SwapQuoteExecutionOpts - -Represents the options for executing a swap quote with SwapQuoteConsumer - -## Hierarchy - - * [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts) - - * [ForwarderSwapQuoteExecutionOpts](#interface-forwarderswapquoteexecutionopts) - - * **SwapQuoteExecutionOpts** - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) -* [useConsumerType](#optional-useconsumertype) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* - -*Overrides [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* - -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* - -*Overrides [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* - -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* - -*Overrides [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* - -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* - -___ - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [SwapQuoteExecutionOptsBase](#optional-gaslimit)* - -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [SwapQuoteExecutionOptsBase](#optional-gasprice)* - -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Inherited from [SwapQuoteGetOutputOpts](#optional-takeraddress)* - -*Overrides [SwapQuoteExecutionOptsBase](#optional-takeraddress)* - -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L202)* - -___ - -### `Optional` useConsumerType - -• **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)* - -*Inherited from [SwapQuoteGetOutputOpts](#optional-useconsumertype)* - -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L203)* - -
- -> # 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 - -## Hierarchy - -* [SwapQuoteGetOutputOptsBase](#interface-swapquotegetoutputoptsbase) - - * **SwapQuoteExecutionOptsBase** - - * [ForwarderSwapQuoteExecutionOpts](#interface-forwarderswapquoteexecutionopts) - -## Index - -### Properties - -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L179)* - -
- -> # 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. - -## Hierarchy - - * [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts) - - * **SwapQuoteGetOutputOpts** - - * [SwapQuoteExecutionOpts](#interface-swapquoteexecutionopts) - -## Index - -### Properties - -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [takerAddress](#optional-takeraddress) -* [useConsumerType](#optional-useconsumertype) - -## Properties - -### `Optional` ethAmount - -• **ethAmount**? : *`BigNumber`* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* - -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* - -___ - -### feePercentage - -• **feePercentage**: *number* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* - -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* - -___ - -### feeRecipient - -• **feeRecipient**: *string* - -*Inherited from [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* - -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L202)* - -___ - -### `Optional` useConsumerType - -• **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)* - -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L203)* - -
- -> # Interface: SwapQuoteGetOutputOptsBase - -Represents the options provided to a generic SwapQuoteConsumer - -## Hierarchy - -* **SwapQuoteGetOutputOptsBase** - - * [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase) - - * [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts) - -
- -> # Interface: SwapQuoteInfo - -feeTakerTokenAmount: The amount of takerToken required any fee concerned with completing the swap. -takerTokenAmount: The amount of takerToken required to conduct the swap. -totalTakerTokenAmount: The total amount of takerToken required to complete the swap (filling orders, feeOrders, and paying affiliate fee) -makerTokenAmount: The amount of makerToken that will be acquired through the swap. - -## Hierarchy - -* **SwapQuoteInfo** - -## Index - -### Properties - -* [feeTakerTokenAmount](#feetakertokenamount) -* [makerTokenAmount](#makertokenamount) -* [takerTokenAmount](#takertokenamount) -* [totalTakerTokenAmount](#totaltakertokenamount) - -## Properties - -### feeTakerTokenAmount - -• **feeTakerTokenAmount**: *`BigNumber`* - -*Defined in [types.ts:265](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L265)* - -___ - -### makerTokenAmount - -• **makerTokenAmount**: *`BigNumber`* - -*Defined in [types.ts:268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L268)* - -___ - -### takerTokenAmount - -• **takerTokenAmount**: *`BigNumber`* - -*Defined in [types.ts:267](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L267)* - -___ - -### totalTakerTokenAmount - -• **totalTakerTokenAmount**: *`BigNumber`* - -*Defined in [types.ts:266](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L266)* - -
- -> # Interface: SwapQuoteRequestOpts - -shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false. -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%). - -## Hierarchy - -* **SwapQuoteRequestOpts** - -## Index - -### Properties - -* [shouldDisableRequestingFeeOrders](#shoulddisablerequestingfeeorders) -* [shouldForceOrderRefresh](#shouldforceorderrefresh) -* [slippagePercentage](#slippagepercentage) - -## Properties - -### shouldDisableRequestingFeeOrders - -• **shouldDisableRequestingFeeOrders**: *boolean* - -*Defined in [types.ts:278](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L278)* - -___ - -### shouldForceOrderRefresh - -• **shouldForceOrderRefresh**: *boolean* - -*Defined in [types.ts:277](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L277)* - -___ - -### slippagePercentage - -• **slippagePercentage**: *number* - -*Defined in [types.ts:279](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L279)* - -
- -> # 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). - -## Hierarchy - -* **SwapQuoterOpts** - -## Index - -### Properties - -* [expiryBufferMs](#expirybufferms) -* [networkId](#networkid) -* [orderRefreshIntervalMs](#orderrefreshintervalms) - -## Properties - -### expiryBufferMs - -• **expiryBufferMs**: *number* - -*Defined in [types.ts:296](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L296)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:294](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L294)* - -___ - -### orderRefreshIntervalMs - -• **orderRefreshIntervalMs**: *number* - -*Defined in [types.ts:295](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L295)* - -
- -> # Interface: SwapQuoteWithAffiliateFeeBase - -## Hierarchy - -* **SwapQuoteWithAffiliateFeeBase** - - * [MarketSellSwapQuoteWithAffiliateFee](#interface-marketsellswapquotewithaffiliatefee) - - * [MarketBuySwapQuoteWithAffiliateFee](#interface-marketbuyswapquotewithaffiliatefee) - -## Index - -### Properties - -* [feePercentage](#feepercentage) - -## Properties - -### feePercentage - -• **feePercentage**: *number* - -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [constants](modules/_constants_.md) - * [errors](modules/_errors_.md) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [index](modules/_index_.md) - * [order_providers/basic_order_provider](modules/_order_providers_basic_order_provider_.md) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider](modules/_order_providers_standard_relayer_api_order_provider_.md) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [quote_consumers/exchange_swap_quote_consumer](modules/_quote_consumers_exchange_swap_quote_consumer_.md) - * [quote_consumers/exchange_swap_quote_consumer.ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) - * [quote_consumers/forwarder_swap_quote_consumer](modules/_quote_consumers_forwarder_swap_quote_consumer_.md) - * [quote_consumers/forwarder_swap_quote_consumer.ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) - * [quote_consumers/swap_quote_consumer](modules/_quote_consumers_swap_quote_consumer_.md) - * [quote_consumers/swap_quote_consumer.SwapQuoteConsumer](#class-swapquoteconsumer) - * [swap_quoter](modules/_swap_quoter_.md) - * [swap_quoter.SwapQuoter](#class-swapquoter) - * [types](modules/_types_.md) - * [types.ConsumerType](#class-consumertype) - * [types.SwapQuoteConsumerError](#class-swapquoteconsumererror) - * [types.SwapQuoterError](#class-swapquotererror) - * [types.CalldataInfo](#class-calldatainfo) - * [types.ExchangeMarketBuySmartContractParams](#class-exchangemarketbuysmartcontractparams) - * [types.ExchangeMarketSellSmartContractParams](#class-exchangemarketsellsmartcontractparams) - * [types.ForwarderMarketBuySmartContractParams](#class-forwardermarketbuysmartcontractparams) - * [types.ForwarderMarketSellSmartContractParams](#class-forwardermarketsellsmartcontractparams) - * [types.ForwarderSmartContractParamsBase](#class-forwardersmartcontractparamsbase) - * [types.ForwarderSwapQuoteExecutionOpts](#class-forwarderswapquoteexecutionopts) - * [types.ForwarderSwapQuoteGetOutputOpts](#class-forwarderswapquotegetoutputopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.MarketBuySwapQuote](#class-marketbuyswapquote) - * [types.MarketBuySwapQuoteWithAffiliateFee](#class-marketbuyswapquotewithaffiliatefee) - * [types.MarketSellSwapQuote](#class-marketsellswapquote) - * [types.MarketSellSwapQuoteWithAffiliateFee](#class-marketsellswapquotewithaffiliatefee) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [types.SmartContractParamsBase](#class-smartcontractparamsbase) - * [types.SmartContractParamsInfo](#class-smartcontractparamsinfo) - * [types.SwapQuoteBase](#class-swapquotebase) - * [types.SwapQuoteConsumerBase](#class-swapquoteconsumerbase) - * [types.SwapQuoteConsumerOpts](#class-swapquoteconsumeropts) - * [types.SwapQuoteExecutionOpts](#class-swapquoteexecutionopts) - * [types.SwapQuoteExecutionOptsBase](#class-swapquoteexecutionoptsbase) - * [types.SwapQuoteGetOutputOpts](#class-swapquotegetoutputopts) - * [types.SwapQuoteGetOutputOptsBase](#class-swapquotegetoutputoptsbase) - * [types.SwapQuoteInfo](#class-swapquoteinfo) - * [types.SwapQuoteRequestOpts](#class-swapquoterequestopts) - * [types.SwapQuoteWithAffiliateFeeBase](#class-swapquotewithaffiliatefeebase) - * [types.SwapQuoterOpts](#class-swapquoteropts) - * [utils/affiliate_fee_utils](modules/_utils_affiliate_fee_utils_.md) - * [utils/assert](modules/_utils_assert_.md) - * [utils/asset_data_utils](modules/_utils_asset_data_utils_.md) - * [utils/calculate_liquidity](modules/_utils_calculate_liquidity_.md) - * [utils/order_provider_response_processor](modules/_utils_order_provider_response_processor_.md) - * [utils/swap_quote_calculator](modules/_utils_swap_quote_calculator_.md) - * [utils/swap_quote_consumer_utils](modules/_utils_swap_quote_consumer_utils_.md) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [quote_consumers/exchange_swap_quote_consumer.ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) - * [quote_consumers/forwarder_swap_quote_consumer.ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) - * [quote_consumers/swap_quote_consumer.SwapQuoteConsumer](#class-swapquoteconsumer) - * [swap_quoter.SwapQuoter](#class-swapquoter) -* [Enums]() - * [types.ConsumerType](#class-consumertype) - * [types.SwapQuoteConsumerError](#class-swapquoteconsumererror) - * [types.SwapQuoterError](#class-swapquotererror) -* [Interfaces]() - * [types.CalldataInfo](#class-calldatainfo) - * [types.ExchangeMarketBuySmartContractParams](#class-exchangemarketbuysmartcontractparams) - * [types.ExchangeMarketSellSmartContractParams](#class-exchangemarketsellsmartcontractparams) - * [types.ForwarderMarketBuySmartContractParams](#class-forwardermarketbuysmartcontractparams) - * [types.ForwarderMarketSellSmartContractParams](#class-forwardermarketsellsmartcontractparams) - * [types.ForwarderSmartContractParamsBase](#class-forwardersmartcontractparamsbase) - * [types.ForwarderSwapQuoteExecutionOpts](#class-forwarderswapquoteexecutionopts) - * [types.ForwarderSwapQuoteGetOutputOpts](#class-forwarderswapquotegetoutputopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.MarketBuySwapQuote](#class-marketbuyswapquote) - * [types.MarketBuySwapQuoteWithAffiliateFee](#class-marketbuyswapquotewithaffiliatefee) - * [types.MarketSellSwapQuote](#class-marketsellswapquote) - * [types.MarketSellSwapQuoteWithAffiliateFee](#class-marketsellswapquotewithaffiliatefee) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [types.SmartContractParamsBase](#class-smartcontractparamsbase) - * [types.SmartContractParamsInfo](#class-smartcontractparamsinfo) - * [types.SwapQuoteBase](#class-swapquotebase) - * [types.SwapQuoteConsumerBase](#class-swapquoteconsumerbase) - * [types.SwapQuoteConsumerOpts](#class-swapquoteconsumeropts) - * [types.SwapQuoteExecutionOpts](#class-swapquoteexecutionopts) - * [types.SwapQuoteExecutionOptsBase](#class-swapquoteexecutionoptsbase) - * [types.SwapQuoteGetOutputOpts](#class-swapquotegetoutputopts) - * [types.SwapQuoteGetOutputOptsBase](#class-swapquotegetoutputoptsbase) - * [types.SwapQuoteInfo](#class-swapquoteinfo) - * [types.SwapQuoteRequestOpts](#class-swapquoterequestopts) - * [types.SwapQuoteWithAffiliateFeeBase](#class-swapquotewithaffiliatefeebase) - * [types.SwapQuoterOpts](#class-swapquoteropts) - -
- diff --git a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.1/reference.mdx b/packages/website/mdx/tools/@0x/asset-swapper/v1.0.1/reference.mdx index d34f78e4be..06d6d60317 100644 --- a/packages/website/mdx/tools/@0x/asset-swapper/v1.0.1/reference.mdx +++ b/packages/website/mdx/tools/@0x/asset-swapper/v1.0.1/reference.mdx @@ -1,34 +1,21 @@ -> # Class: InsufficientAssetLiquidityError +# Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity -## Hierarchy +### Hierarchy * `Error` * **InsufficientAssetLiquidityError** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [amountAvailableToFill](#amountavailabletofill) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor +## constructer \+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/errors.ts#L12)* **Parameters:** @@ -38,91 +25,76 @@ Name | Type | Description | **Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* -## Properties +### Properties -### amountAvailableToFill +## amountAvailableToFill • **amountAvailableToFill**: *`BigNumber`* -*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/errors.ts#L12)* The amount availabe to fill (in base units) factoring in slippage. ___ -### message +## message • **message**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 + + ___ -### name +## name • **name**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 + + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 + ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 +
-> # Class: BasicOrderProvider +# Class: BasicOrderProvider -## Hierarchy +### Hierarchy * **BasicOrderProvider** -## Implements +### Implements * [OrderProvider](#interface-orderprovider) -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [orders](#orders) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor +## constructer \+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)* -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* Instantiates a new BasicOrderProvider instance @@ -136,21 +108,21 @@ Name | Type | Description | An instance of BasicOrderProvider -## Properties +### Properties -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* +*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L9)* -## Methods +### Methods -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L37)* +*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L37)* Given a taker asset data string, return all availabled paired maker asset data strings. @@ -166,11 +138,11 @@ An array of asset data strings that can be purchased using takerAssetData. ___ -### getAvailableTakerAssetDatasAsync +## getAvailableTakerAssetDatasAsync ▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* -*Defined in [order_providers/basic_order_provider.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L46)* +*Defined in [order_providers/basic_order_provider.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L46)* Given a maker asset data string, return all availabled paired taker asset data strings. @@ -186,11 +158,11 @@ An array of asset data strings that can be used to purchased makerAssetData. ___ -### getOrdersAsync +## getOrdersAsync ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L24)* +*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/basic_order_provider.ts#L24)* Given an object that conforms to OrderFetcherRequest, return the corresponding OrderProviderResponse that satisfies the request. @@ -206,40 +178,24 @@ An instance of OrderProviderResponse. See type for more information.
-> # Class: StandardRelayerAPIOrderProvider +# Class: StandardRelayerAPIOrderProvider -## Hierarchy +### Hierarchy * **StandardRelayerAPIOrderProvider** -## Implements +### Implements * [OrderProvider](#interface-orderprovider) -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [apiUrl](#apiurl) -* [networkId](#networkid) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Constructors - -### constructor +## constructer \+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L49)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L49)* Instantiates a new StandardRelayerAPIOrderProvider instance @@ -254,29 +210,29 @@ Name | Type | Description | An instance of StandardRelayerAPIOrderProvider -## Properties +### Properties -### apiUrl +## apiUrl • **apiUrl**: *string* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L18)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L18)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L19)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L19)* -## Methods +### Methods -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L92)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:92](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L92)* Given a taker asset data string, return all available paired maker asset data strings. @@ -292,11 +248,11 @@ An array of asset data strings that can be purchased using takerAssetData. ___ -### getAvailableTakerAssetDatasAsync +## getAvailableTakerAssetDatasAsync ▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L120)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L120)* Given a maker asset data string, return all availabled paired taker asset data strings. @@ -312,11 +268,11 @@ An array of asset data strings that can be used to purchased makerAssetData. ___ -### getOrdersAsync +## getOrdersAsync ▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise`* -*Defined in [order_providers/standard_relayer_api_order_provider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L68)* +*Defined in [order_providers/standard_relayer_api_order_provider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/order_providers/standard_relayer_api_order_provider.ts#L68)* Given an object that conforms to OrderProviderRequest, return the corresponding OrderProviderResponse that satisfies the request. @@ -332,40 +288,24 @@ An instance of OrderProviderResponse. See type for more information.
-> # Class: ExchangeSwapQuoteConsumer +# Class: ExchangeSwapQuoteConsumer -## Hierarchy +### Hierarchy * **ExchangeSwapQuoteConsumer** -## Implements +### Implements * [SwapQuoteConsumerBase](#exchangesmartcontractparams)*› -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor +## constructer \+ **new ExchangeSwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer)* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L28)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L28)* **Parameters:** @@ -376,31 +316,31 @@ Name | Type | Default | **Returns:** *[ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer)* -## Properties +### Properties -### networkId +## networkId • **networkId**: *number* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L26)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L26)* ___ -### provider +## provider • **provider**: *`ZeroExProvider`* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L25)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L25)* -## Methods +### Methods -### executeSwapQuoteOrThrowAsync +## executeSwapQuoteOrThrowAsync ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L121)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L121)* **Parameters:** @@ -413,13 +353,13 @@ Name | Type | ___ -### getCalldataOrThrowAsync +## getCalldataOrThrowAsync ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L42)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L42)* **Parameters:** @@ -432,13 +372,13 @@ Name | Type | ___ -### getSmartContractParamsOrThrowAsync +## getSmartContractParamsOrThrowAsync ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `_opts`: `Partial`): *`Promise>`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L70)* +*Defined in [quote_consumers/exchange_swap_quote_consumer.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/exchange_swap_quote_consumer.ts#L70)* **Parameters:** @@ -451,40 +391,24 @@ Name | Type |
-> # Class: ForwarderSwapQuoteConsumer +# Class: ForwarderSwapQuoteConsumer -## Hierarchy +### Hierarchy * **ForwarderSwapQuoteConsumer** -## Implements +### Implements * [SwapQuoteConsumerBase](#forwardersmartcontractparams)*› -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor +## constructer \+ **new ForwarderSwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer)* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L31)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L30)* **Parameters:** @@ -495,31 +419,31 @@ Name | Type | Default | **Returns:** *[ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer)* -## Properties +### Properties -### networkId +## networkId • **networkId**: *number* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L29)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L28)* ___ -### provider +## provider • **provider**: *`ZeroExProvider`* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L28)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L27)* -## Methods +### Methods -### executeSwapQuoteOrThrowAsync +## executeSwapQuoteOrThrowAsync ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:163](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L163)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L159)* Given a SwapQuote and desired rate (in Eth), attempt to execute the swap. @@ -534,13 +458,13 @@ Name | Type | Description | ___ -### getCalldataOrThrowAsync +## getCalldataOrThrowAsync ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L50)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L49)* Given a SwapQuote, returns 'CalldataInfo' for a forwarder extension call. See type definition of CalldataInfo for more information. @@ -555,13 +479,13 @@ Name | Type | Description | ___ -### getSmartContractParamsOrThrowAsync +## getSmartContractParamsOrThrowAsync ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L82)* +*Defined in [quote_consumers/forwarder_swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/forwarder_swap_quote_consumer.ts#L81)* Given a SwapQuote, returns 'SmartContractParamsInfo' for a forwarder extension call. See type definition of CalldataInfo for more information. @@ -576,40 +500,24 @@ Name | Type | Description |
-> # Class: SwapQuoteConsumer +# Class: SwapQuoteConsumer -## Hierarchy +### Hierarchy * **SwapQuoteConsumer** -## Implements +### Implements * [SwapQuoteConsumerBase](#smartcontractparams)*› -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [networkId](#networkid) -* [provider](#provider) - -### Methods - -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Constructors - -### constructor +## constructer \+ **new SwapQuoteConsumer**(`supportedProvider`: `SupportedProvider`, `options`: `Partial`): *[SwapQuoteConsumer](#class-swapquoteconsumer)* -*Defined in [quote_consumers/swap_quote_consumer.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L30)* +*Defined in [quote_consumers/swap_quote_consumer.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L30)* **Parameters:** @@ -620,31 +528,31 @@ Name | Type | Default | **Returns:** *[SwapQuoteConsumer](#class-swapquoteconsumer)* -## Properties +### Properties -### networkId +## networkId • **networkId**: *number* -*Defined in [quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* +*Defined in [quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* ___ -### provider +## provider • **provider**: *`ZeroExProvider`* -*Defined in [quote_consumers/swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L25)* +*Defined in [quote_consumers/swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L25)* -## Methods +### Methods -### executeSwapQuoteOrThrowAsync +## executeSwapQuoteOrThrowAsync ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/swap_quote_consumer.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L80)* +*Defined in [quote_consumers/swap_quote_consumer.ts:80](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L80)* Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. @@ -659,13 +567,13 @@ Name | Type | Description | ___ -### getCalldataOrThrowAsync +## getCalldataOrThrowAsync ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/swap_quote_consumer.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L52)* +*Defined in [quote_consumers/swap_quote_consumer.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L52)* Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information. @@ -680,13 +588,13 @@ Name | Type | Description | ___ -### getSmartContractParamsOrThrowAsync +## getSmartContractParamsOrThrowAsync ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [quote_consumers/swap_quote_consumer.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L66)* +*Defined in [quote_consumers/swap_quote_consumer.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L66)* Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information. @@ -701,48 +609,20 @@ Name | Type | Description |
-> # Class: SwapQuoter +# Class: SwapQuoter -## Hierarchy +### Hierarchy * **SwapQuoter** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Properties +\+ **new SwapQuoter**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -* [expiryBufferMs](#expirybufferms) -* [networkId](#networkid) -* [orderProvider](#orderprovider) -* [orderRefreshIntervalMs](#orderrefreshintervalms) -* [provider](#provider) - -### Methods - -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getLiquidityForMakerTakerAssetDataPairAsync](#getliquidityformakertakerassetdatapairasync) -* [getMarketBuySwapQuoteAsync](#getmarketbuyswapquoteasync) -* [getMarketBuySwapQuoteForAssetDataAsync](#getmarketbuyswapquoteforassetdataasync) -* [getMarketSellSwapQuoteAsync](#getmarketsellswapquoteasync) -* [getMarketSellSwapQuoteForAssetDataAsync](#getmarketsellswapquoteforassetdataasync) -* [getOrdersAndFillableAmountsAsync](#getordersandfillableamountsasync) -* [isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync](#istakeraddressallowanceenoughforbestandworstquoteinfoasync) -* [isTakerMakerAssetDataPairAvailableAsync](#istakermakerassetdatapairavailableasync) -* [getSwapQuoterForProvidedOrders](#static-getswapquoterforprovidedorders) -* [getSwapQuoterForStandardRelayerAPIUrl](#static-getswapquoterforstandardrelayerapiurl) - -## Constructors - -### constructor - -\+ **new SwapQuoter**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-swapquoter)* - -*Defined in [swap_quoter.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L93)* +*Defined in [swap_quoter.ts:92](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L92)* Instantiates a new SwapQuoter instance @@ -758,53 +638,53 @@ Name | Type | Default | Description | An instance of SwapQuoter -## Properties +### Properties -### expiryBufferMs +## expiryBufferMs • **expiryBufferMs**: *number* -*Defined in [swap_quoter.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L41)* +*Defined in [swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L40)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [swap_quoter.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L39)* +*Defined in [swap_quoter.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L38)* ___ -### orderProvider +## orderProvider • **orderProvider**: *[OrderProvider](#interface-orderprovider)* -*Defined in [swap_quoter.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L38)* +*Defined in [swap_quoter.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L37)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L40)* +*Defined in [swap_quoter.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L39)* ___ -### provider +## provider • **provider**: *`ZeroExProvider`* -*Defined in [swap_quoter.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L37)* +*Defined in [swap_quoter.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L36)* -## Methods +### Methods -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [swap_quoter.ts:291](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L291)* +*Defined in [swap_quoter.ts:290](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L290)* Get the asset data of all assets that are purchaseable with takerAssetData in the order provider passed in at init. @@ -820,11 +700,11 @@ An array of asset data strings that are purchaseable with takerAssetData. ___ -### getAvailableTakerAssetDatasAsync +## getAvailableTakerAssetDatasAsync ▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* -*Defined in [swap_quoter.ts:280](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L280)* +*Defined in [swap_quoter.ts:279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L279)* Get the asset data of all assets that can be used to purchase makerAssetData in the order provider passed in at init. @@ -840,11 +720,11 @@ An array of asset data strings that can purchase makerAssetData. ___ -### getLiquidityForMakerTakerAssetDataPairAsync +## getLiquidityForMakerTakerAssetDataPairAsync ▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string, `options`: `Partial`): *`Promise`* -*Defined in [swap_quoter.ts:246](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L246)* +*Defined in [swap_quoter.ts:245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L245)* Returns information about available liquidity for an asset Does not factor in slippage or fees @@ -863,11 +743,11 @@ An object that conforms to LiquidityForAssetData that satisfies the request. See ___ -### getMarketBuySwapQuoteAsync +## getMarketBuySwapQuoteAsync ▸ **getMarketBuySwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [swap_quoter.ts:187](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L187)* +*Defined in [swap_quoter.ts:186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L186)* 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. @@ -887,11 +767,11 @@ An object that conforms to SwapQuote that satisfies the request. See type defini ___ -### getMarketBuySwapQuoteForAssetDataAsync +## getMarketBuySwapQuoteForAssetDataAsync ▸ **getMarketBuySwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [swap_quoter.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L162)* +*Defined in [swap_quoter.ts:161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L161)* 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. @@ -911,11 +791,11 @@ An object that conforms to SwapQuote that satisfies the request. See type defini ___ -### getMarketSellSwapQuoteAsync +## getMarketSellSwapQuoteAsync ▸ **getMarketSellSwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [swap_quoter.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L217)* +*Defined in [swap_quoter.ts:216](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L216)* 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. @@ -935,11 +815,11 @@ An object that conforms to SwapQuote that satisfies the request. See type defini ___ -### getMarketSellSwapQuoteForAssetDataAsync +## getMarketSellSwapQuoteForAssetDataAsync ▸ **getMarketSellSwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [swap_quoter.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L136)* +*Defined in [swap_quoter.ts:135](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L135)* 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. @@ -959,11 +839,11 @@ An object that conforms to SwapQuote that satisfies the request. See type defini ___ -### getOrdersAndFillableAmountsAsync +## getOrdersAndFillableAmountsAsync ▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise`* -*Defined in [swap_quoter.ts:320](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L320)* +*Defined in [swap_quoter.ts:319](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L319)* Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders @@ -979,11 +859,11 @@ Name | Type | Description | ___ -### isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync +## isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync ▸ **isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync**(`swapQuote`: [SwapQuote](#swapquote), `takerAddress`: string): *`Promise<[boolean, boolean]>`* -*Defined in [swap_quoter.ts:381](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L381)* +*Defined in [swap_quoter.ts:380](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L380)* Util function to check if takerAddress's allowance is enough for 0x exchange contracts to conduct the swap specified by the swapQuote. @@ -998,11 +878,11 @@ Name | Type | Description | ___ -### isTakerMakerAssetDataPairAvailableAsync +## isTakerMakerAssetDataPairAvailableAsync ▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [swap_quoter.ts:302](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L302)* +*Defined in [swap_quoter.ts:301](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L301)* Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`. @@ -1019,11 +899,11 @@ A boolean on if the taker, maker pair exists ___ -### `Static` getSwapQuoterForProvidedOrders +## `Static` getSwapQuoterForProvidedOrders ▸ **getSwapQuoterForProvidedOrders**(`supportedProvider`: `SupportedProvider`, `orders`: `SignedOrder`[], `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [swap_quoter.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L54)* +*Defined in [swap_quoter.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L53)* Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. @@ -1041,11 +921,11 @@ An instance of SwapQuoter ___ -### `Static` getSwapQuoterForStandardRelayerAPIUrl +## `Static` getSwapQuoterForStandardRelayerAPIUrl ▸ **getSwapQuoterForStandardRelayerAPIUrl**(`supportedProvider`: `SupportedProvider`, `sraApiUrl`: string, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [swap_quoter.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/swap_quoter.ts#L74)* +*Defined in [swap_quoter.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/swap_quoter.ts#L73)* Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint @@ -1063,166 +943,140 @@ An instance of SwapQuoter
-> # Enumeration: ConsumerType +# Enumeration: ConsumerType Represents the varying smart contracts that can consume a valid swap quote -## Index ### Enumeration members -* [Exchange](#exchange) -* [Forwarder](#forwarder) - -## Enumeration members - -### Exchange +## Exchange • **Exchange**: -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L102)* +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L102)* ___ -### Forwarder +## Forwarder • **Forwarder**: -*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L101)* +*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L101)*
-> # Enumeration: SwapQuoteConsumerError +# Enumeration: SwapQuoteConsumerError Possible error messages thrown by an SwapQuoterConsumer instance or associated static methods. -## Index ### Enumeration members -* [InvalidForwarderSwapQuote](#invalidforwarderswapquote) -* [InvalidMarketSellOrMarketBuySwapQuote](#invalidmarketsellormarketbuyswapquote) -* [NoAddressAvailable](#noaddressavailable) -* [SignatureRequestDenied](#signaturerequestdenied) -* [TransactionValueTooLow](#transactionvaluetoolow) - -## Enumeration members - -### InvalidForwarderSwapQuote +## InvalidForwarderSwapQuote • **InvalidForwarderSwapQuote**: = "INVALID_FORWARDER_SWAP_QUOTE_PROVIDED" -*Defined in [types.ts:304](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L304)* +*Defined in [types.ts:304](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L304)* ___ -### InvalidMarketSellOrMarketBuySwapQuote +## InvalidMarketSellOrMarketBuySwapQuote • **InvalidMarketSellOrMarketBuySwapQuote**: = "INVALID_MARKET_BUY_SELL_SWAP_QUOTE" -*Defined in [types.ts:303](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L303)* +*Defined in [types.ts:303](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L303)* ___ -### NoAddressAvailable +## NoAddressAvailable • **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE" -*Defined in [types.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L305)* +*Defined in [types.ts:305](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L305)* ___ -### SignatureRequestDenied +## SignatureRequestDenied • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [types.ts:306](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L306)* +*Defined in [types.ts:306](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L306)* ___ -### TransactionValueTooLow +## TransactionValueTooLow • **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW" -*Defined in [types.ts:307](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L307)* +*Defined in [types.ts:307](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L307)*
-> # Enumeration: SwapQuoterError +# Enumeration: SwapQuoterError Possible error messages thrown by an SwapQuoter instance or associated static methods. -## Index ### Enumeration members -* [AssetUnavailable](#assetunavailable) -* [InsufficientAssetLiquidity](#insufficientassetliquidity) -* [InsufficientZrxLiquidity](#insufficientzrxliquidity) -* [InvalidOrderProviderResponse](#invalidorderproviderresponse) -* [NoEtherTokenContractFound](#noethertokencontractfound) -* [NoZrxTokenContractFound](#nozrxtokencontractfound) -* [StandardRelayerApiError](#standardrelayerapierror) - -## Enumeration members - -### AssetUnavailable +## AssetUnavailable • **AssetUnavailable**: = "ASSET_UNAVAILABLE" -*Defined in [types.ts:320](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L320)* +*Defined in [types.ts:320](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L320)* ___ -### InsufficientAssetLiquidity +## InsufficientAssetLiquidity • **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" -*Defined in [types.ts:317](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L317)* +*Defined in [types.ts:317](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L317)* ___ -### InsufficientZrxLiquidity +## InsufficientZrxLiquidity • **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" -*Defined in [types.ts:318](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L318)* +*Defined in [types.ts:318](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L318)* ___ -### InvalidOrderProviderResponse +## InvalidOrderProviderResponse • **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" -*Defined in [types.ts:319](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L319)* +*Defined in [types.ts:319](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L319)* ___ -### NoEtherTokenContractFound +## NoEtherTokenContractFound • **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" -*Defined in [types.ts:314](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L314)* +*Defined in [types.ts:314](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L314)* ___ -### NoZrxTokenContractFound +## NoZrxTokenContractFound • **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" -*Defined in [types.ts:315](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L315)* +*Defined in [types.ts:315](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L315)* ___ -### StandardRelayerApiError +## StandardRelayerApiError • **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" -*Defined in [types.ts:316](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L316)* +*Defined in [types.ts:316](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L316)*
-> # Interface: CalldataInfo +# Interface: CalldataInfo Represents the metadata to call a smart contract with calldata. calldataHexString: The hexstring of the calldata. @@ -1230,59 +1084,51 @@ 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. -## Hierarchy +### Hierarchy * **CalldataInfo** -## Index ### Properties -* [calldataHexString](#calldatahexstring) -* [ethAmount](#optional-ethamount) -* [methodAbi](#methodabi) -* [toAddress](#toaddress) - -## Properties - -### calldataHexString +## calldataHexString • **calldataHexString**: *string* -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L50)* ___ -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L53)* ___ -### methodAbi +## methodAbi • **methodAbi**: *`MethodAbi`* -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L51)* ___ -### toAddress +## toAddress • **toAddress**: *string* -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L52)*
-> # Interface: ExchangeMarketBuySmartContractParams +# Interface: ExchangeMarketBuySmartContractParams makerAssetFillAmount: The amount of makerAsset to swap for. type: String specifiying which market operation will be performed with the provided parameters. (In this case a market buy operation) -## Hierarchy +### Hierarchy * [SmartContractParamsBase](#interface-smartcontractparamsbase) @@ -1290,114 +1136,98 @@ type: String specifiying which market operation will be performed with the provi * [ForwarderMarketBuySmartContractParams](#interface-forwardermarketbuysmartcontractparams) -## Index ### Properties -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [signatures](#signatures) -* [type](#type) - -## Properties - -### makerAssetFillAmount +## makerAssetFillAmount • **makerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L84)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SmartContractParamsBase](#orders)* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L75)* ___ -### signatures +## signatures • **signatures**: *string[]* *Inherited from [SmartContractParamsBase](#signatures)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L76)* ___ -### type +## type • **type**: *`Buy`* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L85)*
-> # Interface: ExchangeMarketSellSmartContractParams +# Interface: ExchangeMarketSellSmartContractParams takerAssetFillAmount: The amount of takerAsset swapped for makerAsset. type: String specifiying which market operation will be performed with the provided parameters. (In this case a market sell operation) -## Hierarchy +### Hierarchy * [SmartContractParamsBase](#interface-smartcontractparamsbase) * **ExchangeMarketSellSmartContractParams** -## Index ### Properties -* [orders](#orders) -* [signatures](#signatures) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) - -## Properties - -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SmartContractParamsBase](#orders)* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L75)* ___ -### signatures +## signatures • **signatures**: *string[]* *Inherited from [SmartContractParamsBase](#signatures)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L76)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L93)* ___ -### type +## type • **type**: *`Sell`* -*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L94)*
-> # Interface: ForwarderMarketBuySmartContractParams +# Interface: ForwarderMarketBuySmartContractParams -## Hierarchy +### Hierarchy * [ExchangeMarketBuySmartContractParams](#interface-exchangemarketbuysmartcontractparams) @@ -1405,104 +1235,92 @@ ___ * **ForwarderMarketBuySmartContractParams** -## Index ### Properties -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [signatures](#signatures) -* [type](#type) - -## Properties - -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [ForwarderSmartContractParamsBase](#feeorders)* -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L117)* ___ -### feePercentage +## feePercentage • **feePercentage**: *`BigNumber`* *Inherited from [ForwarderSmartContractParamsBase](#feepercentage)* -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L119)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* *Inherited from [ForwarderSmartContractParamsBase](#feerecipient)* -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L120)* ___ -### feeSignatures +## feeSignatures • **feeSignatures**: *string[]* *Inherited from [ForwarderSmartContractParamsBase](#feesignatures)* -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L118)* ___ -### makerAssetFillAmount +## makerAssetFillAmount • **makerAssetFillAmount**: *`BigNumber`* *Inherited from [ExchangeMarketBuySmartContractParams](#makerassetfillamount)* -*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L84)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SmartContractParamsBase](#orders)* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L75)* ___ -### signatures +## signatures • **signatures**: *string[]* *Inherited from [SmartContractParamsBase](#signatures)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L76)* ___ -### type +## type • **type**: *`Buy`* *Inherited from [ExchangeMarketBuySmartContractParams](#type)* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L85)*
-> # Interface: ForwarderMarketSellSmartContractParams +# Interface: ForwarderMarketSellSmartContractParams -## Hierarchy +### Hierarchy * object @@ -1510,65 +1328,57 @@ ___ * **ForwarderMarketSellSmartContractParams** -## Index ### Properties -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) - -## Properties - -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [ForwarderSmartContractParamsBase](#feeorders)* -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L117)* ___ -### feePercentage +## feePercentage • **feePercentage**: *`BigNumber`* *Inherited from [ForwarderSmartContractParamsBase](#feepercentage)* -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L119)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* *Inherited from [ForwarderSmartContractParamsBase](#feerecipient)* -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L120)* ___ -### feeSignatures +## feeSignatures • **feeSignatures**: *string[]* *Inherited from [ForwarderSmartContractParamsBase](#feesignatures)* -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L118)*
-> # Interface: ForwarderSmartContractParamsBase +# Interface: ForwarderSmartContractParamsBase feeOrders: An array of objects conforming to SignedOrder. These orders can be used to cover the fees for the orders param above. feeSignatures: An array of signatures that attest that the maker of the orders in fact made the orders. feePercentage: Optional affiliate fee percentage used to calculate the eth amount paid to fee recipient. feeRecipient: The address where affiliate fees are sent. Defaults to null address (0x000...000). -## Hierarchy +### Hierarchy * **ForwarderSmartContractParamsBase** @@ -1576,52 +1386,44 @@ feeRecipient: The address where affiliate fees are sent. Defaults to null addres * [ForwarderMarketSellSmartContractParams](#interface-forwardermarketsellsmartcontractparams) -## Index ### Properties -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [feeSignatures](#feesignatures) - -## Properties - -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L117)* ___ -### feePercentage +## feePercentage • **feePercentage**: *`BigNumber`* -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L119)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L120)* ___ -### feeSignatures +## feeSignatures • **feeSignatures**: *string[]* -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L118)*
-> # Interface: ForwarderSwapQuoteExecutionOpts +# Interface: ForwarderSwapQuoteExecutionOpts -## Hierarchy +### Hierarchy * [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts) @@ -1631,86 +1433,76 @@ ___ * [SwapQuoteExecutionOpts](#interface-swapquoteexecutionopts) -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L192)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L190)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L191)* ___ -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* *Inherited from [SwapQuoteExecutionOptsBase](#optional-gaslimit)* -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L180)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Inherited from [SwapQuoteExecutionOptsBase](#optional-gasprice)* -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L181)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* *Inherited from [SwapQuoteExecutionOptsBase](#optional-takeraddress)* -*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L179)*
-> # Interface: ForwarderSwapQuoteGetOutputOpts +# 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. -## Hierarchy +### Hierarchy * [SwapQuoteGetOutputOptsBase](#interface-swapquotegetoutputoptsbase) @@ -1720,79 +1512,66 @@ ethAmount: The amount of eth (in Wei) sent to the forwarder contract. * [ForwarderSwapQuoteExecutionOpts](#interface-forwarderswapquoteexecutionopts) -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L192)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L190)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L191)*
-> # Interface: LiquidityForAssetData +# Interface: LiquidityForAssetData Represents available liquidity for a given assetData -## Hierarchy +### Hierarchy * **LiquidityForAssetData** -## Index ### Properties -* [makerTokensAvailableInBaseUnits](#makertokensavailableinbaseunits) -* [takerTokensAvailableInBaseUnits](#takertokensavailableinbaseunits) - -## Properties - -### makerTokensAvailableInBaseUnits +## makerTokensAvailableInBaseUnits • **makerTokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [types.ts:336](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L336)* +*Defined in [types.ts:336](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L336)* ___ -### takerTokensAvailableInBaseUnits +## takerTokensAvailableInBaseUnits • **takerTokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [types.ts:337](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L337)* +*Defined in [types.ts:337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L337)*
-> # Interface: MarketBuySwapQuote +# Interface: MarketBuySwapQuote makerAssetFillAmount: The amount of makerAsset bought with takerAsset. type: Specified MarketOperation the SwapQuote is provided for -## Hierarchy +### Hierarchy * [SwapQuoteBase](#interface-swapquotebase) @@ -1800,100 +1579,88 @@ type: Specified MarketOperation the SwapQuote is provided for * [MarketBuySwapQuoteWithAffiliateFee](#interface-marketbuyswapquotewithaffiliatefee) -## Index ### Properties -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#bestcasequoteinfo)* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#feeorders)* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L225)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* *Inherited from [SwapQuoteBase](#makerassetdata)* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L223)* ___ -### makerAssetFillAmount +## makerAssetFillAmount • **makerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L244)* +*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L244)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#orders)* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* *Inherited from [SwapQuoteBase](#takerassetdata)* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L222)* ___ -### type +## type • **type**: *`Buy`* -*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L245)* +*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L245)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#worstcasequoteinfo)* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L227)*
-> # Interface: MarketBuySwapQuoteWithAffiliateFee +# Interface: MarketBuySwapQuoteWithAffiliateFee -## Hierarchy +### Hierarchy * [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase) @@ -1901,118 +1668,105 @@ ___ * **MarketBuySwapQuoteWithAffiliateFee** -## Index ### Properties -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [makerAssetData](#makerassetdata) -* [makerAssetFillAmount](#makerassetfillamount) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#bestcasequoteinfo)* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#feeorders)* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L225)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* *Inherited from [SwapQuoteWithAffiliateFeeBase](#feepercentage)* -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L249)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* *Inherited from [SwapQuoteBase](#makerassetdata)* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L223)* ___ -### makerAssetFillAmount +## makerAssetFillAmount • **makerAssetFillAmount**: *`BigNumber`* *Inherited from [MarketBuySwapQuote](#makerassetfillamount)* -*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L244)* +*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L244)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#orders)* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* *Inherited from [SwapQuoteBase](#takerassetdata)* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L222)* ___ -### type +## type • **type**: *`Buy`* *Inherited from [MarketBuySwapQuote](#type)* -*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L245)* +*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L245)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#worstcasequoteinfo)* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L227)*
-> # Interface: MarketSellSwapQuote +# Interface: MarketSellSwapQuote takerAssetFillAmount: The amount of takerAsset sold for makerAsset. type: Specified MarketOperation the SwapQuote is provided for -## Hierarchy +### Hierarchy * [SwapQuoteBase](#interface-swapquotebase) @@ -2020,100 +1774,88 @@ type: Specified MarketOperation the SwapQuote is provided for * [MarketSellSwapQuoteWithAffiliateFee](#interface-marketsellswapquotewithaffiliatefee) -## Index ### Properties -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#bestcasequoteinfo)* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#feeorders)* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L225)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* *Inherited from [SwapQuoteBase](#makerassetdata)* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L223)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#orders)* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* *Inherited from [SwapQuoteBase](#takerassetdata)* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L222)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L235)* +*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L235)* ___ -### type +## type • **type**: *`Sell`* -*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L236)* +*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L236)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#worstcasequoteinfo)* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L227)*
-> # Interface: MarketSellSwapQuoteWithAffiliateFee +# Interface: MarketSellSwapQuoteWithAffiliateFee -## Hierarchy +### Hierarchy * [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase) @@ -2121,142 +1863,122 @@ ___ * **MarketSellSwapQuoteWithAffiliateFee** -## Index ### Properties -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [feePercentage](#feepercentage) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [takerAssetFillAmount](#takerassetfillamount) -* [type](#type) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#bestcasequoteinfo)* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#feeorders)* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L225)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* *Inherited from [SwapQuoteWithAffiliateFeeBase](#feepercentage)* -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L249)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* *Inherited from [SwapQuoteBase](#makerassetdata)* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L223)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* *Inherited from [SwapQuoteBase](#orders)* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* *Inherited from [SwapQuoteBase](#takerassetdata)* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L222)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* *Inherited from [MarketSellSwapQuote](#takerassetfillamount)* -*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L235)* +*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L235)* ___ -### type +## type • **type**: *`Sell`* *Inherited from [MarketSellSwapQuote](#type)* -*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L236)* +*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L236)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* *Inherited from [SwapQuoteBase](#worstcasequoteinfo)* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L227)*
-> # Interface: OrderProvider +# Interface: OrderProvider gerOrdersAsync: Given an OrderProviderRequest, get an OrderProviderResponse. getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all availabled paired maker asset data strings. getAvailableTakerAssetDatasAsync: Given a maker asset data string, return all availabled paired taker asset data strings. -## Hierarchy +### Hierarchy * **OrderProvider** -## Implemented by +### Implemented by * [BasicOrderProvider](#class-basicorderprovider) * [StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) -## Index ### Properties -* [getAvailableMakerAssetDatasAsync](#getavailablemakerassetdatasasync) -* [getAvailableTakerAssetDatasAsync](#getavailabletakerassetdatasasync) -* [getOrdersAsync](#getordersasync) - -## Properties - -### getAvailableMakerAssetDatasAsync +## getAvailableMakerAssetDatasAsync • **getAvailableMakerAssetDatasAsync**: *function* -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L38)* #### Type declaration: @@ -2270,11 +1992,11 @@ Name | Type | ___ -### getAvailableTakerAssetDatasAsync +## getAvailableTakerAssetDatasAsync • **getAvailableTakerAssetDatasAsync**: *function* -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L39)* #### Type declaration: @@ -2288,11 +2010,11 @@ Name | Type | ___ -### getOrdersAsync +## getOrdersAsync • **getOrdersAsync**: *function* -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L37)* #### Type declaration: @@ -2306,295 +2028,258 @@ Name | Type |
-> # Interface: OrderProviderRequest +# Interface: OrderProviderRequest makerAssetData: The assetData representing the desired makerAsset. takerAssetData: The assetData representing the desired takerAsset. networkId: The networkId that the desired orders should be for. -## Hierarchy +### Hierarchy * **OrderProviderRequest** -## Index ### Properties -* [makerAssetData](#makerassetdata) -* [networkId](#networkid) -* [takerAssetData](#takerassetdata) - -## Properties - -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L11)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L13)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L12)*
-> # Interface: OrderProviderResponse +# Interface: OrderProviderResponse orders: An array of orders with optional remaining fillable makerAsset amounts. See type for more info. -## Hierarchy +### Hierarchy * **OrderProviderResponse** -## Index ### Properties -* [orders](#orders) - -## Properties - -### orders +## orders • **orders**: *[SignedOrderWithRemainingFillableMakerAssetAmount](#interface-signedorderwithremainingfillablemakerassetamount)[]* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L20)*
-> # Interface: OrdersAndFillableAmounts +# Interface: OrdersAndFillableAmounts orders: An array of signed orders remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order. -## Hierarchy +### Hierarchy * **OrdersAndFillableAmounts** -## Index ### Properties -* [orders](#orders) -* [remainingFillableMakerAssetAmounts](#remainingfillablemakerassetamounts) - -## Properties - -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:328](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L328)* +*Defined in [types.ts:328](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L328)* ___ -### remainingFillableMakerAssetAmounts +## remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:329](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L329)* +*Defined in [types.ts:329](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L329)*
-> # Interface: SignedOrderWithRemainingFillableMakerAssetAmount +# Interface: SignedOrderWithRemainingFillableMakerAssetAmount A normal SignedOrder with one extra optional property `remainingFillableMakerAssetAmount` remainingFillableMakerAssetAmount: The amount of the makerAsset that is available to be filled -## Hierarchy +### Hierarchy * `SignedOrder` * **SignedOrderWithRemainingFillableMakerAssetAmount** -## Index ### Properties -* [exchangeAddress](#exchangeaddress) -* [expirationTimeSeconds](#expirationtimeseconds) -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetAmount](#makerassetamount) -* [makerAssetData](#makerassetdata) -* [makerFee](#makerfee) -* [remainingFillableMakerAssetAmount](#optional-remainingfillablemakerassetamount) -* [salt](#salt) -* [senderAddress](#senderaddress) -* [signature](#signature) -* [takerAddress](#takeraddress) -* [takerAssetAmount](#takerassetamount) -* [takerAssetData](#takerassetdata) -* [takerFee](#takerfee) - -## Properties - -### exchangeAddress +## exchangeAddress • **exchangeAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:14 + + ___ -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:16 + + ___ -### feeRecipientAddress +## feeRecipientAddress • **feeRecipientAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:15 + + ___ -### makerAddress +## makerAddress • **makerAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:5 + + ___ -### makerAssetAmount +## makerAssetAmount • **makerAssetAmount**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:9 + + ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:11 + + ___ -### makerFee +## makerFee • **makerFee**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:7 + + ___ -### `Optional` remainingFillableMakerAssetAmount +## `Optional` remainingFillableMakerAssetAmount • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L28)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:13 + + ___ -### senderAddress +## senderAddress • **senderAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:4 + + ___ -### signature +## signature • **signature**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:33 + + ___ -### takerAddress +## takerAddress • **takerAddress**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:6 + + ___ -### takerAssetAmount +## takerAssetAmount • **takerAssetAmount**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:10 + + ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:12 + + ___ -### takerFee +## takerFee • **takerFee**: *`BigNumber`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/types/lib/index.d.ts:8 + +
-> # Interface: SmartContractParamsBase +# Interface: SmartContractParamsBase orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested assetBuyAmount plus slippage. signatures: An array of signatures that attest that the maker of the orders in fact made the orders. -## Hierarchy +### Hierarchy * **SmartContractParamsBase** @@ -2602,32 +2287,26 @@ signatures: An array of signatures that attest that the maker of the orders in f * [ExchangeMarketSellSmartContractParams](#interface-exchangemarketsellsmartcontractparams) -## Index ### Properties -* [orders](#orders) -* [signatures](#signatures) - -## Properties - -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L75)* ___ -### signatures +## signatures • **signatures**: *string[]* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L76)*
-> # Interface: SmartContractParamsInfo <**T**> +# 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. @@ -2635,58 +2314,50 @@ 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 +### Type parameters ▪ **T** -## Hierarchy +### Hierarchy * **SmartContractParamsInfo** -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [methodAbi](#methodabi) -* [params](#params) -* [toAddress](#toaddress) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L66)* ___ -### methodAbi +## methodAbi • **methodAbi**: *`MethodAbi`* -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L67)* ___ -### params +## params • **params**: *`T`* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L64)* ___ -### toAddress +## toAddress • **toAddress**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L65)*
-> # Interface: SwapQuoteBase +# Interface: SwapQuoteBase takerAssetData: String that represents a specific taker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). makerAssetData: String that represents a specific maker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). @@ -2695,7 +2366,7 @@ feeOrders: An array of objects conforming to SignedOrder. These orders can be us bestCaseQuoteInfo: Info about the best case price for the asset. worstCaseQuoteInfo: Info about the worst case price for the asset. -## Hierarchy +### Hierarchy * **SwapQuoteBase** @@ -2703,103 +2374,86 @@ worstCaseQuoteInfo: Info about the worst case price for the asset. * [MarketBuySwapQuote](#interface-marketbuyswapquote) -## Index ### Properties -* [bestCaseQuoteInfo](#bestcasequoteinfo) -* [feeOrders](#feeorders) -* [makerAssetData](#makerassetdata) -* [orders](#orders) -* [takerAssetData](#takerassetdata) -* [worstCaseQuoteInfo](#worstcasequoteinfo) - -## Properties - -### bestCaseQuoteInfo +## bestCaseQuoteInfo • **bestCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L225)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L223)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L222)* ___ -### worstCaseQuoteInfo +## worstCaseQuoteInfo • **worstCaseQuoteInfo**: *[SwapQuoteInfo](#interface-swapquoteinfo)* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L227)*
-> # Interface: SwapQuoteConsumerBase <**T**> +# 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 +### Type parameters ▪ **T** -## Hierarchy +### Hierarchy * **SwapQuoteConsumerBase** -## Implemented by +### Implemented by * [ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) * [ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) * [SwapQuoteConsumer](#class-swapquoteconsumer) -## Index ### Methods -* [executeSwapQuoteOrThrowAsync](#executeswapquoteorthrowasync) -* [getCalldataOrThrowAsync](#getcalldataorthrowasync) -* [getSmartContractParamsOrThrowAsync](#getsmartcontractparamsorthrowasync) - -## Methods - -### executeSwapQuoteOrThrowAsync +## executeSwapQuoteOrThrowAsync ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L158)* +*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L158)* **Parameters:** @@ -2812,11 +2466,11 @@ Name | Type | ___ -### getCalldataOrThrowAsync +## getCalldataOrThrowAsync ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L153)* **Parameters:** @@ -2829,11 +2483,11 @@ Name | Type | ___ -### getSmartContractParamsOrThrowAsync +## getSmartContractParamsOrThrowAsync ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* -*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L154)* **Parameters:** @@ -2846,35 +2500,30 @@ Name | Type |
-> # Interface: SwapQuoteConsumerOpts +# Interface: SwapQuoteConsumerOpts networkId: The networkId that the desired orders should be for. -## Hierarchy +### Hierarchy * **SwapQuoteConsumerOpts** -## Index ### Properties -* [networkId](#networkid) - -## Properties - -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L165)*
-> # Interface: SwapQuoteExecutionOpts +# Interface: SwapQuoteExecutionOpts Represents the options for executing a swap quote with SwapQuoteConsumer -## Hierarchy +### Hierarchy * [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts) @@ -2882,21 +2531,10 @@ Represents the options for executing a swap quote with SwapQuoteConsumer * **SwapQuoteExecutionOpts** -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) -* [useConsumerType](#optional-useconsumertype) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* @@ -2904,11 +2542,11 @@ Represents the options for executing a swap quote with SwapQuoteConsumer *Overrides [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L192)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* @@ -2916,11 +2554,11 @@ ___ *Overrides [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L190)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* @@ -2928,31 +2566,31 @@ ___ *Overrides [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L191)* ___ -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* *Inherited from [SwapQuoteExecutionOptsBase](#optional-gaslimit)* -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L180)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Inherited from [SwapQuoteExecutionOptsBase](#optional-gasprice)* -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L181)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* @@ -2960,27 +2598,27 @@ ___ *Overrides [SwapQuoteExecutionOptsBase](#optional-takeraddress)* -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L202)* +*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L202)* ___ -### `Optional` useConsumerType +## `Optional` useConsumerType • **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)* *Inherited from [SwapQuoteGetOutputOpts](#optional-useconsumertype)* -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L203)* +*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L203)*
-> # Interface: SwapQuoteExecutionOptsBase +# 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 -## Hierarchy +### Hierarchy * [SwapQuoteGetOutputOptsBase](#interface-swapquotegetoutputoptsbase) @@ -2988,46 +2626,39 @@ gasPrice: Gas price in Wei to use for a transaction * [ForwarderSwapQuoteExecutionOpts](#interface-forwarderswapquoteexecutionopts) -## Index ### Properties -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [takerAddress](#optional-takeraddress) - -## Properties - -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* -*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L180)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L181)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* -*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L179)*
-> # Interface: SwapQuoteGetOutputOpts +# 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. -## Hierarchy +### Hierarchy * [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts) @@ -3035,69 +2666,60 @@ useConsumerType: If provided, defaults the SwapQuoteConsumer to create output co * [SwapQuoteExecutionOpts](#interface-swapquoteexecutionopts) -## Index ### Properties -* [ethAmount](#optional-ethamount) -* [feePercentage](#feepercentage) -* [feeRecipient](#feerecipient) -* [takerAddress](#optional-takeraddress) -* [useConsumerType](#optional-useconsumertype) - -## Properties - -### `Optional` ethAmount +## `Optional` ethAmount • **ethAmount**? : *`BigNumber`* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#optional-ethamount)* -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L192)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#feepercentage)* -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L190)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* *Inherited from [ForwarderSwapQuoteGetOutputOpts](#feerecipient)* -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L191)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L202)* +*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L202)* ___ -### `Optional` useConsumerType +## `Optional` useConsumerType • **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)* -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L203)* +*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L203)*
-> # Interface: SwapQuoteGetOutputOptsBase +# Interface: SwapQuoteGetOutputOptsBase Represents the options provided to a generic SwapQuoteConsumer -## Hierarchy +### Hierarchy * **SwapQuoteGetOutputOptsBase** @@ -3107,151 +2729,129 @@ Represents the options provided to a generic SwapQuoteConsumer
-> # Interface: SwapQuoteInfo +# Interface: SwapQuoteInfo feeTakerTokenAmount: The amount of takerToken required any fee concerned with completing the swap. takerTokenAmount: The amount of takerToken required to conduct the swap. totalTakerTokenAmount: The total amount of takerToken required to complete the swap (filling orders, feeOrders, and paying affiliate fee) makerTokenAmount: The amount of makerToken that will be acquired through the swap. -## Hierarchy +### Hierarchy * **SwapQuoteInfo** -## Index ### Properties -* [feeTakerTokenAmount](#feetakertokenamount) -* [makerTokenAmount](#makertokenamount) -* [takerTokenAmount](#takertokenamount) -* [totalTakerTokenAmount](#totaltakertokenamount) - -## Properties - -### feeTakerTokenAmount +## feeTakerTokenAmount • **feeTakerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:265](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L265)* +*Defined in [types.ts:265](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L265)* ___ -### makerTokenAmount +## makerTokenAmount • **makerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L268)* +*Defined in [types.ts:268](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L268)* ___ -### takerTokenAmount +## takerTokenAmount • **takerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:267](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L267)* +*Defined in [types.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L267)* ___ -### totalTakerTokenAmount +## totalTakerTokenAmount • **totalTakerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:266](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L266)* +*Defined in [types.ts:266](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L266)*
-> # Interface: SwapQuoteRequestOpts +# Interface: SwapQuoteRequestOpts shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false. 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%). -## Hierarchy +### Hierarchy * **SwapQuoteRequestOpts** -## Index ### Properties -* [shouldDisableRequestingFeeOrders](#shoulddisablerequestingfeeorders) -* [shouldForceOrderRefresh](#shouldforceorderrefresh) -* [slippagePercentage](#slippagepercentage) - -## Properties - -### shouldDisableRequestingFeeOrders +## shouldDisableRequestingFeeOrders • **shouldDisableRequestingFeeOrders**: *boolean* -*Defined in [types.ts:278](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L278)* +*Defined in [types.ts:278](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L278)* ___ -### shouldForceOrderRefresh +## shouldForceOrderRefresh • **shouldForceOrderRefresh**: *boolean* -*Defined in [types.ts:277](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L277)* +*Defined in [types.ts:277](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L277)* ___ -### slippagePercentage +## slippagePercentage • **slippagePercentage**: *number* -*Defined in [types.ts:279](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L279)* +*Defined in [types.ts:279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L279)*
-> # Interface: SwapQuoterOpts +# 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). -## Hierarchy +### Hierarchy * **SwapQuoterOpts** -## Index ### Properties -* [expiryBufferMs](#expirybufferms) -* [networkId](#networkid) -* [orderRefreshIntervalMs](#orderrefreshintervalms) - -## Properties - -### expiryBufferMs +## expiryBufferMs • **expiryBufferMs**: *number* -*Defined in [types.ts:296](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L296)* +*Defined in [types.ts:296](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L296)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:294](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L294)* +*Defined in [types.ts:294](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L294)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [types.ts:295](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L295)* +*Defined in [types.ts:295](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L295)*
-> # Interface: SwapQuoteWithAffiliateFeeBase +# Interface: SwapQuoteWithAffiliateFeeBase -## Hierarchy +### Hierarchy * **SwapQuoteWithAffiliateFeeBase** @@ -3259,127 +2859,14 @@ ___ * [MarketBuySwapQuoteWithAffiliateFee](#interface-marketbuyswapquotewithaffiliatefee) -## Index ### Properties -* [feePercentage](#feepercentage) - -## Properties - -### feePercentage +## feePercentage • **feePercentage**: *number* -*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-swapper/src/types.ts#L249)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [constants](modules/_constants_.md) - * [errors](modules/_errors_.md) - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [index](modules/_index_.md) - * [order_providers/basic_order_provider](modules/_order_providers_basic_order_provider_.md) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider](modules/_order_providers_standard_relayer_api_order_provider_.md) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [quote_consumers/exchange_swap_quote_consumer](modules/_quote_consumers_exchange_swap_quote_consumer_.md) - * [quote_consumers/exchange_swap_quote_consumer.ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) - * [quote_consumers/forwarder_swap_quote_consumer](modules/_quote_consumers_forwarder_swap_quote_consumer_.md) - * [quote_consumers/forwarder_swap_quote_consumer.ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) - * [quote_consumers/swap_quote_consumer](modules/_quote_consumers_swap_quote_consumer_.md) - * [quote_consumers/swap_quote_consumer.SwapQuoteConsumer](#class-swapquoteconsumer) - * [swap_quoter](modules/_swap_quoter_.md) - * [swap_quoter.SwapQuoter](#class-swapquoter) - * [types](modules/_types_.md) - * [types.ConsumerType](#class-consumertype) - * [types.SwapQuoteConsumerError](#class-swapquoteconsumererror) - * [types.SwapQuoterError](#class-swapquotererror) - * [types.CalldataInfo](#class-calldatainfo) - * [types.ExchangeMarketBuySmartContractParams](#class-exchangemarketbuysmartcontractparams) - * [types.ExchangeMarketSellSmartContractParams](#class-exchangemarketsellsmartcontractparams) - * [types.ForwarderMarketBuySmartContractParams](#class-forwardermarketbuysmartcontractparams) - * [types.ForwarderMarketSellSmartContractParams](#class-forwardermarketsellsmartcontractparams) - * [types.ForwarderSmartContractParamsBase](#class-forwardersmartcontractparamsbase) - * [types.ForwarderSwapQuoteExecutionOpts](#class-forwarderswapquoteexecutionopts) - * [types.ForwarderSwapQuoteGetOutputOpts](#class-forwarderswapquotegetoutputopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.MarketBuySwapQuote](#class-marketbuyswapquote) - * [types.MarketBuySwapQuoteWithAffiliateFee](#class-marketbuyswapquotewithaffiliatefee) - * [types.MarketSellSwapQuote](#class-marketsellswapquote) - * [types.MarketSellSwapQuoteWithAffiliateFee](#class-marketsellswapquotewithaffiliatefee) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [types.SmartContractParamsBase](#class-smartcontractparamsbase) - * [types.SmartContractParamsInfo](#class-smartcontractparamsinfo) - * [types.SwapQuoteBase](#class-swapquotebase) - * [types.SwapQuoteConsumerBase](#class-swapquoteconsumerbase) - * [types.SwapQuoteConsumerOpts](#class-swapquoteconsumeropts) - * [types.SwapQuoteExecutionOpts](#class-swapquoteexecutionopts) - * [types.SwapQuoteExecutionOptsBase](#class-swapquoteexecutionoptsbase) - * [types.SwapQuoteGetOutputOpts](#class-swapquotegetoutputopts) - * [types.SwapQuoteGetOutputOptsBase](#class-swapquotegetoutputoptsbase) - * [types.SwapQuoteInfo](#class-swapquoteinfo) - * [types.SwapQuoteRequestOpts](#class-swapquoterequestopts) - * [types.SwapQuoteWithAffiliateFeeBase](#class-swapquotewithaffiliatefeebase) - * [types.SwapQuoterOpts](#class-swapquoteropts) - * [utils/affiliate_fee_utils](modules/_utils_affiliate_fee_utils_.md) - * [utils/assert](modules/_utils_assert_.md) - * [utils/asset_data_utils](modules/_utils_asset_data_utils_.md) - * [utils/calculate_liquidity](modules/_utils_calculate_liquidity_.md) - * [utils/order_provider_response_processor](modules/_utils_order_provider_response_processor_.md) - * [utils/swap_quote_calculator](modules/_utils_swap_quote_calculator_.md) - * [utils/swap_quote_consumer_utils](modules/_utils_swap_quote_consumer_utils_.md) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [errors.InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror) - * [order_providers/basic_order_provider.BasicOrderProvider](#class-basicorderprovider) - * [order_providers/standard_relayer_api_order_provider.StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider) - * [quote_consumers/exchange_swap_quote_consumer.ExchangeSwapQuoteConsumer](#class-exchangeswapquoteconsumer) - * [quote_consumers/forwarder_swap_quote_consumer.ForwarderSwapQuoteConsumer](#class-forwarderswapquoteconsumer) - * [quote_consumers/swap_quote_consumer.SwapQuoteConsumer](#class-swapquoteconsumer) - * [swap_quoter.SwapQuoter](#class-swapquoter) -* [Enums]() - * [types.ConsumerType](#class-consumertype) - * [types.SwapQuoteConsumerError](#class-swapquoteconsumererror) - * [types.SwapQuoterError](#class-swapquotererror) -* [Interfaces]() - * [types.CalldataInfo](#class-calldatainfo) - * [types.ExchangeMarketBuySmartContractParams](#class-exchangemarketbuysmartcontractparams) - * [types.ExchangeMarketSellSmartContractParams](#class-exchangemarketsellsmartcontractparams) - * [types.ForwarderMarketBuySmartContractParams](#class-forwardermarketbuysmartcontractparams) - * [types.ForwarderMarketSellSmartContractParams](#class-forwardermarketsellsmartcontractparams) - * [types.ForwarderSmartContractParamsBase](#class-forwardersmartcontractparamsbase) - * [types.ForwarderSwapQuoteExecutionOpts](#class-forwarderswapquoteexecutionopts) - * [types.ForwarderSwapQuoteGetOutputOpts](#class-forwarderswapquotegetoutputopts) - * [types.LiquidityForAssetData](#class-liquidityforassetdata) - * [types.MarketBuySwapQuote](#class-marketbuyswapquote) - * [types.MarketBuySwapQuoteWithAffiliateFee](#class-marketbuyswapquotewithaffiliatefee) - * [types.MarketSellSwapQuote](#class-marketsellswapquote) - * [types.MarketSellSwapQuoteWithAffiliateFee](#class-marketsellswapquotewithaffiliatefee) - * [types.OrderProvider](#class-orderprovider) - * [types.OrderProviderRequest](#class-orderproviderrequest) - * [types.OrderProviderResponse](#class-orderproviderresponse) - * [types.OrdersAndFillableAmounts](#class-ordersandfillableamounts) - * [types.SignedOrderWithRemainingFillableMakerAssetAmount](#class-signedorderwithremainingfillablemakerassetamount) - * [types.SmartContractParamsBase](#class-smartcontractparamsbase) - * [types.SmartContractParamsInfo](#class-smartcontractparamsinfo) - * [types.SwapQuoteBase](#class-swapquotebase) - * [types.SwapQuoteConsumerBase](#class-swapquoteconsumerbase) - * [types.SwapQuoteConsumerOpts](#class-swapquoteconsumeropts) - * [types.SwapQuoteExecutionOpts](#class-swapquoteexecutionopts) - * [types.SwapQuoteExecutionOptsBase](#class-swapquoteexecutionoptsbase) - * [types.SwapQuoteGetOutputOpts](#class-swapquotegetoutputopts) - * [types.SwapQuoteGetOutputOptsBase](#class-swapquotegetoutputoptsbase) - * [types.SwapQuoteInfo](#class-swapquoteinfo) - * [types.SwapQuoteRequestOpts](#class-swapquoterequestopts) - * [types.SwapQuoteWithAffiliateFeeBase](#class-swapquotewithaffiliatefeebase) - * [types.SwapQuoterOpts](#class-swapquoteropts) +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/asset-swapper/src/types.ts#L249)*
diff --git a/packages/website/mdx/tools/@0x/connect/v5.0.15/README.md b/packages/website/mdx/tools/@0x/connect/v5.0.15/README.md deleted file mode 100644 index 18531e03ad..0000000000 --- a/packages/website/mdx/tools/@0x/connect/v5.0.15/README.md +++ /dev/null @@ -1,74 +0,0 @@ -## @0x/connect - -This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) - -## Installation - -```bash -yarn add @0x/connect -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Usage - -- [Docs](https://0xproject.com/docs/connect) -- [Tutorials](https://0xproject.com/wiki#connect) - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/connect yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/connect yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/connect/v5.0.15/reference.mdx b/packages/website/mdx/tools/@0x/connect/v5.0.15/reference.mdx deleted file mode 100644 index 3fc80d0b91..0000000000 --- a/packages/website/mdx/tools/@0x/connect/v5.0.15/reference.mdx +++ /dev/null @@ -1,647 +0,0 @@ -> # Class: HttpClient - -This class includes all the functionality related to interacting with a set of HTTP endpoints -that implement the standard relayer API v2 - -## Hierarchy - -* **HttpClient** - -## Implements - -* [Client](#interface-client) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getAssetPairsAsync](#getassetpairsasync) -* [getFeeRecipientsAsync](#getfeerecipientsasync) -* [getOrderAsync](#getorderasync) -* [getOrderConfigAsync](#getorderconfigasync) -* [getOrderbookAsync](#getorderbookasync) -* [getOrdersAsync](#getordersasync) -* [submitOrderAsync](#submitorderasync) - -## Constructors - -### constructor - -\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)* - -*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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 [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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 [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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`): *`Promise`* - -*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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` | - | - -**Returns:** *`Promise`* - -The APIOrder that matches the supplied orderHash - -___ - -### getOrderConfigAsync - -▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise`* - -*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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` | Options specifying network id. | - -**Returns:** *`Promise`* - -The resulting OrderConfigResponse that matches the request - -___ - -### getOrderbookAsync - -▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* - -*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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 [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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`): *`Promise`* - -*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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` | Options specifying network id. | - -**Returns:** *`Promise`* - -
- -> # Class: WebSocketOrdersChannel - -This class includes all the functionality related to interacting with a websocket endpoint -that implements the standard relayer API v0 - -## Hierarchy - -* **WebSocketOrdersChannel** - -## Implements - -* [OrdersChannel](#interface-orderschannel) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [close](#close) -* [subscribe](#subscribe) - -## Constructors - -### constructor - -\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#class-websocketorderschannel)* - -*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L21)* - -Instantiates a new WebSocketOrdersChannel instance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`client` | `w3cwebsocket` | A WebSocket client | -`handler` | [OrdersChannelHandler](#interface-orderschannelhandler) | An OrdersChannelHandler instance that responds to various channel updates | - -**Returns:** *[WebSocketOrdersChannel](#class-websocketorderschannel)* - -An instance of WebSocketOrdersChannel - -## Methods - -### close - -▸ **close**(): *void* - -*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L66)* - -Close the websocket and stop receiving updates - -**Returns:** *void* - -___ - -### subscribe - -▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void* - -*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L50)* - -Subscribe to orderbook snapshots and updates from the websocket - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionOpts` | `OrdersChannelSubscriptionOpts` | An OrdersChannelSubscriptionOpts instance describing which assetData pair to subscribe to | - -**Returns:** *void* - -
- -> # Enumeration: HttpRequestType - -## Index - -### Enumeration members - -* [Get](#get) -* [Post](#post) - -## Enumeration members - -### Get - -• **Get**: = "GET" - -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L46)* - -___ - -### Post - -• **Post**: = "POST" - -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L47)* - -
- -> # Interface: Client - -## Hierarchy - -* **Client** - -## Implemented by - -* [HttpClient](#class-httpclient) - -## Index - -### Properties - -* [getAssetPairsAsync](#getassetpairsasync) -* [getFeeRecipientsAsync](#getfeerecipientsasync) -* [getOrderAsync](#getorderasync) -* [getOrderConfigAsync](#getorderconfigasync) -* [getOrderbookAsync](#getorderbookasync) -* [getOrdersAsync](#getordersasync) -* [submitOrderAsync](#submitorderasync) - -## Properties - -### getAssetPairsAsync - -• **getAssetPairsAsync**: *function* - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L18)* - -#### Type declaration: - -▸ (`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise>`* - -**Parameters:** - -Name | Type | ------- | ------ | -`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` | - -___ - -### getFeeRecipientsAsync - -• **getFeeRecipientsAsync**: *function* - -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L25)* - -#### Type declaration: - -▸ (`requestOpts?`: `PagedRequestOpts`): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`requestOpts?` | `PagedRequestOpts` | - -___ - -### getOrderAsync - -• **getOrderAsync**: *function* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L22)* - -#### Type declaration: - -▸ (`orderHash`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -___ - -### getOrderConfigAsync - -• **getOrderConfigAsync**: *function* - -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L24)* - -#### Type declaration: - -▸ (`request`: `OrderConfigRequest`): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`request` | `OrderConfigRequest` | - -___ - -### getOrderbookAsync - -• **getOrderbookAsync**: *function* - -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L23)* - -#### Type declaration: - -▸ (`request`: `OrderbookRequest`, `requestOpts?`: `PagedRequestOpts`): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`request` | `OrderbookRequest` | -`requestOpts?` | `PagedRequestOpts` | - -___ - -### getOrdersAsync - -• **getOrdersAsync**: *function* - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L21)* - -#### Type declaration: - -▸ (`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise>`* - -**Parameters:** - -Name | Type | ------- | ------ | -`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` | - -___ - -### submitOrderAsync - -• **submitOrderAsync**: *function* - -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L26)* - -#### Type declaration: - -▸ (`signedOrder`: `SignedOrder`): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -
- -> # Interface: HttpRequestOptions - -## Hierarchy - -* **HttpRequestOptions** - -## Index - -### Properties - -* [params](#optional-params) -* [payload](#optional-payload) - -## Properties - -### `Optional` params - -• **params**? : *undefined | object* - -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L41)* - -___ - -### `Optional` payload - -• **payload**? : *undefined | object* - -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L42)* - -
- -> # Interface: OrdersChannel - -## Hierarchy - -* **OrdersChannel** - -## Implemented by - -* [WebSocketOrdersChannel](#class-websocketorderschannel) - -## Index - -### Properties - -* [close](#close) -* [subscribe](#subscribe) - -## Properties - -### close - -• **close**: *function* - -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L31)* - -#### Type declaration: - -▸ (): *void* - -___ - -### subscribe - -• **subscribe**: *function* - -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L30)* - -#### Type declaration: - -▸ (`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`subscriptionOpts` | `OrdersChannelSubscriptionOpts` | - -
- -> # Interface: OrdersChannelHandler - -## Hierarchy - -* **OrdersChannelHandler** - -## Index - -### Properties - -* [onClose](#onclose) -* [onError](#onerror) -* [onUpdate](#onupdate) - -## Properties - -### onClose - -• **onClose**: *function* - -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L37)* - -#### Type declaration: - -▸ (`channel`: [OrdersChannel](#interface-orderschannel)): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`channel` | [OrdersChannel](#interface-orderschannel) | - -___ - -### onError - -• **onError**: *function* - -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L36)* - -#### Type declaration: - -▸ (`channel`: [OrdersChannel](#interface-orderschannel), `err`: `Error`, `subscriptionOpts?`: `OrdersChannelSubscriptionOpts`): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`channel` | [OrdersChannel](#interface-orderschannel) | -`err` | `Error` | -`subscriptionOpts?` | `OrdersChannelSubscriptionOpts` | - -___ - -### onUpdate - -• **onUpdate**: *function* - -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L35)* - -#### Type declaration: - -▸ (`channel`: [OrdersChannel](#interface-orderschannel), `subscriptionOpts`: `OrdersChannelSubscriptionOpts`, `orders`: `APIOrder`[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`channel` | [OrdersChannel](#interface-orderschannel) | -`subscriptionOpts` | `OrdersChannelSubscriptionOpts` | -`orders` | `APIOrder`[] | - -
- -> # Interface: OrdersChannelSubscriptionOptsMap - -## Hierarchy - -* **OrdersChannelSubscriptionOptsMap** - -## Indexable - -● \[▪ **key**: *string*\]: `OrdersChannelSubscriptionOpts` - -
- -* [Globals](globals.md) -* [External Modules]() - * [http_client](modules/_http_client_.md) - * [http_client.HttpClient](#class-httpclient) - * [index](modules/_index_.md) - * [orders_channel_factory](modules/_orders_channel_factory_.md) - * [types](modules/_types_.md) - * [types.HttpRequestType](#class-httprequesttype) - * [types.Client](#class-client) - * [types.HttpRequestOptions](#class-httprequestoptions) - * [types.OrdersChannel](#class-orderschannel) - * [types.OrdersChannelHandler](#class-orderschannelhandler) - * [utils/assert](modules/_utils_assert_.md) - * [utils/orders_channel_message_parser](modules/_utils_orders_channel_message_parser_.md) - * [utils/relayer_response_json_parsers](modules/_utils_relayer_response_json_parsers_.md) - * [utils/type_converters](modules/_utils_type_converters_.md) - * [ws_orders_channel](modules/_ws_orders_channel_.md) - * [ws_orders_channel.WebSocketOrdersChannel](#class-websocketorderschannel) - * [ws_orders_channel.OrdersChannelSubscriptionOptsMap](#class-orderschannelsubscriptionoptsmap) -* [Classes]() - * [http_client.HttpClient](#class-httpclient) - * [ws_orders_channel.WebSocketOrdersChannel](#class-websocketorderschannel) -* [Enums]() - * [types.HttpRequestType](#class-httprequesttype) -* [Interfaces]() - * [types.Client](#class-client) - * [types.HttpRequestOptions](#class-httprequestoptions) - * [types.OrdersChannel](#class-orderschannel) - * [types.OrdersChannelHandler](#class-orderschannelhandler) - * [ws_orders_channel.OrdersChannelSubscriptionOptsMap](#class-orderschannelsubscriptionoptsmap) - -
- diff --git a/packages/website/mdx/tools/@0x/connect/v5.0.16/reference.mdx b/packages/website/mdx/tools/@0x/connect/v5.0.16/reference.mdx index 3fc80d0b91..c9976c72d1 100644 --- a/packages/website/mdx/tools/@0x/connect/v5.0.16/reference.mdx +++ b/packages/website/mdx/tools/@0x/connect/v5.0.16/reference.mdx @@ -1,39 +1,24 @@ -> # Class: HttpClient +# Class: HttpClient This class includes all the functionality related to interacting with a set of HTTP endpoints that implement the standard relayer API v2 -## Hierarchy +### Hierarchy * **HttpClient** -## Implements +### Implements * [Client](#interface-client) -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [getAssetPairsAsync](#getassetpairsasync) -* [getFeeRecipientsAsync](#getfeerecipientsasync) -* [getOrderAsync](#getorderasync) -* [getOrderConfigAsync](#getorderconfigasync) -* [getOrderbookAsync](#getorderbookasync) -* [getOrdersAsync](#getordersasync) -* [submitOrderAsync](#submitorderasync) - -## Constructors - -### constructor +## constructer \+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)* -*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L44)* +*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L44)* Instantiates a new HttpClient instance @@ -47,13 +32,13 @@ Name | Type | Description | An instance of HttpClient -## Methods +### Methods -### getAssetPairsAsync +## getAssetPairsAsync ▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L59)* +*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L59)* Retrieve assetData pair info from the API @@ -69,11 +54,11 @@ The resulting AssetPairsResponse that match the request ___ -### getFeeRecipientsAsync +## getFeeRecipientsAsync ▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L160)* +*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L160)* Retrieve the list of fee recipient addresses used by the relayer. @@ -89,11 +74,11 @@ The resulting FeeRecipientsResponse ___ -### getOrderAsync +## getOrderAsync ▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: `RequestOpts`): *`Promise`* -*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L99)* +*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L99)* Retrieve a specific order from the API @@ -110,11 +95,11 @@ The APIOrder that matches the supplied orderHash ___ -### getOrderConfigAsync +## getOrderConfigAsync ▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise`* -*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L139)* +*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L139)* Retrieve fee information from the API @@ -131,11 +116,11 @@ The resulting OrderConfigResponse that matches the request ___ -### getOrderbookAsync +## getOrderbookAsync ▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L117)* +*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L117)* Retrieve an orderbook from the API @@ -152,11 +137,11 @@ The resulting OrderbookResponse that matches the request ___ -### getOrdersAsync +## getOrdersAsync ▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L79)* +*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L79)* Retrieve orders from the API @@ -172,11 +157,11 @@ The resulting OrdersResponse that match the request ___ -### submitOrderAsync +## submitOrderAsync ▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: `RequestOpts`): *`Promise`* -*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L177)* +*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/http_client.ts#L177)* Submit a signed order to the API @@ -191,37 +176,27 @@ Name | Type | Description |
-> # Class: WebSocketOrdersChannel +# Class: WebSocketOrdersChannel This class includes all the functionality related to interacting with a websocket endpoint that implements the standard relayer API v0 -## Hierarchy +### Hierarchy * **WebSocketOrdersChannel** -## Implements +### Implements * [OrdersChannel](#interface-orderschannel) -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *[WebSocketOrdersChannel](#class-websocketorderschannel)* -* [close](#close) -* [subscribe](#subscribe) - -## Constructors - -### constructor - -\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#class-websocketorderschannel)* - -*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L21)* +*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/ws_orders_channel.ts#L21)* Instantiates a new WebSocketOrdersChannel instance @@ -236,13 +211,13 @@ Name | Type | Description | An instance of WebSocketOrdersChannel -## Methods +### Methods -### close +## close ▸ **close**(): *void* -*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L66)* +*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/ws_orders_channel.ts#L66)* Close the websocket and stop receiving updates @@ -250,11 +225,11 @@ Close the websocket and stop receiving updates ___ -### subscribe +## subscribe ▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void* -*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L50)* +*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/ws_orders_channel.ts#L50)* Subscribe to orderbook snapshots and updates from the websocket @@ -268,62 +243,45 @@ Name | Type | Description |
-> # Enumeration: HttpRequestType +# Enumeration: HttpRequestType -## Index ### Enumeration members -* [Get](#get) -* [Post](#post) - -## Enumeration members - -### Get +## Get • **Get**: = "GET" -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L46)* ___ -### Post +## Post • **Post**: = "POST" -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L47)*
-> # Interface: Client +# Interface: Client -## Hierarchy +### Hierarchy * **Client** -## Implemented by +### Implemented by * [HttpClient](#class-httpclient) -## Index ### Properties -* [getAssetPairsAsync](#getassetpairsasync) -* [getFeeRecipientsAsync](#getfeerecipientsasync) -* [getOrderAsync](#getorderasync) -* [getOrderConfigAsync](#getorderconfigasync) -* [getOrderbookAsync](#getorderbookasync) -* [getOrdersAsync](#getordersasync) -* [submitOrderAsync](#submitorderasync) - -## Properties - -### getAssetPairsAsync +## getAssetPairsAsync • **getAssetPairsAsync**: *function* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L18)* #### Type declaration: @@ -337,11 +295,11 @@ Name | Type | ___ -### getFeeRecipientsAsync +## getFeeRecipientsAsync • **getFeeRecipientsAsync**: *function* -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L25)* #### Type declaration: @@ -355,11 +313,11 @@ Name | Type | ___ -### getOrderAsync +## getOrderAsync • **getOrderAsync**: *function* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L22)* #### Type declaration: @@ -373,11 +331,11 @@ Name | Type | ___ -### getOrderConfigAsync +## getOrderConfigAsync • **getOrderConfigAsync**: *function* -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L24)* #### Type declaration: @@ -391,11 +349,11 @@ Name | Type | ___ -### getOrderbookAsync +## getOrderbookAsync • **getOrderbookAsync**: *function* -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L23)* #### Type declaration: @@ -410,11 +368,11 @@ Name | Type | ___ -### getOrdersAsync +## getOrdersAsync • **getOrdersAsync**: *function* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L21)* #### Type declaration: @@ -428,11 +386,11 @@ Name | Type | ___ -### submitOrderAsync +## submitOrderAsync • **submitOrderAsync**: *function* -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L26)* #### Type declaration: @@ -446,61 +404,49 @@ Name | Type |
-> # Interface: HttpRequestOptions +# Interface: HttpRequestOptions -## Hierarchy +### Hierarchy * **HttpRequestOptions** -## Index ### Properties -* [params](#optional-params) -* [payload](#optional-payload) - -## Properties - -### `Optional` params +## `Optional` params • **params**? : *undefined | object* -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L41)* ___ -### `Optional` payload +## `Optional` payload • **payload**? : *undefined | object* -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L42)*
-> # Interface: OrdersChannel +# Interface: OrdersChannel -## Hierarchy +### Hierarchy * **OrdersChannel** -## Implemented by +### Implemented by * [WebSocketOrdersChannel](#class-websocketorderschannel) -## Index ### Properties -* [close](#close) -* [subscribe](#subscribe) - -## Properties - -### close +## close • **close**: *function* -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L31)* #### Type declaration: @@ -508,11 +454,11 @@ ___ ___ -### subscribe +## subscribe • **subscribe**: *function* -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L30)* #### Type declaration: @@ -526,27 +472,20 @@ Name | Type |
-> # Interface: OrdersChannelHandler +# Interface: OrdersChannelHandler -## Hierarchy +### Hierarchy * **OrdersChannelHandler** -## Index ### Properties -* [onClose](#onclose) -* [onError](#onerror) -* [onUpdate](#onupdate) - -## Properties - -### onClose +## onClose • **onClose**: *function* -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L37)* #### Type declaration: @@ -560,11 +499,11 @@ Name | Type | ___ -### onError +## onError • **onError**: *function* -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L36)* #### Type declaration: @@ -580,11 +519,11 @@ Name | Type | ___ -### onUpdate +## onUpdate • **onUpdate**: *function* -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/connect/src/types.ts#L35)* #### Type declaration: @@ -600,48 +539,15 @@ Name | Type |
-> # Interface: OrdersChannelSubscriptionOptsMap +# Interface: OrdersChannelSubscriptionOptsMap -## Hierarchy +### Hierarchy * **OrdersChannelSubscriptionOptsMap** -## Indexable +### Indexable ● \[▪ **key**: *string*\]: `OrdersChannelSubscriptionOpts`
-* [Globals](globals.md) -* [External Modules]() - * [http_client](modules/_http_client_.md) - * [http_client.HttpClient](#class-httpclient) - * [index](modules/_index_.md) - * [orders_channel_factory](modules/_orders_channel_factory_.md) - * [types](modules/_types_.md) - * [types.HttpRequestType](#class-httprequesttype) - * [types.Client](#class-client) - * [types.HttpRequestOptions](#class-httprequestoptions) - * [types.OrdersChannel](#class-orderschannel) - * [types.OrdersChannelHandler](#class-orderschannelhandler) - * [utils/assert](modules/_utils_assert_.md) - * [utils/orders_channel_message_parser](modules/_utils_orders_channel_message_parser_.md) - * [utils/relayer_response_json_parsers](modules/_utils_relayer_response_json_parsers_.md) - * [utils/type_converters](modules/_utils_type_converters_.md) - * [ws_orders_channel](modules/_ws_orders_channel_.md) - * [ws_orders_channel.WebSocketOrdersChannel](#class-websocketorderschannel) - * [ws_orders_channel.OrdersChannelSubscriptionOptsMap](#class-orderschannelsubscriptionoptsmap) -* [Classes]() - * [http_client.HttpClient](#class-httpclient) - * [ws_orders_channel.WebSocketOrdersChannel](#class-websocketorderschannel) -* [Enums]() - * [types.HttpRequestType](#class-httprequesttype) -* [Interfaces]() - * [types.Client](#class-client) - * [types.HttpRequestOptions](#class-httprequestoptions) - * [types.OrdersChannel](#class-orderschannel) - * [types.OrdersChannelHandler](#class-orderschannelhandler) - * [ws_orders_channel.OrdersChannelSubscriptionOptsMap](#class-orderschannelsubscriptionoptsmap) - -
- diff --git a/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/README.md b/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/README.md deleted file mode 100644 index ac6c5ec601..0000000000 --- a/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/README.md +++ /dev/null @@ -1,89 +0,0 @@ -## @0x/contract-wrappers - -Smart TS wrappers for 0x smart contracts. The wrappers have simplified interfaces, perform client-side validation on transactions and throw helpful error messages. - -### Read the [Documentation](https://0xproject.com/docs/0x.js). - -## Installation - -**Install** - -```bash -npm install @0x/contract-wrappers --save -``` - -**Import** - -```javascript -import { ContractWrappers } from '@0x/contract-wrappers'; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/contract-wrappers yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/contract-wrappers yarn watch -``` - -```bash -yarn build -``` - -or continuously rebuild on change: - -```bash -yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/reference.mdx b/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/reference.mdx deleted file mode 100644 index 7a7cc5c582..0000000000 --- a/packages/website/mdx/tools/@0x/contract-wrappers/v10.1.0/reference.mdx +++ /dev/null @@ -1,5657 +0,0 @@ -> # Class: AbstractBalanceAndProxyAllowanceLazyStore - -## Hierarchy - -* **AbstractBalanceAndProxyAllowanceLazyStore** - -## Index - -### Methods - -* [deleteAll](#abstract-deleteall) -* [deleteBalance](#abstract-deletebalance) -* [deleteProxyAllowance](#abstract-deleteproxyallowance) -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) -* [setBalance](#abstract-setbalance) -* [setProxyAllowance](#abstract-setproxyallowance) - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* - -**Returns:** *void* - -___ - -### `Abstract` deleteBalance - -▸ **deleteBalance**(`tokenAddress`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteProxyAllowance - -▸ **deleteProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`tokenAddress`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`tokenAddress`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` setBalance - -▸ **setBalance**(`tokenAddress`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setProxyAllowance - -▸ **setProxyAllowance**(`tokenAddress`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | -`proxyAllowance` | `BigNumber` | - -**Returns:** *void* - -
- -> # Class: ContractWrappers - -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. - -## Hierarchy - -* **ContractWrappers** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [coordinator](#coordinator) -* [dutchAuction](#dutchauction) -* [erc20Proxy](#erc20proxy) -* [erc20Token](#erc20token) -* [erc721Proxy](#erc721proxy) -* [erc721Token](#erc721token) -* [etherToken](#ethertoken) -* [exchange](#exchange) -* [forwarder](#forwarder) -* [orderValidator](#ordervalidator) - -### Methods - -* [getAbiDecoder](#getabidecoder) -* [getProvider](#getprovider) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ContractWrappers**(`supportedProvider`: `SupportedProvider`, `config`: [ContractWrappersConfig](#class-contractwrappers)* - -*Defined in [contract_wrappers.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L83)* - -Instantiates a new ContractWrappers instance. - -**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. | - -**Returns:** *[ContractWrappers](#class-contractwrappers)* - -An instance of the ContractWrappers class. - -## Properties - -### coordinator - -• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract_wrappers.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L81)* - -An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. - -___ - -### dutchAuction - -• **dutchAuction**: *[DutchAuctionWrapper](#class-dutchauctionwrapper)* - -*Defined in [contract_wrappers.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L76)* - -An instance of the DutchAuctionWrapper class containing methods for interacting with any DutchAuction smart contract. - -___ - -### erc20Proxy - -• **erc20Proxy**: *[ERC20ProxyWrapper](#class-erc20proxywrapper)* - -*Defined in [contract_wrappers.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L59)* - -An instance of the ERC20ProxyWrapper class containing methods for interacting with the -erc20Proxy smart contract. - -___ - -### erc20Token - -• **erc20Token**: *[ERC20TokenWrapper](#class-erc20tokenwrapper)* - -*Defined in [contract_wrappers.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L45)* - -An instance of the ERC20TokenWrapper class containing methods for interacting with any ERC20 token smart contract. - -___ - -### erc721Proxy - -• **erc721Proxy**: *[ERC721ProxyWrapper](#class-erc721proxywrapper)* - -*Defined in [contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L64)* - -An instance of the ERC721ProxyWrapper class containing methods for interacting with the -erc721Proxy smart contract. - -___ - -### erc721Token - -• **erc721Token**: *[ERC721TokenWrapper](#class-erc721tokenwrapper)* - -*Defined in [contract_wrappers.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L49)* - -An instance of the ERC721TokenWrapper class containing methods for interacting with any ERC721 token smart contract. - -___ - -### etherToken - -• **etherToken**: *[EtherTokenWrapper](#class-ethertokenwrapper)* - -*Defined in [contract_wrappers.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L54)* - -An instance of the EtherTokenWrapper class containing methods for interacting with the -wrapped ETH ERC20 token smart contract. - -___ - -### exchange - -• **exchange**: *[ExchangeWrapper](#class-exchangewrapper)* - -*Defined in [contract_wrappers.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L41)* - -An instance of the ExchangeWrapper class containing methods for interacting with the 0x Exchange smart contract. - -___ - -### forwarder - -• **forwarder**: *[ForwarderWrapper](#class-forwarderwrapper)* - -*Defined in [contract_wrappers.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L68)* - -An instance of the ForwarderWrapper class containing methods for interacting with any Forwarder smart contract. - -___ - -### orderValidator - -• **orderValidator**: *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -*Defined in [contract_wrappers.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L72)* - -An instance of the OrderValidatorWrapper class containing methods for interacting with any OrderValidator smart contract. - -## Methods - -### getAbiDecoder - -▸ **getAbiDecoder**(): *`AbiDecoder`* - -*Defined in [contract_wrappers.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L179)* - -Get the abi decoder instance currently used by contract-wrappers - -**Returns:** *`AbiDecoder`* - -AbiDecoder instance - -___ - -### getProvider - -▸ **getProvider**(): *`SupportedProvider`* - -*Defined in [contract_wrappers.ts:172](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L172)* - -Get the provider instance currently used by contract-wrappers - -**Returns:** *`SupportedProvider`* - -Web3 provider instance - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L162)* - -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. - -## Hierarchy - -* **CoordinatorWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [exchangeAddress](#exchangeaddress) -* [networkId](#networkid) -* [registryAddress](#registryaddress) - -### Methods - -* [assertValidCoordinatorApprovalsOrThrowAsync](#assertvalidcoordinatorapprovalsorthrowasync) -* [batchFillOrKillOrdersAsync](#batchfillorkillordersasync) -* [batchFillOrdersAsync](#batchfillordersasync) -* [batchFillOrdersNoThrowAsync](#batchfillordersnothrowasync) -* [batchHardCancelOrdersAsync](#batchhardcancelordersasync) -* [batchSoftCancelOrdersAsync](#batchsoftcancelordersasync) -* [fillOrKillOrderAsync](#fillorkillorderasync) -* [fillOrderAsync](#fillorderasync) -* [fillOrderNoThrowAsync](#fillordernothrowasync) -* [getSignerAddressAsync](#getsigneraddressasync) -* [hardCancelOrderAsync](#hardcancelorderasync) -* [hardCancelOrdersUpToAsync](#hardcancelordersuptoasync) -* [marketBuyOrdersAsync](#marketbuyordersasync) -* [marketBuyOrdersNoThrowAsync](#marketbuyordersnothrowasync) -* [marketSellOrdersAsync](#marketsellordersasync) -* [marketSellOrdersNoThrowAsync](#marketsellordersnothrowasync) -* [softCancelOrderAsync](#softcancelorderasync) - -## Constructors - -### constructor - -\+ **new CoordinatorWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L43)* - -Instantiate CoordinatorWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`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`* = Coordinator.compilerOutput.abi - -*Defined in [contract_wrappers/coordinator_wrapper.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L33)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L35)* - -___ - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L36)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L34)* - -___ - -### registryAddress - -• **registryAddress**: *string* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L37)* - -## Methods - -### assertValidCoordinatorApprovalsOrThrowAsync - -▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* - -*Defined in [contract_wrappers/coordinator_wrapper.ts:582](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L582)* - -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/coordinator_wrapper.ts:248](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L248)* - -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/coordinator_wrapper.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L190)* - -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/coordinator_wrapper.ts:219](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L219)* - -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/coordinator_wrapper.ts:513](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L513)* - -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/coordinator_wrapper.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L427)* - -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/coordinator_wrapper.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L158)* - -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/coordinator_wrapper.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L103)* - -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/coordinator_wrapper.ts:130](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L130)* - -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/coordinator_wrapper.ts:614](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L614)* - -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/coordinator_wrapper.ts:481](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L481)* - -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/coordinator_wrapper.ts:548](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L548)* - -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/coordinator_wrapper.ts:282](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L282)* - -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/coordinator_wrapper.ts:341](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L341)* - -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/coordinator_wrapper.ts:314](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L314)* - -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/coordinator_wrapper.ts:368](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L368)* - -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/coordinator_wrapper.ts:392](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L392)* - -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: DutchAuctionWrapper - -## Hierarchy - -* **DutchAuctionWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) - -### Methods - -* [getAuctionDetailsAsync](#getauctiondetailsasync) -* [matchOrdersAsync](#matchordersasync) -* [decodeDutchAuctionData](#static-decodedutchauctiondata) -* [encodeDutchAuctionAssetData](#static-encodedutchauctionassetdata) - -## Constructors - -### constructor - -\+ **new DutchAuctionWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[DutchAuctionWrapper](#class-dutchauctionwrapper)* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L49)* - -Instantiate DutchAuctionWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Dutch Auction contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[DutchAuctionWrapper](#class-dutchauctionwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = DutchAuction.compilerOutput.abi - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L18)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L19)* - -## Methods - -### getAuctionDetailsAsync - -▸ **getAuctionDetailsAsync**(`sellOrder`: `SignedOrder`): *`Promise`* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L131)* - -Fetches the Auction Details for the given order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`sellOrder` | `SignedOrder` | The Seller's order. This order is for the lowest amount (at the end of the auction). | - -**Returns:** *`Promise`* - -The dutch auction details. - -___ - -### matchOrdersAsync - -▸ **matchOrdersAsync**(`buyOrder`: `SignedOrder`, `sellOrder`: `SignedOrder`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L77)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`buyOrder` | `SignedOrder` | - | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | `SignedOrder` | - | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`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 } | - | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### `Static` decodeDutchAuctionData - -▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L46)* - -Dutch auction details are encoded with the asset data for a 0x order. This function decodes a hex -encoded assetData string, containing information both about the asset being traded and the -dutch auction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`dutchAuctionData` | string | Hex encoded assetData string for the asset being auctioned. | - -**Returns:** *`DutchAuctionData`* - -An object containing the auction asset, auction begin time and auction begin amount. - -___ - -### `Static` encodeDutchAuctionAssetData - -▸ **encodeDutchAuctionAssetData**(`assetData`: string, `beginTimeSeconds`: `BigNumber`, `beginAmount`: `BigNumber`): *string* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L31)* - -Dutch auction details are encoded with the asset data for a 0x order. This function produces a hex -encoded assetData string, containing information both about the asset being traded and the -dutch auction; which is usable in the makerAssetData or takerAssetData fields in a 0x order. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Hex encoded assetData string for the asset being auctioned. | -`beginTimeSeconds` | `BigNumber` | Begin time of the dutch auction. | -`beginAmount` | `BigNumber` | Starting amount being sold in the dutch auction. | - -**Returns:** *string* - -The hex encoded assetData string. - -
- -> # Class: ERC20ProxyWrapper - -This class includes the functionality related to interacting with the ERC20Proxy contract. - -## Hierarchy - -* **ERC20ProxyWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) - -### Methods - -* [getAuthorizedAddressesAsync](#getauthorizedaddressesasync) -* [getProxyIdAsync](#getproxyidasync) -* [isAuthorizedAsync](#isauthorizedasync) - -## Constructors - -### constructor - -\+ **new ERC20ProxyWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[ERC20ProxyWrapper](#class-erc20proxywrapper)* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L18)* - -Instantiate ERC20ProxyWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`networkId` | number | Desired networkId | -`address?` | undefined \| string | The address of the ERC20Proxy contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[ERC20ProxyWrapper](#class-erc20proxywrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = ERC20Proxy.compilerOutput.abi - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L15)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L16)* - -## Methods - -### getAuthorizedAddressesAsync - -▸ **getAuthorizedAddressesAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L61)* - -Get the list of all Exchange contract addresses authorized by the ERC20Proxy contract. - -**Returns:** *`Promise`* - -The list of authorized addresses. - -___ - -### getProxyIdAsync - -▸ **getProxyIdAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L39)* - -Get the 4 bytes ID of this asset proxy - -**Returns:** *`Promise`* - -Proxy id - -___ - -### isAuthorizedAsync - -▸ **isAuthorizedAsync**(`exchangeContractAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L51)* - -Check if the Exchange contract address is authorized by the ERC20Proxy contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeContractAddress` | string | The hex encoded address of the Exchange contract to call. | - -**Returns:** *`Promise`* - -Whether the exchangeContractAddress is authorized. - -
- -> # Class: ERC20TokenWrapper - -This class includes all the functionality related to interacting with ERC20 token contracts. -All ERC20 method calls are supported, along with some convenience methods for getting/setting allowances -to the 0x ERC20 Proxy smart contract. - -## Hierarchy - -* **ERC20TokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [UNLIMITED_ALLOWANCE_IN_BASE_UNITS](#unlimited_allowance_in_base_units) -* [abi](#abi) - -### Methods - -* [getAllowanceAsync](#getallowanceasync) -* [getBalanceAsync](#getbalanceasync) -* [getLogsAsync](#getlogsasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) -* [setAllowanceAsync](#setallowanceasync) -* [setProxyAllowanceAsync](#setproxyallowanceasync) -* [setUnlimitedAllowanceAsync](#setunlimitedallowanceasync) -* [setUnlimitedProxyAllowanceAsync](#setunlimitedproxyallowanceasync) -* [subscribe](#subscribe) -* [transferAsync](#transferasync) -* [transferFromAsync](#transferfromasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ERC20TokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc20ProxyWrapper`: [ERC20ProxyWrapper](#class-erc20tokenwrapper)* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L38)* - -Instantiate ERC20TokenWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc20ProxyWrapper` | [ERC20ProxyWrapper](#class-erc20proxywrapper) | The ERC20ProxyWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[ERC20TokenWrapper](#class-erc20tokenwrapper)* - -## Properties - -### UNLIMITED_ALLOWANCE_IN_BASE_UNITS - -• **UNLIMITED_ALLOWANCE_IN_BASE_UNITS**: *`BigNumber`* = constants.UNLIMITED_ALLOWANCE_IN_BASE_UNITS - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L33)* - -___ - -### abi - -• **abi**: *`ContractAbi`* = ERC20Token.compilerOutput.abi - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L32)* - -## Methods - -### getAllowanceAsync - -▸ **getAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:155](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L155)* - -Retrieves the owners allowance in baseUnits set to the spender's address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose allowance to spenderAddress you would like to retrieve. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who can spend the allowance you are fetching. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -___ - -### getBalanceAsync - -▸ **getBalanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L61)* - -Retrieves an owner's ERC20 token balance. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose balance you would like to check. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The owner's ERC20 token balance in base units. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC20TokenEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L409)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`ERC20TokenEventArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | An address of the token that emitted the logs. | -`eventName` | `ERC20TokenEvents` | The token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 - -___ - -### getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L188)* - -Retrieves the owner's allowance in baseUnits set to the 0x proxy contract. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose proxy contract allowance we are retrieving. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -___ - -### setAllowanceAsync - -▸ **setAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L91)* - -Sets the spender's allowance to a specified number of baseUnits on behalf of the owner address. -Equivalent to the ERC20 spec method `approve`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who would like to set an allowance for spenderAddress. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who will be able to spend the set allowance. | -`amountInBaseUnits` | `BigNumber` | - | The allowance amount you would like to set. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyAllowanceAsync - -▸ **setProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L207)* - -Sets the 0x proxy contract's allowance to a specified number of a tokens' baseUnits on behalf -of an owner address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who is setting an allowance for the Proxy contract. | -`amountInBaseUnits` | `BigNumber` | - | The allowance amount specified in baseUnits. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setUnlimitedAllowanceAsync - -▸ **setUnlimitedAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L132)* - -Sets the spender's allowance to an unlimited number of baseUnits on behalf of the owner address. -Equivalent to the ERC20 spec method `approve`. -Setting an unlimited allowance will lower the gas cost for filling orders involving tokens that forego updating -allowances set to the max amount (e.g ZRX, WETH) - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who would like to set an allowance for spenderAddress. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who will be able to spend the set allowance. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setUnlimitedProxyAllowanceAsync - -▸ **setUnlimitedProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:234](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L234)* - -Sets the 0x proxy contract's allowance to a unlimited number of a tokens' baseUnits on behalf -of an owner address. -Setting an unlimited allowance will lower the gas cost for filling orders involving tokens that forego updating -allowances set to the max amount (e.g ZRX, WETH) - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who is setting an allowance for the Proxy contract. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC20TokenEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:363](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L363)* - -Subscribe to an event type emitted by the Token contract. - -**Type parameters:** - -▪ **ArgsType**: *`ERC20TokenEventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded address where the ERC20 token is deployed. | -`eventName` | `ERC20TokenEvents` | - | The token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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) | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### transferAsync - -▸ **transferAsync**(`tokenAddress`: string, `fromAddress`: string, `toAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:256](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L256)* - -Transfers `amountInBaseUnits` ERC20 tokens from `fromAddress` to `toAddress`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`fromAddress` | string | - | The hex encoded user Ethereum address that will send the funds. | -`toAddress` | string | - | The hex encoded user Ethereum address that will receive the funds. | -`amountInBaseUnits` | `BigNumber` | - | The amount (specified in baseUnits) of the token to transfer. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### transferFromAsync - -▸ **transferFromAsync**(`tokenAddress`: string, `fromAddress`: string, `toAddress`: string, `senderAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L305)* - -Transfers `amountInBaseUnits` ERC20 tokens from `fromAddress` to `toAddress`. -Requires the fromAddress to have sufficient funds and to have approved an allowance of -`amountInBaseUnits` to `senderAddress`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`fromAddress` | string | - | The hex encoded user Ethereum address whose funds are being sent. | -`toAddress` | string | - | The hex encoded user Ethereum address that will receive the funds. | -`senderAddress` | string | - | The hex encoded user Ethereum address whose initiates the fund transfer. The `fromAddress` must have set an allowance to the `senderAddress` before this call. | -`amountInBaseUnits` | `BigNumber` | - | The amount (specified in baseUnits) of the token to transfer. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:390](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L390)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:397](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L397)* - -Cancels all existing subscriptions - -**Returns:** *void* - -
- -> # Class: ERC721ProxyWrapper - -This class includes the functionality related to interacting with the ERC721Proxy contract. - -## Hierarchy - -* **ERC721ProxyWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) - -### Methods - -* [getAuthorizedAddressesAsync](#getauthorizedaddressesasync) -* [getProxyIdAsync](#getproxyidasync) -* [isAuthorizedAsync](#isauthorizedasync) - -## Constructors - -### constructor - -\+ **new ERC721ProxyWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[ERC721ProxyWrapper](#class-erc721proxywrapper)* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L18)* - -Instantiate ERC721ProxyWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`networkId` | number | Desired networkId | -`address?` | undefined \| string | The address of the ERC721Proxy contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[ERC721ProxyWrapper](#class-erc721proxywrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = ERC721Proxy.compilerOutput.abi - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L15)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L16)* - -## Methods - -### getAuthorizedAddressesAsync - -▸ **getAuthorizedAddressesAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L61)* - -Get the list of all Exchange contract addresses authorized by the ERC721Proxy contract. - -**Returns:** *`Promise`* - -The list of authorized addresses. - -___ - -### getProxyIdAsync - -▸ **getProxyIdAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L39)* - -Get the 4 bytes ID of this asset proxy - -**Returns:** *`Promise`* - -Proxy id - -___ - -### isAuthorizedAsync - -▸ **isAuthorizedAsync**(`exchangeContractAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L51)* - -Check if the Exchange contract address is authorized by the ERC721Proxy contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeContractAddress` | string | The hex encoded address of the Exchange contract to call. | - -**Returns:** *`Promise`* - -Whether the exchangeContractAddress is authorized. - -
- -> # Class: ERC721TokenWrapper - -This class includes all the functionality related to interacting with ERC721 token contracts. -All ERC721 method calls are supported, along with some convenience methods for getting/setting allowances -to the 0x ERC721 Proxy smart contract. - -## Hierarchy - -* **ERC721TokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) - -### Methods - -* [getApprovedIfExistsAsync](#getapprovedifexistsasync) -* [getLogsAsync](#getlogsasync) -* [getOwnerOfAsync](#getownerofasync) -* [getTokenCountAsync](#gettokencountasync) -* [isApprovedForAllAsync](#isapprovedforallasync) -* [isProxyApprovedAsync](#isproxyapprovedasync) -* [isProxyApprovedForAllAsync](#isproxyapprovedforallasync) -* [setApprovalAsync](#setapprovalasync) -* [setApprovalForAllAsync](#setapprovalforallasync) -* [setProxyApprovalAsync](#setproxyapprovalasync) -* [setProxyApprovalForAllAsync](#setproxyapprovalforallasync) -* [subscribe](#subscribe) -* [transferFromAsync](#transferfromasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ERC721TokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc721ProxyWrapper`: [ERC721ProxyWrapper](#class-erc721tokenwrapper)* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L37)* - -Instantiate ERC721TokenWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc721ProxyWrapper` | [ERC721ProxyWrapper](#class-erc721proxywrapper) | The ERC721ProxyWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[ERC721TokenWrapper](#class-erc721tokenwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = ERC721Token.compilerOutput.abi - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L32)* - -## Methods - -### getApprovedIfExistsAsync - -▸ **getApprovedIfExistsAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L170)* - -Get the approved address for a single NFT. Returns undefined if no approval was set -Throws if `_tokenId` is not a valid NFT - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The approved address for this NFT, or the undefined if there is none - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC721TokenEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:436](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L436)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`ERC721TokenEventArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | An address of the token that emitted the logs. | -`eventName` | `ERC721TokenEvents` | The token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 - -___ - -### getOwnerOfAsync - -▸ **getOwnerOfAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:88](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L88)* - -Find the owner of an NFT -NFTs assigned to zero address are considered invalid, and queries about them do throw. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The address of the owner of the NFT - -___ - -### getTokenCountAsync - -▸ **getTokenCountAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L61)* - -Count all NFTs assigned to an owner -NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose balance you would like to check. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The number of NFTs owned by `ownerAddress`, possibly zero - -___ - -### isApprovedForAllAsync - -▸ **isApprovedForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `operatorAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L116)* - -Query if an address is an authorized operator for all NFT's of `ownerAddress` - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`operatorAddress` | string | - | The hex encoded user Ethereum address of the operator you'd like to check if approved. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if `operatorAddress` is an approved operator for `ownerAddress`, false otherwise - -___ - -### isProxyApprovedAsync - -▸ **isProxyApprovedAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:197](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L197)* - -Checks if 0x proxy is approved for a single NFT -Throws if `_tokenId` is not a valid NFT - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if 0x proxy is approved - -___ - -### isProxyApprovedForAllAsync - -▸ **isProxyApprovedForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:148](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L148)* - -Query if 0x proxy is an authorized operator for all NFT's of `ownerAddress` - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if `operatorAddress` is an approved operator for `ownerAddress`, false otherwise - -___ - -### setApprovalAsync - -▸ **setApprovalAsync**(`tokenAddress`: string, `approvedAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:280](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L280)* - -Set or reaffirm the approved address for an NFT -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. -Throws if `_tokenId` is not a valid NFT -Emits the Approval event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`approvedAddress` | string | - | The hex encoded user Ethereum address you'd like to set approval for. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setApprovalForAllAsync - -▸ **setApprovalForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `operatorAddress`: string, `isApproved`: boolean, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:218](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L218)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`operatorAddress` | string | - | The hex encoded user Ethereum address of the operator you'd like to set approval for. | -`isApproved` | boolean | - | The boolean variable to set the approval to. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyApprovalAsync - -▸ **setProxyApprovalAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:318](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L318)* - -Set or reaffirm 0x proxy as an approved address for an NFT -Throws unless `msg.sender` is the current NFT owner, or an authorized operator of the current owner. -Throws if `_tokenId` is not a valid NFT -Emits the Approval event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyApprovalForAllAsync - -▸ **setProxyApprovalForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `isApproved`: boolean, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:258](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L258)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`isApproved` | boolean | - | The boolean variable to set the approval to. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC721TokenEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:390](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L390)* - -Subscribe to an event type emitted by the Token contract. - -**Type parameters:** - -▪ **ArgsType**: *`ERC721TokenEventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded address where the ERC721 token is deployed. | -`eventName` | `ERC721TokenEvents` | - | The token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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) | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### transferFromAsync - -▸ **transferFromAsync**(`tokenAddress`: string, `receiverAddress`: string, `senderAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:338](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L338)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`receiverAddress` | string | - | The hex encoded Ethereum address of the user to send the NFT to. | -`senderAddress` | string | - | The hex encoded Ethereum address of the user to send the NFT to. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L417)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L424)* - -Cancels all existing subscriptions - -**Returns:** *void* - -
- -> # Class: EtherTokenWrapper - -This class includes all the functionality related to interacting with a wrapped Ether ERC20 token contract. -The caller can convert ETH into the equivalent number of wrapped ETH ERC20 tokens and back. - -## Hierarchy - -* **EtherTokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) - -### Methods - -* [depositAsync](#depositasync) -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [withdrawAsync](#withdrawasync) - -## Constructors - -### constructor - -\+ **new EtherTokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc20TokenWrapper`: [ERC20TokenWrapper](#class-ethertokenwrapper)* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L28)* - -Instantiate EtherTokenWrapper. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc20TokenWrapper` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | The ERC20TokenWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[EtherTokenWrapper](#class-ethertokenwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = WETH9.compilerOutput.abi - -*Defined in [contract_wrappers/ether_token_wrapper.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L21)* - -## Methods - -### depositAsync - -▸ **depositAsync**(`etherTokenAddress`: string, `amountInWei`: `BigNumber`, `depositor`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L53)* - -Deposit ETH into the Wrapped ETH smart contract and issues the equivalent number of wrapped ETH tokens -to the depositor address. These wrapped ETH tokens can be used in 0x trades and are redeemable for 1-to-1 -for ETH. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`etherTokenAddress` | string | - | EtherToken address you wish to deposit into. | -`amountInWei` | `BigNumber` | - | Amount of ETH in Wei the caller wishes to deposit. | -`depositor` | string | - | The hex encoded user Ethereum address that would like to make the deposit. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`etherTokenAddress`: string, `eventName`: `WETH9Events`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L131)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`WETH9EventArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`etherTokenAddress` | string | An address of the ether token that emitted the logs. | -`eventName` | `WETH9Events` | The ether token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 `{_owner: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`etherTokenAddress`: string, `eventName`: `WETH9Events`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L161)* - -Subscribe to an event type emitted by the Token contract. - -**Type parameters:** - -▪ **ArgsType**: *`WETH9EventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`etherTokenAddress` | string | - | The hex encoded address where the ether token is deployed. | -`eventName` | `WETH9Events` | - | The ether token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 `{_owner: 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) | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L188)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L195)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### withdrawAsync - -▸ **withdrawAsync**(`etherTokenAddress`: string, `amountInWei`: `BigNumber`, `withdrawer`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:89](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L89)* - -Withdraw ETH to the withdrawer's address from the wrapped ETH smart contract in exchange for the -equivalent number of wrapped ETH tokens. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`etherTokenAddress` | string | - | EtherToken address you wish to withdraw from. | -`amountInWei` | `BigNumber` | - | Amount of ETH in Wei the caller wishes to withdraw. | -`withdrawer` | string | - | The hex encoded user Ethereum address that would like to make the withdrawal. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -
- -> # Class: ExchangeWrapper - -This class includes all the functionality related to calling methods, sending transactions and subscribing to -events of the 0x V2 Exchange smart contract. - -## Hierarchy - -* **ExchangeWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [zrxTokenAddress](#zrxtokenaddress) - -### Methods - -* [batchCancelOrdersAsync](#batchcancelordersasync) -* [batchFillOrKillOrdersAsync](#batchfillorkillordersasync) -* [batchFillOrdersAsync](#batchfillordersasync) -* [batchFillOrdersNoThrowAsync](#batchfillordersnothrowasync) -* [cancelOrderAsync](#cancelorderasync) -* [cancelOrdersUpToAsync](#cancelordersuptoasync) -* [executeTransactionAsync](#executetransactionasync) -* [fillOrKillOrderAsync](#fillorkillorderasync) -* [fillOrderAsync](#fillorderasync) -* [fillOrderNoThrowAsync](#fillordernothrowasync) -* [getAssetProxyBySignatureAsync](#getassetproxybysignatureasync) -* [getFilledTakerAssetAmountAsync](#getfilledtakerassetamountasync) -* [getLogsAsync](#getlogsasync) -* [getOrderEpochAsync](#getorderepochasync) -* [getOrderInfoAsync](#getorderinfoasync) -* [getOrdersInfoAsync](#getordersinfoasync) -* [getVersionAsync](#getversionasync) -* [getZRXAssetData](#getzrxassetdata) -* [isAllowedValidatorAsync](#isallowedvalidatorasync) -* [isCancelledAsync](#iscancelledasync) -* [isPreSignedAsync](#ispresignedasync) -* [isTransactionExecutedAsync](#istransactionexecutedasync) -* [isValidSignatureAsync](#isvalidsignatureasync) -* [marketBuyOrdersAsync](#marketbuyordersasync) -* [marketBuyOrdersNoThrowAsync](#marketbuyordersnothrowasync) -* [marketSellOrdersAsync](#marketsellordersasync) -* [marketSellOrdersNoThrowAsync](#marketsellordersnothrowasync) -* [matchOrdersAsync](#matchordersasync) -* [preSignAsync](#presignasync) -* [setSignatureValidatorApprovalAsync](#setsignaturevalidatorapprovalasync) -* [subscribe](#subscribe) -* [transactionEncoderAsync](#transactionencoderasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [validateFillOrderThrowIfInvalidAsync](#validatefillorderthrowifinvalidasync) -* [validateMakerTransferThrowIfInvalidAsync](#validatemakertransferthrowifinvalidasync) -* [validateOrderFillableOrThrowAsync](#validateorderfillableorthrowasync) - -## Constructors - -### constructor - -\+ **new ExchangeWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `erc20TokenWrapper`: [ERC20TokenWrapper](#class-exchangewrapper)* - -*Defined in [contract_wrappers/exchange_wrapper.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L55)* - -Instantiate ExchangeWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`erc20TokenWrapper` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | ERC20TokenWrapper instance to use. | -`erc721TokenWrapper` | [ERC721TokenWrapper](#class-erc721tokenwrapper) | ERC721TokenWrapper instance to use. | -`address?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`zrxTokenAddress?` | undefined \| string | The address of the ZRXToken contract. If undefined, will default to the known address corresponding to the networkId. | -`blockPollingIntervalMs?` | undefined \| number | The block polling interval to use for active subscriptions. | - -**Returns:** *[ExchangeWrapper](#class-exchangewrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = Exchange.compilerOutput.abi - -*Defined in [contract_wrappers/exchange_wrapper.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L48)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/exchange_wrapper.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L49)* - -___ - -### zrxTokenAddress - -• **zrxTokenAddress**: *string* - -*Defined in [contract_wrappers/exchange_wrapper.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L50)* - -## Methods - -### batchCancelOrdersAsync - -▸ **batchCancelOrdersAsync**(`orders`: `Array`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:713](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L713)* - -Batch version of cancelOrderAsync. Executes multiple cancels atomically in a single transaction. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | An array of orders to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### batchFillOrKillOrdersAsync - -▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:665](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L665)* - -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/exchange_wrapper.ts:382](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L382)* - -Batch version of fillOrderAsync. 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. - -___ - -### batchFillOrdersNoThrowAsync - -▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:614](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L614)* - -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. - -___ - -### cancelOrderAsync - -▸ **cancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:986](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L986)* - -Cancel a given order. - -**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. - -___ - -### cancelOrdersUpToAsync - -▸ **cancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1061](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1061)* - -Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch -and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). - -**Parameters:** - -Name | Type | 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. - -___ - -### executeTransactionAsync - -▸ **executeTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L334)* - -Executes a 0x transaction. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address (see [ZEIP18](https://github.com/0xProject/ZEIPs/issues/18)). -This is especially useful for implementing filter contracts. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`salt` | `BigNumber` | - | Salt | -`signerAddress` | string | - | Signer address | -`data` | string | - | Transaction data | -`signature` | string | - | Signature | -`senderAddress` | string | - | Sender address | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### fillOrKillOrderAsync - -▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:283](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L283)* - -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/exchange_wrapper.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L190)* - -Fills a signed order with an amount denominated in baseUnits of the taker asset. - -**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/exchange_wrapper.ts:234](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L234)* - -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. - -___ - -### getAssetProxyBySignatureAsync - -▸ **getAssetProxyBySignatureAsync**(`proxyId`: `AssetProxyId`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L97)* - -Retrieve the address of an asset proxy by signature. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`proxyId` | `AssetProxyId` | - | The 4 bytes signature of an asset proxy | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The address of an asset proxy for a given signature - -___ - -### getFilledTakerAssetAmountAsync - -▸ **getFilledTakerAssetAmountAsync**(`orderHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L115)* - -Retrieve the takerAssetAmount of an order that has already been filled. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orderHash` | string | - | The hex encoded orderHash for which you would like to retrieve the filled takerAssetAmount. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The amount of the order (in taker asset base units) that has already been filled. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: `ExchangeEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1135](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1135)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`ExchangeEventArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | `ExchangeEvents` | The exchange contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 - -___ - -### getOrderEpochAsync - -▸ **getOrderEpochAsync**(`makerAddress`: string, `senderAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:146](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L146)* - -Retrieve the set order epoch for a given makerAddress & senderAddress pair. -Orders can be bulk cancelled by setting the order epoch to a value lower then the salt value of orders one wishes to cancel. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`makerAddress` | string | - | Maker address | -`senderAddress` | string | - | Sender address | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Order epoch. Defaults to 0. - -___ - -### getOrderInfoAsync - -▸ **getOrderInfoAsync**(`order`: `Order` | `SignedOrder`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:947](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L947)* - -Get order info - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | `Order` \| `SignedOrder` | - | Order | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Order info - -___ - -### getOrdersInfoAsync - -▸ **getOrdersInfoAsync**(`orders`: `Array`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:963](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L963)* - -Get order info for multiple orders - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Orders | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Array of Order infos - -___ - -### getVersionAsync - -▸ **getVersionAsync**(`methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L132)* - -Retrieve the exchange contract version - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Version - -___ - -### getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1259](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1259)* - -Returns the ZRX asset data used by the exchange contract. - -**Returns:** *string* - -ZRX asset data - -___ - -### isAllowedValidatorAsync - -▸ **isAllowedValidatorAsync**(`signerAddress`: string, `validatorAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:874](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L874)* - -Checks if the validator is allowed by the signer. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signerAddress` | string | - | Address of a signer | -`validatorAddress` | string | - | Address of a validator | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -If the validator is allowed - -___ - -### isCancelledAsync - -▸ **isCancelledAsync**(`orderHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:169](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L169)* - -Check if an order has been cancelled. Order cancellations are binary - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orderHash` | string | - | The hex encoded orderHash for which you would like to retrieve the cancelled takerAmount. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Whether the order has been cancelled. - -___ - -### isPreSignedAsync - -▸ **isPreSignedAsync**(`hash`: string, `signerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:903](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L903)* - -Check whether the hash is pre-signed on-chain. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Hash to check if pre-signed | -`signerAddress` | string | - | Address that should have signed the given hash. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Whether the hash is pre-signed. - -___ - -### isTransactionExecutedAsync - -▸ **isTransactionExecutedAsync**(`transactionHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:927](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L927)* - -Checks if transaction is already executed. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transactionHash` | string | - | Transaction hash to check | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -If transaction is already executed. - -___ - -### isValidSignatureAsync - -▸ **isValidSignatureAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:846](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L846)* - -Checks if the signature is valid. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Hash to pre-sign | -`signerAddress` | string | - | Address that should have signed the given hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -If the signature is valid - -___ - -### marketBuyOrdersAsync - -▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L428)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. - -**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/exchange_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L516)* - -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/exchange_wrapper.ts:472](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L472)* - -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. - -**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/exchange_wrapper.ts:565](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L565)* - -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. - -___ - -### matchOrdersAsync - -▸ **matchOrdersAsync**(`leftSignedOrder`: `SignedOrder`, `rightSignedOrder`: `SignedOrder`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:752](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L752)* - -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 (whoever matched the two orders). - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`leftSignedOrder` | `SignedOrder` | - | First order to match. | -`rightSignedOrder` | `SignedOrder` | - | Second order to match. | -`takerAddress` | string | - | The address that sends the transaction and gets the spread. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### preSignAsync - -▸ **preSignAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:808](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L808)* - -Approves a hash on-chain using any valid signature type. -After presigning a hash, the preSign signature type will become valid for that hash and signer. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Hash to pre-sign | -`signerAddress` | string | - | Address that should have signed the given hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`senderAddress` | string | - | Address that should send the transaction. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setSignatureValidatorApprovalAsync - -▸ **setSignatureValidatorApprovalAsync**(`validatorAddress`: string, `isApproved`: boolean, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1020](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1020)* - -Sets the signature validator approval - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`validatorAddress` | string | - | Validator contract address. | -`isApproved` | boolean | - | Boolean value to set approval to. | -`senderAddress` | string | - | Sender address. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: `ExchangeEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1096](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1096)* - -Subscribe to an event type emitted by the Exchange contract. - -**Type parameters:** - -▪ **ArgsType**: *`ExchangeEventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | `ExchangeEvents` | - | The exchange contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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) | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### transactionEncoderAsync - -▸ **transactionEncoderAsync**(): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1268)* - -Returns a Transaction Encoder. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address. - -**Returns:** *`Promise`* - -TransactionEncoder - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1118)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1124)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### validateFillOrderThrowIfInvalidAsync - -▸ **validateFillOrderThrowIfInvalidAsync**(`signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1231](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1231)* - -Validate a call to FillOrder and throw if it wouldn't succeed - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`fillTakerAssetAmount` | `BigNumber` | Amount we'd like to fill the order for | -`takerAddress` | string | The taker of the order | - -**Returns:** *`Promise`* - -___ - -### validateMakerTransferThrowIfInvalidAsync - -▸ **validateMakerTransferThrowIfInvalidAsync**(`signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1211](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1211)* - -Validate the transfer from the maker to the taker. This is simulated on-chain -via an eth_call. If this call fails, the asset is currently nontransferable. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`makerAssetAmount` | `BigNumber` | Amount to transfer from the maker | -`takerAddress?` | undefined \| string | The address to transfer to, defaults to signedOrder.takerAddress | - -**Returns:** *`Promise`* - -___ - -### validateOrderFillableOrThrowAsync - -▸ **validateOrderFillableOrThrowAsync**(`signedOrder`: `SignedOrder`, `opts`: [ValidateOrderFillableOpts](#interface-validateorderfillableopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1153)* - -Validate if the supplied order is fillable, and throw if it isn't - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | SignedOrder of interest | -`opts` | [ValidateOrderFillableOpts](#interface-validateorderfillableopts) | {} | ValidateOrderFillableOpts options (e.g expectedFillTakerTokenAmount. If it isn't supplied, we check if the order is fillable for the remaining amount. To check if the order is fillable for a non-zero amount, set `validateRemainingOrderAmountIsFillable` to false.) | - -**Returns:** *`Promise`* - -
- -> # Class: ForwarderWrapper - -This class includes the functionality related to interacting with the Forwarder contract. - -## Hierarchy - -* **ForwarderWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [etherTokenAddress](#ethertokenaddress) -* [zrxTokenAddress](#zrxtokenaddress) - -### Methods - -* [marketBuyOrdersWithEthAsync](#marketbuyorderswithethasync) -* [marketSellOrdersWithEthAsync](#marketsellorderswithethasync) - -## Constructors - -### constructor - -\+ **new ForwarderWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string, `zrxTokenAddress?`: undefined | string, `etherTokenAddress?`: undefined | string): *[ForwarderWrapper](#class-forwarderwrapper)* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L29)* - -Instantiate ForwarderWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`zrxTokenAddress?` | undefined \| string | The address of the ZRXToken contract. If undefined, will default to the known address corresponding to the networkId. | -`etherTokenAddress?` | undefined \| string | The address of a WETH (Ether token) contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[ForwarderWrapper](#class-forwarderwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = Forwarder.compilerOutput.abi - -*Defined in [contract_wrappers/forwarder_wrapper.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L24)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L25)* - -___ - -### etherTokenAddress - -• **etherTokenAddress**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L27)* - -___ - -### zrxTokenAddress - -• **zrxTokenAddress**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L26)* - -## Methods - -### marketBuyOrdersWithEthAsync - -▸ **marketBuyOrdersWithEthAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `ethAmount`: `BigNumber`, `signedFeeOrders`: `SignedOrder`[], `feePercentage`: number, `feeRecipientAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:168](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L168)* - -Attempt to purchase makerAssetFillAmount of makerAsset by selling ethAmount provided with transaction. -Any ZRX required to pay fees for primary orders will automatically be purchased by the contract. -Any ETH not spent will be refunded to sender. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of objects that conform to the SignedOrder interface. All orders must specify the same makerAsset. All orders must specify WETH as the takerAsset | -`makerAssetFillAmount` | `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. | -`ethAmount` | `BigNumber` | - | The amount of eth to send with the transaction (in wei). | -`signedFeeOrders` | `SignedOrder`[] | [] | An array of objects that conform to the SignedOrder interface. All orders must specify ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feePercentage` | number | 0 | The percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. Defaults to 0. | -`feeRecipientAddress` | string | constants.NULL_ADDRESS | The address that will receive ETH when signedFeeOrders are filled. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### marketSellOrdersWithEthAsync - -▸ **marketSellOrdersWithEthAsync**(`signedOrders`: `SignedOrder`[], `takerAddress`: string, `ethAmount`: `BigNumber`, `signedFeeOrders`: `SignedOrder`[], `feePercentage`: number, `feeRecipientAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L82)* - -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. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of objects that conform to the SignedOrder interface. All orders must specify the same makerAsset. All orders must specify WETH as the takerAsset | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`ethAmount` | `BigNumber` | - | The amount of eth to send with the transaction (in wei). | -`signedFeeOrders` | `SignedOrder`[] | [] | An array of objects that conform to the SignedOrder interface. All orders must specify ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feePercentage` | number | 0 | The percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. Defaults to 0. | -`feeRecipientAddress` | string | constants.NULL_ADDRESS | The address that will receive ETH when signedFeeOrders are filled. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -
- -> # Class: OrderValidatorWrapper - -This class includes the functionality related to interacting with the OrderValidator contract. - -## Hierarchy - -* **OrderValidatorWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) - -### Methods - -* [getBalanceAndAllowanceAsync](#getbalanceandallowanceasync) -* [getBalancesAndAllowancesAsync](#getbalancesandallowancesasync) -* [getERC721TokenOwnerAsync](#geterc721tokenownerasync) -* [getOrderAndTraderInfoAsync](#getorderandtraderinfoasync) -* [getOrdersAndTradersInfoAsync](#getordersandtradersinfoasync) -* [getTraderInfoAsync](#gettraderinfoasync) -* [getTradersInfoAsync](#gettradersinfoasync) - -## Constructors - -### constructor - -\+ **new OrderValidatorWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L21)* - -Instantiate OrderValidatorWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the OrderValidator contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = OrderValidator.compilerOutput.abi - -*Defined in [contract_wrappers/order_validator_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L18)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L19)* - -## Methods - -### getBalanceAndAllowanceAsync - -▸ **getBalanceAndAllowanceAsync**(`address`: string, `assetData`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L120)* - -Get an object conforming to BalanceAndAllowance containing on-chain balance and allowance for some address and assetData - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | An ethereum address | -`assetData` | string | An encoded string that can be decoded by a specified proxy contract | - -**Returns:** *`Promise`* - -BalanceAndAllowance - -___ - -### getBalancesAndAllowancesAsync - -▸ **getBalancesAndAllowancesAsync**(`address`: string, `assetDatas`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:139](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L139)* - -Get an array of objects conforming to BalanceAndAllowance containing on-chain balance and allowance for some address and array of assetDatas - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | An ethereum address | -`assetDatas` | string[] | An array of encoded strings that can be decoded by a specified proxy contract | - -**Returns:** *`Promise`* - -BalanceAndAllowance - -___ - -### getERC721TokenOwnerAsync - -▸ **getERC721TokenOwnerAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L163)* - -Get owner address of tokenId by calling `token.ownerOf(tokenId)`, but returns a null owner instead of reverting on an unowned token. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | An ethereum address | -`tokenId` | `BigNumber` | An ERC721 tokenId | - -**Returns:** *`Promise`* - -Owner of tokenId or null address if unowned - -___ - -### getOrderAndTraderInfoAsync - -▸ **getOrderAndTraderInfoAsync**(`order`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L44)* - -Get an object conforming to OrderAndTraderInfo containing on-chain information of the provided order and address - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `SignedOrder` | An object conforming to SignedOrder | -`takerAddress` | string | An ethereum address | - -**Returns:** *`Promise`* - -OrderAndTraderInfo - -___ - -### getOrdersAndTradersInfoAsync - -▸ **getOrdersAndTradersInfoAsync**(`orders`: `SignedOrder`[], `takerAddresses`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L63)* - -Get an array of objects conforming to OrderAndTraderInfo containing on-chain information of the provided orders and addresses - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects conforming to SignedOrder | -`takerAddresses` | string[] | An array of ethereum addresses | - -**Returns:** *`Promise`* - -array of OrderAndTraderInfo - -___ - -### getTraderInfoAsync - -▸ **getTraderInfoAsync**(`order`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L93)* - -Get an object conforming to TraderInfo containing on-chain balance and allowances for maker and taker of order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `SignedOrder` | An object conforming to SignedOrder | -`takerAddress` | string | An ethereum address | - -**Returns:** *`Promise`* - -TraderInfo - -___ - -### getTradersInfoAsync - -▸ **getTradersInfoAsync**(`orders`: `SignedOrder`[], `takerAddresses`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:105](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L105)* - -Get an array of objects conforming to TraderInfo containing on-chain balance and allowances for maker and taker of order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects conforming to SignedOrder | -`takerAddresses` | string[] | An array of ethereum addresses | - -**Returns:** *`Promise`* - -array of TraderInfo - -
- -> # Class: AssetBalanceAndProxyAllowanceFetcher - -## Hierarchy - -* **AssetBalanceAndProxyAllowanceFetcher** - -## Implements - -* `AbstractBalanceAndProxyAllowanceFetcher` - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getBalanceAsync](#getbalanceasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) - -## Constructors - -### constructor - -\+ **new AssetBalanceAndProxyAllowanceFetcher**(`erc20Token`: [ERC20TokenWrapper](#class-assetbalanceandproxyallowancefetcher)* - -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L12)* - -**Parameters:** - -Name | Type | ------- | ------ | -`erc20Token` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | -`erc721Token` | [ERC721TokenWrapper](#class-erc721tokenwrapper) | -`stateLayer` | `BlockParamLiteral` | - -**Returns:** *[AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher)* - -## Methods - -### getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L18)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L49)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -
- -> # Class: OrderFilledCancelledFetcher - -## Hierarchy - -* **OrderFilledCancelledFetcher** - -## Implements - -* `AbstractOrderFilledCancelledFetcher` - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getFilledTakerAmountAsync](#getfilledtakeramountasync) -* [getZRXAssetData](#getzrxassetdata) -* [isOrderCancelledAsync](#isordercancelledasync) - -## Constructors - -### constructor - -\+ **new OrderFilledCancelledFetcher**(`exchange`: [ExchangeWrapper](#class-orderfilledcancelledfetcher)* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L11)* - -**Parameters:** - -Name | Type | ------- | ------ | -`exchange` | [ExchangeWrapper](#class-exchangewrapper) | -`stateLayer` | `BlockParamLiteral` | - -**Returns:** *[OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher)* - -## Methods - -### getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L16)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *`Promise`* - -___ - -### getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L35)* - -**Returns:** *string* - -___ - -### isOrderCancelledAsync - -▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L22)* - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -
- -> # Class: CoordinatorServerError - -## Hierarchy - -* `Error` - - * **CoordinatorServerError** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [approvedOrders](#optional-approvedorders) -* [cancellations](#optional-cancellations) -* [errors](#errors) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor - -\+ **new CoordinatorServerError**(`message`: [CoordinatorServerErrorMsg](#class-coordinatorservererror)* - -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* - -**Parameters:** - -Name | Type | ------- | ------ | -`message` | [CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg) | -`approvedOrders` | `SignedOrder`[] | -`cancellations` | [CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[] | -`errors` | [CoordinatorServerResponse](#interface-coordinatorserverresponse)[] | - -**Returns:** *[CoordinatorServerError](#class-coordinatorservererror)* - -## Properties - -### `Optional` approvedOrders - -• **approvedOrders**? : *`SignedOrder`[]* = [] - -*Defined in [utils/coordinator_server_types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L41)* - -___ - -### `Optional` cancellations - -• **cancellations**? : *[CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[]* = [] - -*Defined in [utils/coordinator_server_types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L42)* - -___ - -### errors - -• **errors**: *[CoordinatorServerResponse](#interface-coordinatorserverresponse)[]* - -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* - -___ - -### message - -• **message**: *[CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg)* - -*Overrides void* - -*Defined in [utils/coordinator_server_types.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L40)* - -___ - -### name - -• **name**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### `Static` Error - -▪ **Error**: *`ErrorConstructor`* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 - -
- -> # Class: TransactionEncoder - -Transaction Encoder. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address. For example, UserA can encode and sign a fillOrder transaction and UserB -can submit this to the blockchain. The Exchange context executes as if UserA had directly submitted this transaction. - -## Hierarchy - -* **TransactionEncoder** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [batchCancelOrdersTx](#batchcancelorderstx) -* [batchFillOrKillOrdersTx](#batchfillorkillorderstx) -* [batchFillOrdersNoThrowTx](#batchfillordersnothrowtx) -* [batchFillOrdersTx](#batchfillorderstx) -* [cancelOrderTx](#cancelordertx) -* [cancelOrdersUpToTx](#cancelordersuptotx) -* [fillOrKillOrderTx](#fillorkillordertx) -* [fillOrderNoThrowTx](#fillordernothrowtx) -* [fillOrderTx](#fillordertx) -* [getTransactionHashHex](#gettransactionhashhex) -* [marketBuyOrdersNoThrowTx](#marketbuyordersnothrowtx) -* [marketBuyOrdersTx](#marketbuyorderstx) -* [marketSellOrdersNoThrowTx](#marketsellordersnothrowtx) -* [marketSellOrdersTx](#marketsellorderstx) -* [matchOrdersTx](#matchorderstx) -* [preSignTx](#presigntx) -* [setSignatureValidatorApprovalTx](#setsignaturevalidatorapprovaltx) - -## Constructors - -### constructor - -\+ **new TransactionEncoder**(`exchangeInstance`: `ExchangeContract`): *[TransactionEncoder](#class-transactionencoder)* - -*Defined in [utils/transaction_encoder.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L17)* - -**Parameters:** - -Name | Type | ------- | ------ | -`exchangeInstance` | `ExchangeContract` | - -**Returns:** *[TransactionEncoder](#class-transactionencoder)* - -## Methods - -### batchCancelOrdersTx - -▸ **batchCancelOrdersTx**(`signedOrders`: `SignedOrder`[]): *string* - -*Defined in [utils/transaction_encoder.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L149)* - -Encodes a batchCancelOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of orders to cancel. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrKillOrdersTx - -▸ **batchFillOrKillOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:112](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L112)* - -Encodes a batchFillOrKillOrders transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrdersNoThrowTx - -▸ **batchFillOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L131)* - -Encodes a batchFillOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrdersTx - -▸ **batchFillOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L93)* - -Encodes a batchFillOrders transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### cancelOrderTx - -▸ **cancelOrderTx**(`order`: `Order` | `SignedOrder`): *string* - -*Defined in [utils/transaction_encoder.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L171)* - -Encodes a cancelOrder transaction. - -**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:** *string* - -Hex encoded abi of the function call. - -___ - -### cancelOrdersUpToTx - -▸ **cancelOrdersUpToTx**(`targetOrderEpoch`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L159)* - -Encodes a cancelOrdersUpTo transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | Target order epoch. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrKillOrderTx - -▸ **fillOrKillOrderTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L77)* - -Encodes a fillOrKillOrder transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrderNoThrowTx - -▸ **fillOrderNoThrowTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L61)* - -Encodes a fillOrderNoThrow transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrderTx - -▸ **fillOrderTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L45)* - -Encodes a fillOrder transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### getTransactionHashHex - -▸ **getTransactionHashHex**(`data`: string, `salt`: `BigNumber`, `signerAddress`: string): *string* - -*Defined in [utils/transaction_encoder.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L28)* - -Hashes the transaction data for use with the Exchange contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | The ABI Encoded 0x Exchange method. I.e fillOrder | -`salt` | `BigNumber` | A random value to provide uniqueness and prevent replay attacks. | -`signerAddress` | string | The address which will sign this transaction. | - -**Returns:** *string* - -The hash of the 0x transaction. - -___ - -### marketBuyOrdersNoThrowTx - -▸ **marketBuyOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:233](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L233)* - -Encodes a maketBuyOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | Maker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketBuyOrdersTx - -▸ **marketBuyOrdersTx**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:216](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L216)* - -Encodes a maketBuyOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | Maker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketSellOrdersNoThrowTx - -▸ **marketSellOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L199)* - -Encodes a marketSellOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | Taker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketSellOrdersTx - -▸ **marketSellOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:182](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L182)* - -Encodes a marketSellOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | Taker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### matchOrdersTx - -▸ **matchOrdersTx**(`leftOrder`: `SignedOrder`, `rightOrder`: `SignedOrder`): *string* - -*Defined in [utils/transaction_encoder.ts:250](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L250)* - -Encodes a matchOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrder` | `SignedOrder` | First order to match. | -`rightOrder` | `SignedOrder` | Second order to match. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### preSignTx - -▸ **preSignTx**(`hash`: string, `signerAddress`: string, `signature`: string): *string* - -*Defined in [utils/transaction_encoder.ts:268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L268)* - -Encodes a preSign transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Hash to pre-sign | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### setSignatureValidatorApprovalTx - -▸ **setSignatureValidatorApprovalTx**(`validatorAddress`: string, `isApproved`: boolean): *string* - -*Defined in [utils/transaction_encoder.ts:285](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L285)* - -Encodes a setSignatureValidatorApproval transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`validatorAddress` | string | Validator contract address. | -`isApproved` | boolean | Boolean value to set approval to. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -
- -> # Enumeration: ContractWrappersError - -## Index - -### Enumeration members - -* [ContractNotDeployedOnNetwork](#contractnotdeployedonnetwork) -* [ERC721NoApproval](#erc721noapproval) -* [ERC721OwnerNotFound](#erc721ownernotfound) -* [InsufficientAllowanceForTransfer](#insufficientallowancefortransfer) -* [InsufficientBalanceForTransfer](#insufficientbalancefortransfer) -* [InsufficientEthBalanceForDeposit](#insufficientethbalancefordeposit) -* [InsufficientWEthBalanceForWithdrawal](#insufficientwethbalanceforwithdrawal) -* [InvalidJump](#invalidjump) -* [OutOfGas](#outofgas) -* [SignatureRequestDenied](#signaturerequestdenied) -* [SubscriptionAlreadyPresent](#subscriptionalreadypresent) -* [SubscriptionNotFound](#subscriptionnotfound) - -## Enumeration members - -### ContractNotDeployedOnNetwork - -• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" - -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L26)* - -___ - -### ERC721NoApproval - -• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" - -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L36)* - -___ - -### ERC721OwnerNotFound - -• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" - -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L35)* - -___ - -### InsufficientAllowanceForTransfer - -• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" - -*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L27)* - -___ - -### InsufficientBalanceForTransfer - -• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" - -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L28)* - -___ - -### InsufficientEthBalanceForDeposit - -• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" - -*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L29)* - -___ - -### InsufficientWEthBalanceForWithdrawal - -• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" - -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L30)* - -___ - -### InvalidJump - -• **InvalidJump**: = "INVALID_JUMP" - -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L31)* - -___ - -### OutOfGas - -• **OutOfGas**: = "OUT_OF_GAS" - -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L32)* - -___ - -### SignatureRequestDenied - -• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" - -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L37)* - -___ - -### SubscriptionAlreadyPresent - -• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" - -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L34)* - -___ - -### SubscriptionNotFound - -• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" - -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L33)* - -
- -> # Enumeration: DutchAuctionWrapperError - -## Index - -### Enumeration members - -* [AssetDataMismatch](#assetdatamismatch) - -## Enumeration members - -### AssetDataMismatch - -• **AssetDataMismatch**: = "ASSET_DATA_MISMATCH" - -*Defined in [types.ts:220](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L220)* - -
- -> # Enumeration: ExchangeWrapperError - -## Index - -### Enumeration members - -* [AssetDataMismatch](#assetdatamismatch) - -## Enumeration members - -### AssetDataMismatch - -• **AssetDataMismatch**: = "ASSET_DATA_MISMATCH" - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L18)* - -
- -> # Enumeration: ForwarderWrapperError - -## Index - -### Enumeration members - -* [CompleteFillFailed](#completefillfailed) - -## Enumeration members - -### CompleteFillFailed - -• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L22)* - -
- -> # Enumeration: InternalContractWrappersError - -## Index - -### Enumeration members - -* [NoAbiDecoder](#noabidecoder) - -## Enumeration members - -### NoAbiDecoder - -• **NoAbiDecoder**: = "NO_ABI_DECODER" - -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L41)* - -
- -> # Enumeration: OrderStatus - -## Index - -### Enumeration members - -* [Cancelled](#cancelled) -* [Expired](#expired) -* [Fillable](#fillable) -* [FullyFilled](#fullyfilled) -* [Invalid](#invalid) -* [InvalidMakerAssetAmount](#invalidmakerassetamount) -* [InvalidTakerAssetAmount](#invalidtakerassetamount) - -## Enumeration members - -### Cancelled - -• **Cancelled**: - -*Defined in [types.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L195)* - -___ - -### Expired - -• **Expired**: - -*Defined in [types.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L193)* - -___ - -### Fillable - -• **Fillable**: - -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L192)* - -___ - -### FullyFilled - -• **FullyFilled**: - -*Defined in [types.ts:194](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L194)* - -___ - -### Invalid - -• **Invalid**: = 0 - -*Defined in [types.ts:189](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L189)* - -___ - -### InvalidMakerAssetAmount - -• **InvalidMakerAssetAmount**: - -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L190)* - -___ - -### InvalidTakerAssetAmount - -• **InvalidTakerAssetAmount**: - -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L191)* - -
- -> # Enumeration: TradeSide - -## Index - -### Enumeration members - -* [Maker](#maker) -* [Taker](#taker) - -## Enumeration members - -### Maker - -• **Maker**: = "maker" - -*Defined in [types.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L171)* - -___ - -### Taker - -• **Taker**: = "taker" - -*Defined in [types.ts:172](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L172)* - -
- -> # Enumeration: TransferType - -## Index - -### Enumeration members - -* [Fee](#fee) -* [Trade](#trade) - -## Enumeration members - -### Fee - -• **Fee**: = "fee" - -*Defined in [types.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L177)* - -___ - -### Trade - -• **Trade**: = "trade" - -*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L176)* - -
- -> # Enumeration: CoordinatorServerErrorMsg - -## Index - -### Enumeration members - -* [CancellationFailed](#cancellationfailed) -* [FillFailed](#fillfailed) - -## 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/6dd77d5c8/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/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)* - -
- -> # Interface: BalanceAndAllowance - -## Hierarchy - -* **BalanceAndAllowance** - -## Index - -### Properties - -* [allowance](#allowance) -* [balance](#balance) - -## Properties - -### allowance - -• **allowance**: *`BigNumber`* - -*Defined in [types.ts:216](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L216)* - -___ - -### balance - -• **balance**: *`BigNumber`* - -*Defined in [types.ts:215](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L215)* - -
- -> # Interface: BlockRange - -## Hierarchy - -* **BlockRange** - -## Index - -### Properties - -* [fromBlock](#fromblock) -* [toBlock](#toblock) - -## Properties - -### fromBlock - -• **fromBlock**: *`BlockParam`* - -*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L97)* - -___ - -### toBlock - -• **toBlock**: *`BlockParam`* - -*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L98)* - -
- -> # Interface: ContractEvent - -## Hierarchy - -* **ContractEvent** - -## Index - -### Properties - -* [address](#address) -* [args](#args) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [event](#event) -* [logIndex](#logindex) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) -* [type](#type) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L61)* - -___ - -### args - -• **args**: *[ContractEventArgs](#contracteventargs)* - -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L64)* - -___ - -### blockHash - -• **blockHash**: *string* - -*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L59)* - -___ - -### blockNumber - -• **blockNumber**: *number* - -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L60)* - -___ - -### event - -• **event**: *string* - -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L63)* - -___ - -### logIndex - -• **logIndex**: *number* - -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L56)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [types.ts:58](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L58)* - -___ - -### transactionIndex - -• **transactionIndex**: *number* - -*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L57)* - -___ - -### type - -• **type**: *string* - -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L62)* - -
- -> # 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) - -## Hierarchy - -* **ContractWrappersConfig** - -## Index - -### Properties - -* [blockPollingIntervalMs](#optional-blockpollingintervalms) -* [contractAddresses](#optional-contractaddresses) -* [gasPrice](#optional-gasprice) -* [networkId](#networkid) - -## Properties - -### `Optional` blockPollingIntervalMs - -• **blockPollingIntervalMs**? : *undefined | number* - -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L119)* - -___ - -### `Optional` contractAddresses - -• **contractAddresses**? : *`ContractAddresses`* - -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L118)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L117)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L116)* - -
- -> # Interface: CoordinatorTransaction - -## Hierarchy - -* **CoordinatorTransaction** - -## Index - -### Properties - -* [data](#data) -* [salt](#salt) -* [signerAddress](#signeraddress) - -## Properties - -### data - -• **data**: *string* - -*Defined in [types.ts:228](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L228)* - -___ - -### salt - -• **salt**: *`BigNumber`* - -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L226)* - -___ - -### signerAddress - -• **signerAddress**: *string* - -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L227)* - -
- -> # Interface: DecodedLogEvent <**ArgsType**> - -## Type parameters - -▪ **ArgsType**: *`DecodedLogArgs`* - -## Hierarchy - -* **DecodedLogEvent** - -## Index - -### Properties - -* [isRemoved](#isremoved) -* [log](#log) - -## Properties - -### isRemoved - -• **isRemoved**: *boolean* - -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L46)* - -___ - -### log - -• **log**: *`LogWithDecodedArgs`* - -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L47)* - -
- -> # Interface: IndexedFilterValues - -## Hierarchy - -* **IndexedFilterValues** - -## Indexable - -● \[▪ **index**: *string*\]: `ContractEventArg` - -
- -> # Interface: MethodOpts - -defaultBlock: The block up to which to query the blockchain state. Setting this to a historical block number -let's the user query the blockchain's state at an arbitrary point in time. In order for this to work, the -backing Ethereum node must keep the entire historical state of the chain (e.g setting `--pruning=archive` -flag when running Parity). - -## Hierarchy - -* **MethodOpts** - -## Index - -### Properties - -* [defaultBlock](#optional-defaultblock) - -## Properties - -### `Optional` defaultBlock - -• **defaultBlock**? : *`BlockParam`* - -*Defined in [types.ts:148](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L148)* - -
- -> # Interface: OrderAndTraderInfo - -## Hierarchy - -* **OrderAndTraderInfo** - -## Index - -### Properties - -* [orderInfo](#orderinfo) -* [traderInfo](#traderinfo) - -## Properties - -### orderInfo - -• **orderInfo**: *[OrderInfo](#interface-orderinfo)* - -*Defined in [types.ts:210](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L210)* - -___ - -### traderInfo - -• **traderInfo**: *[TraderInfo](#interface-traderinfo)* - -*Defined in [types.ts:211](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L211)* - -
- -> # Interface: OrderFillRequest - -## Hierarchy - -* **OrderFillRequest** - -## Index - -### Properties - -* [signedOrder](#signedorder) -* [takerAssetFillAmount](#takerassetfillamount) - -## Properties - -### signedOrder - -• **signedOrder**: *`SignedOrder`* - -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L102)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L103)* - -
- -> # Interface: OrderInfo - -## Hierarchy - -* **OrderInfo** - -## Index - -### Properties - -* [orderHash](#orderhash) -* [orderStatus](#orderstatus) -* [orderTakerAssetFilledAmount](#ordertakerassetfilledamount) - -## Properties - -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:184](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L184)* - -___ - -### orderStatus - -• **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* - -*Defined in [types.ts:183](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L183)* - -___ - -### orderTakerAssetFilledAmount - -• **orderTakerAssetFilledAmount**: *`BigNumber`* - -*Defined in [types.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L185)* - -
- -> # 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. - -## Hierarchy - -* [TransactionOpts](#interface-transactionopts) - - * **OrderTransactionOpts** - -## Index - -### Properties - -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [shouldValidate](#optional-shouldvalidate) - -## Properties - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Inherited from [TransactionOpts](#optional-gaslimit)* - -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L158)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [TransactionOpts](#optional-gasprice)* - -*Defined in [types.ts:157](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L157)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [TransactionOpts](#optional-nonce)* - -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L159)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Defined in [types.ts:167](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L167)* - -
- -> # Interface: Token - -## Hierarchy - -* **Token** - -## Index - -### Properties - -* [address](#address) -* [decimals](#decimals) -* [name](#name) -* [symbol](#symbol) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L74)* - -___ - -### decimals - -• **decimals**: *number* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L76)* - -___ - -### name - -• **name**: *string* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L73)* - -___ - -### symbol - -• **symbol**: *string* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L75)* - -
- -> # Interface: TokenAddressBySymbol - -## Hierarchy - -* **TokenAddressBySymbol** - -## Indexable - -● \[▪ **symbol**: *string*\]: string - -
- -> # Interface: TraderInfo - -## Hierarchy - -* **TraderInfo** - -## Index - -### Properties - -* [makerAllowance](#makerallowance) -* [makerBalance](#makerbalance) -* [makerZrxAllowance](#makerzrxallowance) -* [makerZrxBalance](#makerzrxbalance) -* [takerAllowance](#takerallowance) -* [takerBalance](#takerbalance) -* [takerZrxAllowance](#takerzrxallowance) -* [takerZrxBalance](#takerzrxbalance) - -## Properties - -### makerAllowance - -• **makerAllowance**: *`BigNumber`* - -*Defined in [types.ts:200](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L200)* - -___ - -### makerBalance - -• **makerBalance**: *`BigNumber`* - -*Defined in [types.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L199)* - -___ - -### makerZrxAllowance - -• **makerZrxAllowance**: *`BigNumber`* - -*Defined in [types.ts:204](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L204)* - -___ - -### makerZrxBalance - -• **makerZrxBalance**: *`BigNumber`* - -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L203)* - -___ - -### takerAllowance - -• **takerAllowance**: *`BigNumber`* - -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L202)* - -___ - -### takerBalance - -• **takerBalance**: *`BigNumber`* - -*Defined in [types.ts:201](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L201)* - -___ - -### takerZrxAllowance - -• **takerZrxAllowance**: *`BigNumber`* - -*Defined in [types.ts:206](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L206)* - -___ - -### takerZrxBalance - -• **takerZrxBalance**: *`BigNumber`* - -*Defined in [types.ts:205](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L205)* - -
- -> # Interface: TransactionOpts - -gasPrice: Gas price in Wei to use for a transaction -gasLimit: The amount of gas to send with a transaction (in Gwei) -nonce: The nonce to use for a transaction. If not specified, it defaults to the next incremented nonce. - -## Hierarchy - -* **TransactionOpts** - - * [OrderTransactionOpts](#interface-ordertransactionopts) - -## Index - -### Properties - -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) - -## Properties - -### `Optional` gasLimit - -• **gasLimit**? : *undefined | number* - -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L158)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [types.ts:157](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L157)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L159)* - -
- -> # Interface: TxOpts - -## Hierarchy - -* **TxOpts** - -## Index - -### Properties - -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [value](#optional-value) - -## Properties - -### from - -• **from**: *string* - -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L80)* - -___ - -### `Optional` gas - -• **gas**? : *undefined | number* - -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L81)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L83)* - -___ - -### `Optional` value - -• **value**? : *`BigNumber`* - -*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L82)* - -
- -> # Interface: ValidateOrderFillableOpts - -`expectedFillTakerTokenAmount`: If specified, the validation method will ensure that the supplied order maker has a sufficient - allowance/balance to fill this amount of the order's takerTokenAmount. - -`validateRemainingOrderAmountIsFillable`: The validation method ensures that the maker has sufficient allowance/balance to fill - the entire remaining order amount. If this option is set to false, the balances - and allowances are calculated to determine the order is fillable for a - non-zero amount (some value less than or equal to the order remaining amount). - We call such orders "partially fillable orders". Default is `true`. - -`simulationTakerAddress`: During the maker transfer simulation, tokens are sent from the maker to the `simulationTakerAddress`. This defaults - to the `takerAddress` specified in the order. Some tokens prevent transfer to the NULL address so this address can be specified. - -## Hierarchy - -* **ValidateOrderFillableOpts** - -## Index - -### Properties - -* [expectedFillTakerTokenAmount](#optional-expectedfilltakertokenamount) -* [simulationTakerAddress](#optional-simulationtakeraddress) -* [validateRemainingOrderAmountIsFillable](#optional-validateremainingorderamountisfillable) - -## Properties - -### `Optional` expectedFillTakerTokenAmount - -• **expectedFillTakerTokenAmount**? : *`BigNumber`* - -*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L136)* - -___ - -### `Optional` simulationTakerAddress - -• **simulationTakerAddress**? : *undefined | string* - -*Defined in [types.ts:138](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L138)* - -___ - -### `Optional` validateRemainingOrderAmountIsFillable - -• **validateRemainingOrderAmountIsFillable**? : *undefined | false | true* - -*Defined in [types.ts:137](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L137)* - -
- -> # Interface: CoordinatorOutstandingFillSignatures - -## Hierarchy - -* **CoordinatorOutstandingFillSignatures** - -## Index - -### Properties - -* [approvalSignatures](#approvalsignatures) -* [expirationTimeSeconds](#expirationtimeseconds) -* [orderHash](#orderhash) -* [takerAssetFillAmount](#takerassetfillamount) - -## Properties - -### approvalSignatures - -• **approvalSignatures**: *string[]* - -*Defined in [utils/coordinator_server_types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L19)* - -___ - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Defined in [utils/coordinator_server_types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L20)* - -___ - -### orderHash - -• **orderHash**: *string* - -*Defined in [utils/coordinator_server_types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L18)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [utils/coordinator_server_types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L21)* - -
- -> # Interface: CoordinatorServerApprovalRawResponse - -## Hierarchy - -* **CoordinatorServerApprovalRawResponse** - -## Index - -### Properties - -* [expirationTimeSeconds](#expirationtimeseconds) -* [signatures](#signatures) - -## Properties - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Defined in [utils/coordinator_server_types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L10)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Defined in [utils/coordinator_server_types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L9)* - -
- -> # Interface: CoordinatorServerApprovalResponse - -## Hierarchy - -* **CoordinatorServerApprovalResponse** - -## Index - -### Properties - -* [expirationTimeSeconds](#expirationtimeseconds) -* [signatures](#signatures) - -## Properties - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`[]* - -*Defined in [utils/coordinator_server_types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L6)* - -___ - -### signatures - -• **signatures**: *string[]* - -*Defined in [utils/coordinator_server_types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L5)* - -
- -> # Interface: CoordinatorServerCancellationResponse - -## Hierarchy - -* **CoordinatorServerCancellationResponse** - -## Index - -### Properties - -* [cancellationSignatures](#cancellationsignatures) -* [outstandingFillSignatures](#outstandingfillsignatures) - -## Properties - -### cancellationSignatures - -• **cancellationSignatures**: *string[]* - -*Defined in [utils/coordinator_server_types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L15)* - -___ - -### outstandingFillSignatures - -• **outstandingFillSignatures**: *[CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures)[]* - -*Defined in [utils/coordinator_server_types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L14)* - -
- -> # Interface: CoordinatorServerRequest - -## Hierarchy - -* **CoordinatorServerRequest** - -## Index - -### Properties - -* [signedTransaction](#signedtransaction) -* [txOrigin](#txorigin) - -## Properties - -### signedTransaction - -• **signedTransaction**: *`SignedZeroExTransaction`* - -*Defined in [utils/coordinator_server_types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L35)* - -___ - -### txOrigin - -• **txOrigin**: *string* - -*Defined in [utils/coordinator_server_types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L36)* - -
- -> # Interface: CoordinatorServerResponse - -## Hierarchy - -* **CoordinatorServerResponse** - -## Index - -### Properties - -* [body](#optional-body) -* [coordinatorOperator](#coordinatoroperator) -* [error](#optional-error) -* [isError](#iserror) -* [orders](#optional-orders) -* [request](#request) -* [status](#status) - -## Properties - -### `Optional` body - -• **body**? : *[CoordinatorServerCancellationResponse](#class-coordinatorserverapprovalrawresponse)* - -*Defined in [utils/coordinator_server_types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L27)* - -___ - -### coordinatorOperator - -• **coordinatorOperator**: *string* - -*Defined in [utils/coordinator_server_types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L30)* - -___ - -### `Optional` error - -• **error**? : *any* - -*Defined in [utils/coordinator_server_types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L28)* - -___ - -### isError - -• **isError**: *boolean* - -*Defined in [utils/coordinator_server_types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L25)* - -___ - -### `Optional` orders - -• **orders**? : *`Array`* - -*Defined in [utils/coordinator_server_types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L31)* - -___ - -### request - -• **request**: *[CoordinatorServerRequest](#class-coordinatorserverrequest)* - -*Defined in [utils/coordinator_server_types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L29)* - -___ - -### status - -• **status**: *number* - -*Defined in [utils/coordinator_server_types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [abstract/abstract_balance_and_proxy_allowance_lazy_store](modules/_abstract_abstract_balance_and_proxy_allowance_lazy_store_.md) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [contract_wrappers](modules/_contract_wrappers_.md) - * [contract_wrappers.ContractWrappers](#class-contractwrappers) - * [contract_wrappers/coordinator_wrapper](modules/_contract_wrappers_coordinator_wrapper_.md) - * [contract_wrappers/coordinator_wrapper.CoordinatorWrapper](#class-coordinatorwrapper) - * [contract_wrappers/dutch_auction_wrapper](modules/_contract_wrappers_dutch_auction_wrapper_.md) - * [contract_wrappers/dutch_auction_wrapper.DutchAuctionWrapper](#class-dutchauctionwrapper) - * [contract_wrappers/erc20_proxy_wrapper](modules/_contract_wrappers_erc20_proxy_wrapper_.md) - * [contract_wrappers/erc20_proxy_wrapper.ERC20ProxyWrapper](#class-erc20proxywrapper) - * [contract_wrappers/erc20_token_wrapper](modules/_contract_wrappers_erc20_token_wrapper_.md) - * [contract_wrappers/erc20_token_wrapper.ERC20TokenWrapper](#class-erc20tokenwrapper) - * [contract_wrappers/erc721_proxy_wrapper](modules/_contract_wrappers_erc721_proxy_wrapper_.md) - * [contract_wrappers/erc721_proxy_wrapper.ERC721ProxyWrapper](#class-erc721proxywrapper) - * [contract_wrappers/erc721_token_wrapper](modules/_contract_wrappers_erc721_token_wrapper_.md) - * [contract_wrappers/erc721_token_wrapper.ERC721TokenWrapper](#class-erc721tokenwrapper) - * [contract_wrappers/ether_token_wrapper](modules/_contract_wrappers_ether_token_wrapper_.md) - * [contract_wrappers/ether_token_wrapper.EtherTokenWrapper](#class-ethertokenwrapper) - * [contract_wrappers/exchange_wrapper](modules/_contract_wrappers_exchange_wrapper_.md) - * [contract_wrappers/exchange_wrapper.ExchangeWrapper](#class-exchangewrapper) - * [contract_wrappers/forwarder_wrapper](modules/_contract_wrappers_forwarder_wrapper_.md) - * [contract_wrappers/forwarder_wrapper.ForwarderWrapper](#class-forwarderwrapper) - * [contract_wrappers/order_validator_wrapper](modules/_contract_wrappers_order_validator_wrapper_.md) - * [contract_wrappers/order_validator_wrapper.OrderValidatorWrapper](#class-ordervalidatorwrapper) - * [fetchers/asset_balance_and_proxy_allowance_fetcher](modules/_fetchers_asset_balance_and_proxy_allowance_fetcher_.md) - * [fetchers/asset_balance_and_proxy_allowance_fetcher.AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher) - * [fetchers/order_filled_cancelled_fetcher](modules/_fetchers_order_filled_cancelled_fetcher_.md) - * [fetchers/order_filled_cancelled_fetcher.OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher) - * [index](modules/_index_.md) - * [schemas/contract_wrappers_config_schema](modules/_schemas_contract_wrappers_config_schema_.md) - * [schemas/method_opts_schema](modules/_schemas_method_opts_schema_.md) - * [schemas/order_tx_opts_schema](modules/_schemas_order_tx_opts_schema_.md) - * [schemas/tx_opts_schema](modules/_schemas_tx_opts_schema_.md) - * [schemas/validate_order_fillable_opts_schema](modules/_schemas_validate_order_fillable_opts_schema_.md) - * [types](modules/_types_.md) - * [types.ContractWrappersError](#class-contractwrapperserror) - * [types.DutchAuctionWrapperError](#class-dutchauctionwrappererror) - * [types.ExchangeWrapperError](#class-exchangewrappererror) - * [types.ForwarderWrapperError](#class-forwarderwrappererror) - * [types.InternalContractWrappersError](#class-internalcontractwrapperserror) - * [types.OrderStatus](#class-orderstatus) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.BalanceAndAllowance](#class-balanceandallowance) - * [types.BlockRange](#class-blockrange) - * [types.ContractEvent](#class-contractevent) - * [types.ContractWrappersConfig](#class-contractwrappersconfig) - * [types.CoordinatorTransaction](#class-coordinatortransaction) - * [types.DecodedLogEvent](#class-decodedlogevent) - * [types.IndexedFilterValues](#class-indexedfiltervalues) - * [types.MethodOpts](#class-methodopts) - * [types.OrderAndTraderInfo](#class-orderandtraderinfo) - * [types.OrderFillRequest](#class-orderfillrequest) - * [types.OrderInfo](#class-orderinfo) - * [types.OrderTransactionOpts](#class-ordertransactionopts) - * [types.Token](#class-token) - * [types.TokenAddressBySymbol](#class-tokenaddressbysymbol) - * [types.TraderInfo](#class-traderinfo) - * [types.TransactionOpts](#class-transactionopts) - * [types.TxOpts](#class-txopts) - * [types.ValidateOrderFillableOpts](#class-validateorderfillableopts) - * [utils/assert](modules/_utils_assert_.md) - * [utils/calldata_optimization_utils](modules/_utils_calldata_optimization_utils_.md) - * [utils/constants](modules/_utils_constants_.md) - * [utils/contract_addresses](modules/_utils_contract_addresses_.md) - * [utils/coordinator_server_types](modules/_utils_coordinator_server_types_.md) - * [utils/coordinator_server_types.CoordinatorServerErrorMsg](#class-coordinatorservererrormsg) - * [utils/coordinator_server_types.CoordinatorServerError](#class-coordinatorservererror) - * [utils/coordinator_server_types.CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures) - * [utils/coordinator_server_types.CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse) - * [utils/coordinator_server_types.CoordinatorServerApprovalResponse](#class-coordinatorserverapprovalresponse) - * [utils/coordinator_server_types.CoordinatorServerCancellationResponse](#class-coordinatorservercancellationresponse) - * [utils/coordinator_server_types.CoordinatorServerRequest](#class-coordinatorserverrequest) - * [utils/coordinator_server_types.CoordinatorServerResponse](#class-coordinatorserverresponse) - * [utils/decorators](modules/_utils_decorators_.md) - * [utils/filter_utils](modules/_utils_filter_utils_.md) - * [utils/transaction_encoder](modules/_utils_transaction_encoder_.md) - * [utils/transaction_encoder.TransactionEncoder](#class-transactionencoder) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [contract_wrappers.ContractWrappers](#class-contractwrappers) - * [contract_wrappers/coordinator_wrapper.CoordinatorWrapper](#class-coordinatorwrapper) - * [contract_wrappers/dutch_auction_wrapper.DutchAuctionWrapper](#class-dutchauctionwrapper) - * [contract_wrappers/erc20_proxy_wrapper.ERC20ProxyWrapper](#class-erc20proxywrapper) - * [contract_wrappers/erc20_token_wrapper.ERC20TokenWrapper](#class-erc20tokenwrapper) - * [contract_wrappers/erc721_proxy_wrapper.ERC721ProxyWrapper](#class-erc721proxywrapper) - * [contract_wrappers/erc721_token_wrapper.ERC721TokenWrapper](#class-erc721tokenwrapper) - * [contract_wrappers/ether_token_wrapper.EtherTokenWrapper](#class-ethertokenwrapper) - * [contract_wrappers/exchange_wrapper.ExchangeWrapper](#class-exchangewrapper) - * [contract_wrappers/forwarder_wrapper.ForwarderWrapper](#class-forwarderwrapper) - * [contract_wrappers/order_validator_wrapper.OrderValidatorWrapper](#class-ordervalidatorwrapper) - * [fetchers/asset_balance_and_proxy_allowance_fetcher.AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher) - * [fetchers/order_filled_cancelled_fetcher.OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher) - * [utils/coordinator_server_types.CoordinatorServerError](#class-coordinatorservererror) - * [utils/transaction_encoder.TransactionEncoder](#class-transactionencoder) -* [Enums]() - * [types.ContractWrappersError](#class-contractwrapperserror) - * [types.DutchAuctionWrapperError](#class-dutchauctionwrappererror) - * [types.ExchangeWrapperError](#class-exchangewrappererror) - * [types.ForwarderWrapperError](#class-forwarderwrappererror) - * [types.InternalContractWrappersError](#class-internalcontractwrapperserror) - * [types.OrderStatus](#class-orderstatus) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [utils/coordinator_server_types.CoordinatorServerErrorMsg](#class-coordinatorservererrormsg) -* [Interfaces]() - * [types.BalanceAndAllowance](#class-balanceandallowance) - * [types.BlockRange](#class-blockrange) - * [types.ContractEvent](#class-contractevent) - * [types.ContractWrappersConfig](#class-contractwrappersconfig) - * [types.CoordinatorTransaction](#class-coordinatortransaction) - * [types.DecodedLogEvent](#class-decodedlogevent) - * [types.IndexedFilterValues](#class-indexedfiltervalues) - * [types.MethodOpts](#class-methodopts) - * [types.OrderAndTraderInfo](#class-orderandtraderinfo) - * [types.OrderFillRequest](#class-orderfillrequest) - * [types.OrderInfo](#class-orderinfo) - * [types.OrderTransactionOpts](#class-ordertransactionopts) - * [types.Token](#class-token) - * [types.TokenAddressBySymbol](#class-tokenaddressbysymbol) - * [types.TraderInfo](#class-traderinfo) - * [types.TransactionOpts](#class-transactionopts) - * [types.TxOpts](#class-txopts) - * [types.ValidateOrderFillableOpts](#class-validateorderfillableopts) - * [utils/coordinator_server_types.CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures) - * [utils/coordinator_server_types.CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse) - * [utils/coordinator_server_types.CoordinatorServerApprovalResponse](#class-coordinatorserverapprovalresponse) - * [utils/coordinator_server_types.CoordinatorServerCancellationResponse](#class-coordinatorservercancellationresponse) - * [utils/coordinator_server_types.CoordinatorServerRequest](#class-coordinatorserverrequest) - * [utils/coordinator_server_types.CoordinatorServerResponse](#class-coordinatorserverresponse) - -
- diff --git a/packages/website/mdx/tools/@0x/contract-wrappers/v11.0.0/reference.mdx b/packages/website/mdx/tools/@0x/contract-wrappers/v11.0.0/reference.mdx index 7a7cc5c582..581402b87f 100644 --- a/packages/website/mdx/tools/@0x/contract-wrappers/v11.0.0/reference.mdx +++ b/packages/website/mdx/tools/@0x/contract-wrappers/v11.0.0/reference.mdx @@ -1,177 +1,19 @@ -> # Class: AbstractBalanceAndProxyAllowanceLazyStore - -## Hierarchy - -* **AbstractBalanceAndProxyAllowanceLazyStore** - -## Index - -### Methods - -* [deleteAll](#abstract-deleteall) -* [deleteBalance](#abstract-deletebalance) -* [deleteProxyAllowance](#abstract-deleteproxyallowance) -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) -* [setBalance](#abstract-setbalance) -* [setProxyAllowance](#abstract-setproxyallowance) - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* - -**Returns:** *void* - -___ - -### `Abstract` deleteBalance - -▸ **deleteBalance**(`tokenAddress`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteProxyAllowance - -▸ **deleteProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`tokenAddress`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`tokenAddress`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` setBalance - -▸ **setBalance**(`tokenAddress`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setProxyAllowance - -▸ **setProxyAllowance**(`tokenAddress`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`tokenAddress` | string | -`userAddress` | string | -`proxyAllowance` | `BigNumber` | - -**Returns:** *void* - -
- -> # Class: ContractWrappers +# Class: ContractWrappers The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. -## Hierarchy +### Hierarchy * **ContractWrappers** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Properties +\+ **new ContractWrappers**(`supportedProvider`: `SupportedProvider`, `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* -* [coordinator](#coordinator) -* [dutchAuction](#dutchauction) -* [erc20Proxy](#erc20proxy) -* [erc20Token](#erc20token) -* [erc721Proxy](#erc721proxy) -* [erc721Token](#erc721token) -* [etherToken](#ethertoken) -* [exchange](#exchange) -* [forwarder](#forwarder) -* [orderValidator](#ordervalidator) - -### Methods - -* [getAbiDecoder](#getabidecoder) -* [getProvider](#getprovider) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ContractWrappers**(`supportedProvider`: `SupportedProvider`, `config`: [ContractWrappersConfig](#class-contractwrappers)* - -*Defined in [contract_wrappers.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L83)* +*Defined in [contract_wrappers.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L76)* Instantiates a new ContractWrappers instance. @@ -186,116 +28,106 @@ Name | Type | Description | An instance of the ContractWrappers class. -## Properties +### Properties -### coordinator +## contractAddresses + +• **contractAddresses**: *`ContractAddresses`* + +*Defined in [contract_wrappers.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L39)* + +An index of the default contract addresses for this network. + +___ + +## coordinator • **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* -*Defined in [contract_wrappers.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L81)* +*Defined in [contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L74)* An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. ___ -### dutchAuction +## dutchAuction -• **dutchAuction**: *[DutchAuctionWrapper](#class-dutchauctionwrapper)* +• **dutchAuction**: *[DutchAuctionContract](#class-dutchauctioncontract)* -*Defined in [contract_wrappers.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L76)* +*Defined in [contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L70)* -An instance of the DutchAuctionWrapper class containing methods for interacting with any DutchAuction smart contract. +An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. ___ -### erc20Proxy +## erc20Proxy -• **erc20Proxy**: *[ERC20ProxyWrapper](#class-erc20proxywrapper)* +• **erc20Proxy**: *[ERC20ProxyContract](#class-erc20proxycontract)* -*Defined in [contract_wrappers.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L59)* +*Defined in [contract_wrappers.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L48)* -An instance of the ERC20ProxyWrapper class containing methods for interacting with the +An instance of the ERC20ProxyContract class containing methods for interacting with the erc20Proxy smart contract. ___ -### erc20Token +## erc721Proxy -• **erc20Token**: *[ERC20TokenWrapper](#class-erc20tokenwrapper)* +• **erc721Proxy**: *[ERC721ProxyContract](#class-erc721proxycontract)* -*Defined in [contract_wrappers.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L45)* +*Defined in [contract_wrappers.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L53)* -An instance of the ERC20TokenWrapper class containing methods for interacting with any ERC20 token smart contract. - -___ - -### erc721Proxy - -• **erc721Proxy**: *[ERC721ProxyWrapper](#class-erc721proxywrapper)* - -*Defined in [contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L64)* - -An instance of the ERC721ProxyWrapper class containing methods for interacting with the +An instance of the ERC721ProxyContract class containing methods for interacting with the erc721Proxy smart contract. ___ -### erc721Token +## exchange -• **erc721Token**: *[ERC721TokenWrapper](#class-erc721tokenwrapper)* +• **exchange**: *[ExchangeContract](#class-exchangecontract)* -*Defined in [contract_wrappers.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L49)* +*Defined in [contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L43)* -An instance of the ERC721TokenWrapper class containing methods for interacting with any ERC721 token smart contract. +An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. ___ -### etherToken +## forwarder -• **etherToken**: *[EtherTokenWrapper](#class-ethertokenwrapper)* +• **forwarder**: *[ForwarderContract](#class-forwardercontract)* -*Defined in [contract_wrappers.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L54)* +*Defined in [contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L62)* -An instance of the EtherTokenWrapper class containing methods for interacting with the -wrapped ETH ERC20 token smart contract. +An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. ___ -### exchange +## orderValidator -• **exchange**: *[ExchangeWrapper](#class-exchangewrapper)* +• **orderValidator**: *[OrderValidatorContract](#class-ordervalidatorcontract)* -*Defined in [contract_wrappers.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L41)* +*Defined in [contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L66)* -An instance of the ExchangeWrapper class containing methods for interacting with the 0x Exchange smart contract. +An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. ___ -### forwarder +## weth9 -• **forwarder**: *[ForwarderWrapper](#class-forwarderwrapper)* +• **weth9**: *[WETH9Contract](#class-weth9contract)* -*Defined in [contract_wrappers.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L68)* +*Defined in [contract_wrappers.ts:58](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L58)* -An instance of the ForwarderWrapper class containing methods for interacting with any Forwarder smart contract. +An instance of the WETH9Contract class containing methods for interacting with the +WETH9 smart contract. -___ +### Methods -### orderValidator - -• **orderValidator**: *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -*Defined in [contract_wrappers.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L72)* - -An instance of the OrderValidatorWrapper class containing methods for interacting with any OrderValidator smart contract. - -## Methods - -### getAbiDecoder +## getAbiDecoder ▸ **getAbiDecoder**(): *`AbiDecoder`* -*Defined in [contract_wrappers.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L179)* +*Defined in [contract_wrappers.ts:145](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L145)* Get the abi decoder instance currently used by contract-wrappers @@ -305,11 +137,11 @@ AbiDecoder instance ___ -### getProvider +## getProvider ▸ **getProvider**(): *`SupportedProvider`* -*Defined in [contract_wrappers.ts:172](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L172)* +*Defined in [contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L138)* Get the provider instance currently used by contract-wrappers @@ -319,11 +151,11 @@ Web3 provider instance ___ -### unsubscribeAll +## unsubscribeAll ▸ **unsubscribeAll**(): *void* -*Defined in [contract_wrappers.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers.ts#L162)* +*Defined in [contract_wrappers.ts:128](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/contract_wrappers.ts#L128)* Unsubscribes from all subscriptions for all contracts. @@ -331,56 +163,23 @@ Unsubscribes from all subscriptions for all contracts.
-> # Class: CoordinatorWrapper +# Class: CoordinatorWrapper This class includes all the functionality related to filling or cancelling orders through the 0x V2 Coordinator extension contract. -## Hierarchy +### Hierarchy * **CoordinatorWrapper** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [exchangeAddress](#exchangeaddress) -* [networkId](#networkid) -* [registryAddress](#registryaddress) - -### Methods - -* [assertValidCoordinatorApprovalsOrThrowAsync](#assertvalidcoordinatorapprovalsorthrowasync) -* [batchFillOrKillOrdersAsync](#batchfillorkillordersasync) -* [batchFillOrdersAsync](#batchfillordersasync) -* [batchFillOrdersNoThrowAsync](#batchfillordersnothrowasync) -* [batchHardCancelOrdersAsync](#batchhardcancelordersasync) -* [batchSoftCancelOrdersAsync](#batchsoftcancelordersasync) -* [fillOrKillOrderAsync](#fillorkillorderasync) -* [fillOrderAsync](#fillorderasync) -* [fillOrderNoThrowAsync](#fillordernothrowasync) -* [getSignerAddressAsync](#getsigneraddressasync) -* [hardCancelOrderAsync](#hardcancelorderasync) -* [hardCancelOrdersUpToAsync](#hardcancelordersuptoasync) -* [marketBuyOrdersAsync](#marketbuyordersasync) -* [marketBuyOrdersNoThrowAsync](#marketbuyordersnothrowasync) -* [marketSellOrdersAsync](#marketsellordersasync) -* [marketSellOrdersNoThrowAsync](#marketsellordersnothrowasync) -* [softCancelOrderAsync](#softcancelorderasync) - -## Constructors - -### constructor +## constructer \+ **new CoordinatorWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* -*Defined in [contract_wrappers/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L43)* +*Defined in [coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* Instantiate CoordinatorWrapper @@ -396,53 +195,53 @@ Name | Type | Description | **Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* -## Properties +### Properties -### abi +## abi • **abi**: *`ContractAbi`* = Coordinator.compilerOutput.abi -*Defined in [contract_wrappers/coordinator_wrapper.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L33)* +*Defined in [coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* ___ -### address +## address • **address**: *string* -*Defined in [contract_wrappers/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L35)* +*Defined in [coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* ___ -### exchangeAddress +## exchangeAddress • **exchangeAddress**: *string* -*Defined in [contract_wrappers/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L36)* +*Defined in [coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [contract_wrappers/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L34)* +*Defined in [coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* ___ -### registryAddress +## registryAddress • **registryAddress**: *string* -*Defined in [contract_wrappers/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L37)* +*Defined in [coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* -## Methods +### Methods -### assertValidCoordinatorApprovalsOrThrowAsync +## assertValidCoordinatorApprovalsOrThrowAsync ▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:582](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L582)* +*Defined in [coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -461,11 +260,11 @@ Name | Type | Description | ___ -### batchFillOrKillOrdersAsync +## batchFillOrKillOrdersAsync ▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:248](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L248)* +*Defined in [coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. @@ -484,11 +283,11 @@ Transaction hash. ___ -### batchFillOrdersAsync +## batchFillOrdersAsync ▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L190)* +*Defined in [coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -512,11 +311,11 @@ Transaction hash. ___ -### batchFillOrdersNoThrowAsync +## batchFillOrdersNoThrowAsync ▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:219](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L219)* +*Defined in [coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* No throw version of batchFillOrdersAsync @@ -535,11 +334,11 @@ Transaction hash. ___ -### batchHardCancelOrdersAsync +## batchHardCancelOrdersAsync ▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:513](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L513)* +*Defined in [coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -557,11 +356,11 @@ Transaction hash. ___ -### batchSoftCancelOrdersAsync +## batchSoftCancelOrdersAsync ▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L427)* +*Defined in [coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* Batch version of softCancelOrderAsync. Requests multiple soft cancels @@ -577,11 +376,11 @@ CoordinatorServerCancellationResponse. See [Cancellation Response](https://githu ___ -### fillOrKillOrderAsync +## fillOrKillOrderAsync ▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L158)* +*Defined in [coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -601,11 +400,11 @@ Transaction hash. ___ -### fillOrderAsync +## fillOrderAsync ▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L103)* +*Defined in [coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -628,11 +427,11 @@ Transaction hash. ___ -### fillOrderNoThrowAsync +## fillOrderNoThrowAsync ▸ **fillOrderNoThrowAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:130](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L130)* +*Defined in [coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -651,11 +450,11 @@ Transaction hash. ___ -### getSignerAddressAsync +## getSignerAddressAsync ▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:614](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L614)* +*Defined in [coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* Recovers the address of a signer given a hash and signature. @@ -672,11 +471,11 @@ Signer address. ___ -### hardCancelOrderAsync +## hardCancelOrderAsync ▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:481](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L481)* +*Defined in [coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* Cancels an order on-chain by submitting an Ethereum transaction. @@ -693,11 +492,11 @@ Transaction hash. ___ -### hardCancelOrdersUpToAsync +## hardCancelOrdersUpToAsync ▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:548](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L548)* +*Defined in [coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -717,11 +516,11 @@ Transaction hash. ___ -### marketBuyOrdersAsync +## marketBuyOrdersAsync ▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:282](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L282)* +*Defined in [coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -745,11 +544,11 @@ Transaction hash. ___ -### marketBuyOrdersNoThrowAsync +## marketBuyOrdersNoThrowAsync ▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:341](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L341)* +*Defined in [coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* No throw version of marketBuyOrdersAsync @@ -768,11 +567,11 @@ Transaction hash. ___ -### marketSellOrdersAsync +## marketSellOrdersAsync ▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:314](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L314)* +*Defined in [coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -796,11 +595,11 @@ Transaction hash. ___ -### marketSellOrdersNoThrowAsync +## marketSellOrdersNoThrowAsync ▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:368](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L368)* +*Defined in [coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* No throw version of marketSellOrdersAsync @@ -819,11 +618,11 @@ Transaction hash. ___ -### softCancelOrderAsync +## softCancelOrderAsync ▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* -*Defined in [contract_wrappers/coordinator_wrapper.ts:392](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/coordinator_wrapper.ts#L392)* +*Defined in [coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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. @@ -841,409 +640,97 @@ CoordinatorServerCancellationResponse. See [Cancellation Response](https://githu
-> # Class: DutchAuctionWrapper +# Class: AssetProxyOwnerContract -## Hierarchy +### Hierarchy -* **DutchAuctionWrapper** +* `BaseContract` + + * **AssetProxyOwnerContract** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Properties +\+ **new AssetProxyOwnerContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[AssetProxyOwnerContract](#class-assetproxyownercontract)* -* [abi](#abi) -* [address](#address) +*Overrides void* -### Methods - -* [getAuctionDetailsAsync](#getauctiondetailsasync) -* [matchOrdersAsync](#matchordersasync) -* [decodeDutchAuctionData](#static-decodedutchauctiondata) -* [encodeDutchAuctionAssetData](#static-encodedutchauctionassetdata) - -## Constructors - -### constructor - -\+ **new DutchAuctionWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[DutchAuctionWrapper](#class-dutchauctionwrapper)* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L49)* - -Instantiate DutchAuctionWrapper +*Defined in [generated-wrappers/asset_proxy_owner.ts:4052](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L4052)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Dutch Auction contract. If undefined, will default to the known address corresponding to the networkId. | +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | -**Returns:** *[DutchAuctionWrapper](#class-dutchauctionwrapper)* +**Returns:** *[AssetProxyOwnerContract](#class-assetproxyownercontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* -## Properties -### abi -• **abi**: *`ContractAbi`* = DutchAuction.compilerOutput.abi -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L18)* ___ -### address +## address • **address**: *string* -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L19)* -## Methods -### getAuctionDetailsAsync -▸ **getAuctionDetailsAsync**(`sellOrder`: `SignedOrder`): *`Promise`* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L131)* - -Fetches the Auction Details for the given order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`sellOrder` | `SignedOrder` | The Seller's order. This order is for the lowest amount (at the end of the auction). | - -**Returns:** *`Promise`* - -The dutch auction details. ___ -### matchOrdersAsync +## constructerArgs -▸ **matchOrdersAsync**(`buyOrder`: `SignedOrder`, `sellOrder`: `SignedOrder`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +• **constructorArgs**: *any[]* -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L77)* -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. -**Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`buyOrder` | `SignedOrder` | - | The Buyer's order. This order is for the current expected price of the auction. | -`sellOrder` | `SignedOrder` | - | The Seller's order. This order is for the lowest amount (at the end of the auction). | -`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 } | - | - -**Returns:** *`Promise`* - -Transaction hash. ___ -### `Static` decodeDutchAuctionData +## contractName -▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* +• **contractName**: *string* -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L46)* -Dutch auction details are encoded with the asset data for a 0x order. This function decodes a hex -encoded assetData string, containing information both about the asset being traded and the -dutch auction. -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`dutchAuctionData` | string | Hex encoded assetData string for the asset being auctioned. | - -**Returns:** *`DutchAuctionData`* - -An object containing the auction asset, auction begin time and auction begin amount. - -___ - -### `Static` encodeDutchAuctionAssetData - -▸ **encodeDutchAuctionAssetData**(`assetData`: string, `beginTimeSeconds`: `BigNumber`, `beginAmount`: `BigNumber`): *string* - -*Defined in [contract_wrappers/dutch_auction_wrapper.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/dutch_auction_wrapper.ts#L31)* - -Dutch auction details are encoded with the asset data for a 0x order. This function produces a hex -encoded assetData string, containing information both about the asset being traded and the -dutch auction; which is usable in the makerAssetData or takerAssetData fields in a 0x order. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Hex encoded assetData string for the asset being auctioned. | -`beginTimeSeconds` | `BigNumber` | Begin time of the dutch auction. | -`beginAmount` | `BigNumber` | Starting amount being sold in the dutch auction. | - -**Returns:** *string* - -The hex encoded assetData string. - -
- -> # Class: ERC20ProxyWrapper - -This class includes the functionality related to interacting with the ERC20Proxy contract. - -## Hierarchy - -* **ERC20ProxyWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) ### Methods -* [getAuthorizedAddressesAsync](#getauthorizedaddressesasync) -* [getProxyIdAsync](#getproxyidasync) -* [isAuthorizedAsync](#isauthorizedasync) +## getLogsAsync -## Constructors +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [AssetProxyOwnerEvents](#enumeration-assetproxyownerevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -### constructor - -\+ **new ERC20ProxyWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[ERC20ProxyWrapper](#class-erc20proxywrapper)* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L18)* - -Instantiate ERC20ProxyWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`networkId` | number | Desired networkId | -`address?` | undefined \| string | The address of the ERC20Proxy contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[ERC20ProxyWrapper](#class-erc20proxywrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = ERC20Proxy.compilerOutput.abi - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L15)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L16)* - -## Methods - -### getAuthorizedAddressesAsync - -▸ **getAuthorizedAddressesAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L61)* - -Get the list of all Exchange contract addresses authorized by the ERC20Proxy contract. - -**Returns:** *`Promise`* - -The list of authorized addresses. - -___ - -### getProxyIdAsync - -▸ **getProxyIdAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L39)* - -Get the 4 bytes ID of this asset proxy - -**Returns:** *`Promise`* - -Proxy id - -___ - -### isAuthorizedAsync - -▸ **isAuthorizedAsync**(`exchangeContractAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/erc20_proxy_wrapper.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_proxy_wrapper.ts#L51)* - -Check if the Exchange contract address is authorized by the ERC20Proxy contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeContractAddress` | string | The hex encoded address of the Exchange contract to call. | - -**Returns:** *`Promise`* - -Whether the exchangeContractAddress is authorized. - -
- -> # Class: ERC20TokenWrapper - -This class includes all the functionality related to interacting with ERC20 token contracts. -All ERC20 method calls are supported, along with some convenience methods for getting/setting allowances -to the 0x ERC20 Proxy smart contract. - -## Hierarchy - -* **ERC20TokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [UNLIMITED_ALLOWANCE_IN_BASE_UNITS](#unlimited_allowance_in_base_units) -* [abi](#abi) - -### Methods - -* [getAllowanceAsync](#getallowanceasync) -* [getBalanceAsync](#getbalanceasync) -* [getLogsAsync](#getlogsasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) -* [setAllowanceAsync](#setallowanceasync) -* [setProxyAllowanceAsync](#setproxyallowanceasync) -* [setUnlimitedAllowanceAsync](#setunlimitedallowanceasync) -* [setUnlimitedProxyAllowanceAsync](#setunlimitedproxyallowanceasync) -* [subscribe](#subscribe) -* [transferAsync](#transferasync) -* [transferFromAsync](#transferfromasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ERC20TokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc20ProxyWrapper`: [ERC20ProxyWrapper](#class-erc20tokenwrapper)* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L38)* - -Instantiate ERC20TokenWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc20ProxyWrapper` | [ERC20ProxyWrapper](#class-erc20proxywrapper) | The ERC20ProxyWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[ERC20TokenWrapper](#class-erc20tokenwrapper)* - -## Properties - -### UNLIMITED_ALLOWANCE_IN_BASE_UNITS - -• **UNLIMITED_ALLOWANCE_IN_BASE_UNITS**: *`BigNumber`* = constants.UNLIMITED_ALLOWANCE_IN_BASE_UNITS - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L33)* - -___ - -### abi - -• **abi**: *`ContractAbi`* = ERC20Token.compilerOutput.abi - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L32)* - -## Methods - -### getAllowanceAsync - -▸ **getAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:155](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L155)* - -Retrieves the owners allowance in baseUnits set to the spender's address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose allowance to spenderAddress you would like to retrieve. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who can spend the allowance you are fetching. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -___ - -### getBalanceAsync - -▸ **getBalanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L61)* - -Retrieves an owner's ERC20 token balance. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose balance you would like to check. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The owner's ERC20 token balance in base units. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC20TokenEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L409)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:4036](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L4036)* Gets historical logs without creating a subscription **Type parameters:** -▪ **ArgsType**: *`ERC20TokenEventArgs`* +▪ **ArgsType**: *[AssetProxyOwnerEventArgs](#assetproxyownereventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`tokenAddress` | string | An address of the token that emitted the logs. | -`eventName` | `ERC20TokenEvents` | The token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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}` | +`eventName` | [AssetProxyOwnerEvents](#enumeration-assetproxyownerevents) | The AssetProxyOwner 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>>`* @@ -1251,147 +738,27 @@ Array of logs that match the parameters ___ -### getProxyAllowanceAsync +## subscribe -▸ **getProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +▸ **subscribe**<**ArgsType**>(`eventName`: [AssetProxyOwnerEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [contract_wrappers/erc20_token_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L188)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:3994](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3994)* -Retrieves the owner's allowance in baseUnits set to the 0x proxy contract. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose proxy contract allowance we are retrieving. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -___ - -### setAllowanceAsync - -▸ **setAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L91)* - -Sets the spender's allowance to a specified number of baseUnits on behalf of the owner address. -Equivalent to the ERC20 spec method `approve`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who would like to set an allowance for spenderAddress. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who will be able to spend the set allowance. | -`amountInBaseUnits` | `BigNumber` | - | The allowance amount you would like to set. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyAllowanceAsync - -▸ **setProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L207)* - -Sets the 0x proxy contract's allowance to a specified number of a tokens' baseUnits on behalf -of an owner address. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who is setting an allowance for the Proxy contract. | -`amountInBaseUnits` | `BigNumber` | - | The allowance amount specified in baseUnits. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setUnlimitedAllowanceAsync - -▸ **setUnlimitedAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `spenderAddress`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L132)* - -Sets the spender's allowance to an unlimited number of baseUnits on behalf of the owner address. -Equivalent to the ERC20 spec method `approve`. -Setting an unlimited allowance will lower the gas cost for filling orders involving tokens that forego updating -allowances set to the max amount (e.g ZRX, WETH) - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who would like to set an allowance for spenderAddress. | -`spenderAddress` | string | - | The hex encoded user Ethereum address who will be able to spend the set allowance. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setUnlimitedProxyAllowanceAsync - -▸ **setUnlimitedProxyAllowanceAsync**(`tokenAddress`: string, `ownerAddress`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:234](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L234)* - -Sets the 0x proxy contract's allowance to a unlimited number of a tokens' baseUnits on behalf -of an owner address. -Setting an unlimited allowance will lower the gas cost for filling orders involving tokens that forego updating -allowances set to the max amount (e.g ZRX, WETH) - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address who is setting an allowance for the Proxy contract. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC20TokenEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:363](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L363)* - -Subscribe to an event type emitted by the Token contract. +Subscribe to an event type emitted by the AssetProxyOwner contract. **Type parameters:** -▪ **ArgsType**: *`ERC20TokenEventArgs`* +▪ **ArgsType**: *[AssetProxyOwnerEventArgs](#assetproxyownereventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded address where the ERC20 token is deployed. | -`eventName` | `ERC20TokenEvents` | - | The token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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}` | +`eventName` | [AssetProxyOwnerEvents](#enumeration-assetproxyownerevents) | - | The AssetProxyOwner 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* @@ -1399,62 +766,11 @@ Subscription token used later to unsubscribe ___ -### transferAsync - -▸ **transferAsync**(`tokenAddress`: string, `fromAddress`: string, `toAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:256](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L256)* - -Transfers `amountInBaseUnits` ERC20 tokens from `fromAddress` to `toAddress`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`fromAddress` | string | - | The hex encoded user Ethereum address that will send the funds. | -`toAddress` | string | - | The hex encoded user Ethereum address that will receive the funds. | -`amountInBaseUnits` | `BigNumber` | - | The amount (specified in baseUnits) of the token to transfer. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### transferFromAsync - -▸ **transferFromAsync**(`tokenAddress`: string, `fromAddress`: string, `toAddress`: string, `senderAddress`: string, `amountInBaseUnits`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc20_token_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L305)* - -Transfers `amountInBaseUnits` ERC20 tokens from `fromAddress` to `toAddress`. -Requires the fromAddress to have sufficient funds and to have approved an allowance of -`amountInBaseUnits` to `senderAddress`. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC20 token is deployed. | -`fromAddress` | string | - | The hex encoded user Ethereum address whose funds are being sent. | -`toAddress` | string | - | The hex encoded user Ethereum address that will receive the funds. | -`senderAddress` | string | - | The hex encoded user Ethereum address whose initiates the fund transfer. The `fromAddress` must have set an allowance to the `senderAddress` before this call. | -`amountInBaseUnits` | `BigNumber` | - | The amount (specified in baseUnits) of the token to transfer. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### unsubscribe +## unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [contract_wrappers/erc20_token_wrapper.ts:390](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L390)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:4019](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L4019)* Cancel a subscription @@ -1468,240 +784,3920 @@ Name | Type | Description | ___ -### unsubscribeAll +## unsubscribeAll ▸ **unsubscribeAll**(): *void* -*Defined in [contract_wrappers/erc20_token_wrapper.ts:397](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts#L397)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:4025](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L4025)* Cancels all existing subscriptions **Returns:** *void* -
+___ -> # Class: ERC721ProxyWrapper +## `Static` ABI -This class includes the functionality related to interacting with the ERC721Proxy contract. +▸ **ABI**(): *`ContractAbi`* -## Hierarchy +*Defined in [generated-wrappers/asset_proxy_owner.ts:3282](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3282)* -* **ERC721ProxyWrapper** +**Returns:** *`ContractAbi`* -## Index +The contract ABI -### Constructors +___ -* [constructor](#constructor) +## `Static` deployAsync -### Properties +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_owners`: string[], `_assetProxyContracts`: string[], `_required`: `BigNumber`, `_secondsTimeLocked`: `BigNumber`): *`Promise`* -* [abi](#abi) -* [address](#address) +*Defined in [generated-wrappers/asset_proxy_owner.ts:3232](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3232)* -### Methods +**Parameters:** -* [getAuthorizedAddressesAsync](#getauthorizedaddressesasync) -* [getProxyIdAsync](#getproxyidasync) -* [isAuthorizedAsync](#isauthorizedasync) +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_owners` | string[] | +`_assetProxyContracts` | string[] | +`_required` | `BigNumber` | +`_secondsTimeLocked` | `BigNumber` | -## Constructors +**Returns:** *`Promise`* -### constructor +___ -\+ **new ERC721ProxyWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[ERC721ProxyWrapper](#class-erc721proxywrapper)* +## `Static` deployFrom0xArtifactAsync -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L18)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_owners`: string[], `_assetProxyContracts`: string[], `_required`: `BigNumber`, `_secondsTimeLocked`: `BigNumber`): *`Promise`* -Instantiate ERC721ProxyWrapper +*Defined in [generated-wrappers/asset_proxy_owner.ts:3193](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3193)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_owners` | string[] | +`_assetProxyContracts` | string[] | +`_required` | `BigNumber` | +`_secondsTimeLocked` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## MAX_OWNER_COUNT + +## ▪ **MAX_OWNER_COUNT**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2709](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2709)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2715](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2715)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2763](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2763)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2756](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2756)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2751](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2751)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## addOwner + +## ▪ **addOwner**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1182](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1182)* + +Allows to add a new owner. Transaction has to be sent by wallet. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`owner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1218](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1218)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`networkId` | number | Desired networkId | -`address?` | undefined \| string | The address of the ERC721Proxy contract. If undefined, will default to the known address corresponding to the networkId. | +`owner` | string | Address of new owner. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | -**Returns:** *[ERC721ProxyWrapper](#class-erc721proxywrapper)* +**Returns:** *`PromiseWithTransactionHash`* -## Properties +A promise that resolves when the transaction is successful -### abi +## callAsync -• **abi**: *`ContractAbi`* = ERC721Proxy.compilerOutput.abi +▸ **callAsync**(`owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L15)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:1270](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1270)* -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L16)* - -## Methods - -### getAuthorizedAddressesAsync - -▸ **getAuthorizedAddressesAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L61)* - -Get the list of all Exchange contract addresses authorized by the ERC721Proxy contract. - -**Returns:** *`Promise`* - -The list of authorized addresses. - -___ - -### getProxyIdAsync - -▸ **getProxyIdAsync**(): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L39)* - -Get the 4 bytes ID of this asset proxy - -**Returns:** *`Promise`* - -Proxy id - -___ - -### isAuthorizedAsync - -▸ **isAuthorizedAsync**(`exchangeContractAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/erc721_proxy_wrapper.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_proxy_wrapper.ts#L51)* - -Check if the Exchange contract address is authorized by the ERC721Proxy contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeContractAddress` | string | The hex encoded address of the Exchange contract to call. | - -**Returns:** *`Promise`* - -Whether the exchangeContractAddress is authorized. - -
- -> # Class: ERC721TokenWrapper - -This class includes all the functionality related to interacting with ERC721 token contracts. -All ERC721 method calls are supported, along with some convenience methods for getting/setting allowances -to the 0x ERC721 Proxy smart contract. - -## Hierarchy - -* **ERC721TokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) - -### Methods - -* [getApprovedIfExistsAsync](#getapprovedifexistsasync) -* [getLogsAsync](#getlogsasync) -* [getOwnerOfAsync](#getownerofasync) -* [getTokenCountAsync](#gettokencountasync) -* [isApprovedForAllAsync](#isapprovedforallasync) -* [isProxyApprovedAsync](#isproxyapprovedasync) -* [isProxyApprovedForAllAsync](#isproxyapprovedforallasync) -* [setApprovalAsync](#setapprovalasync) -* [setApprovalForAllAsync](#setapprovalforallasync) -* [setProxyApprovalAsync](#setproxyapprovalasync) -* [setProxyApprovalForAllAsync](#setproxyapprovalforallasync) -* [subscribe](#subscribe) -* [transferFromAsync](#transferfromasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor - -\+ **new ERC721TokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc721ProxyWrapper`: [ERC721ProxyWrapper](#class-erc721tokenwrapper)* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L37)* - -Instantiate ERC721TokenWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc721ProxyWrapper` | [ERC721ProxyWrapper](#class-erc721proxywrapper) | The ERC721ProxyWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[ERC721TokenWrapper](#class-erc721tokenwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = ERC721Token.compilerOutput.abi - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L32)* - -## Methods - -### getApprovedIfExistsAsync - -▸ **getApprovedIfExistsAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L170)* - -Get the approved address for a single NFT. Returns undefined if no approval was set -Throws if `_tokenId` is not a valid NFT +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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 hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`owner` | string | - | Address of new owner. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -The approved address for this NFT, or the undefined if there is none +## estimateGasAsync -___ +▸ **estimateGasAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* -### getLogsAsync +*Defined in [generated-wrappers/asset_proxy_owner.ts:1245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1245)* -▸ **getLogsAsync**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC721TokenEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:436](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L436)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`ERC721TokenEventArgs`* +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`tokenAddress` | string | An address of the token that emitted the logs. | -`eventName` | `ERC721TokenEvents` | The token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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}` | +`owner` | string | Address of new owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1321](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1321)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1314](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1314)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`owner`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1308](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1308)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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 | Address of new owner. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1190)* + +Sends an 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 | Address of new owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1328](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1328)* + +**Parameters:** + +Name | Type | +------ | ------ | +`owner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## changeRequirement + +## ▪ **changeRequirement**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2098](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2098)* + +Allows to change the number of required confirmations. Transaction has to be sent by wallet. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_required`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2134](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2134)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_required` | `BigNumber` | Number of required confirmations. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`_required`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2186)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_required` | `BigNumber` | - | Number of required confirmations. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_required`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2161)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_required` | `BigNumber` | Number of required confirmations. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2241](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2241)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2234](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2234)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_required`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2228](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2228)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_required` | `BigNumber` | Number of required confirmations. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_required`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2106)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_required` | `BigNumber` | Number of required confirmations. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_required`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2248](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2248)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_required` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## changeTimeLock + +## ▪ **changeTimeLock**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1411)* + +Changes the duration of the time lock for transactions. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_secondsTimeLocked`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1452](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1452)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_secondsTimeLocked` | `BigNumber` | Duration needed after a transaction is confirmed and before it becomes executable, in seconds. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`_secondsTimeLocked`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1506](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1506)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_secondsTimeLocked` | `BigNumber` | - | Duration needed after a transaction is confirmed and before it becomes executable, in seconds. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_secondsTimeLocked`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1480](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1480)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_secondsTimeLocked` | `BigNumber` | Duration needed after a transaction is confirmed and before it becomes executable, in seconds. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1564](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1564)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1557](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1557)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_secondsTimeLocked`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1549](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1549)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_secondsTimeLocked` | `BigNumber` | Duration needed after a transaction is confirmed and before it becomes executable, in seconds. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_secondsTimeLocked`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1420](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1420)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_secondsTimeLocked` | `BigNumber` | Duration needed after a transaction is confirmed and before it becomes executable, in seconds. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_secondsTimeLocked`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1571](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1571)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_secondsTimeLocked` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## confirmTransaction + +## ▪ **confirmTransaction**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2260](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2260)* + +Allows an owner to confirm a transaction. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2296](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2296)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2348)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2323](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2323)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2405](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2405)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2398](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2398)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2390](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2390)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2268](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2268)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2412](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2412)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactionId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## confirmationTimes + +## ▪ **confirmationTimes**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2641](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2641)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2647](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2647)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2701](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2701)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2694](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2694)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2688](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2688)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## confirmations + +## ▪ **confirmations**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:577](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L577)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:583](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L583)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`index_1` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:646](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L646)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:639](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L639)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`, `index_1`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:629](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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 | +------ | ------ | +`index_0` | `BigNumber` | +`index_1` | string | + +**Returns:** *string* + +___ + +## executeRemoveAuthorizedAddressAtIndex + +## ▪ **executeRemoveAuthorizedAddressAtIndex**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:657](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L657)* + +Allows execution of `removeAuthorizedAddressAtIndex` without time lock. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:695](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L695)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:752](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L752)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:725](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L725)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:812](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L812)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:805](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L805)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:796](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:665](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L665)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:819](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L819)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactionId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## executeTransaction + +## ▪ **executeTransaction**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3031](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3031)* + +Allows anyone to execute a confirmed transaction. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3067](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3067)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3119)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3094](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3094)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3176](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3176)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3169](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3169)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3161)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3039](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3039)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3183](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3183)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactionId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## getConfirmationCount + +## ▪ **getConfirmationCount**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1653](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1653)* + +Returns number of confirmations of a transaction. + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1661](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1661)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Number of confirmations. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1718](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1718)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1711](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1711)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1703](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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 | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +___ + +## getConfirmations + +## ▪ **getConfirmations**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1962](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1962)* + +Returns array with owner addresses, which confirmed transaction. + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1970](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1970)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Returns array of owner addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2025](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2025)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2018](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2018)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2012](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2012)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +___ + +## getOwners + +## ▪ **getOwners**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1799](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1799)* + +Returns list of owners. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1806](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1806)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +List of owner addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1854](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1854)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1847](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1847)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1842](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1842)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## getTransactionCount + +## ▪ **getTransactionCount**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:896](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L896)* + +Returns total number of transactions after filers are applied. + +## callAsync + +▸ **callAsync**(`pending`: boolean, `executed`: boolean, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:905](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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 | Description | +------ | ------ | ------ | ------ | +`pending` | boolean | - | Include pending transactions. | +`executed` | boolean | - | Include executed transactions. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Total number of transactions after filters are applied. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:967](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L967)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:960](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L960)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`pending`: boolean, `executed`: boolean): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:950](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L950)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`pending` | boolean | Include pending transactions. | +`executed` | boolean | Include executed transactions. | + +**Returns:** *string* + +___ + +## getTransactionIds + +## ▪ **getTransactionIds**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1865](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1865)* + +Returns list of transaction IDs in defined range. + +## callAsync + +▸ **callAsync**(`from`: `BigNumber`, `to`: `BigNumber`, `pending`: boolean, `executed`: boolean, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1876](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1876)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | `BigNumber` | - | Index start position of transaction array. | +`to` | `BigNumber` | - | Index end position of transaction array. | +`pending` | boolean | - | Include pending transactions. | +`executed` | boolean | - | Include executed transactions. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Returns array of transaction IDs. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1951](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1951)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1944](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1944)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`from`: `BigNumber`, `to`: `BigNumber`, `pending`: boolean, `executed`: boolean): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1932](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1932)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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` | `BigNumber` | Index start position of transaction array. | +`to` | `BigNumber` | Index end position of transaction array. | +`pending` | boolean | Include pending transactions. | +`executed` | boolean | Include executed transactions. | + +**Returns:** *string* + +___ + +## isAssetProxyRegistered + +## ▪ **isAssetProxyRegistered**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1580](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1580)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1586](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1586)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1642](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1642)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1635](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1635)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1627](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1627)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## isConfirmed + +## ▪ **isConfirmed**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1337)* + +Returns the confirmation status of a transaction. + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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 | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Confirmation status. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1400](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1400)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1393](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1393)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1387)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +___ + +## isOwner + +## ▪ **isOwner**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:509](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L509)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:515](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L515)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:569](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L569)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:562](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L562)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:556](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L556)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +___ + +## owners + +## ▪ **owners**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L120)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L126)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L180)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:173](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L173)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:167](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L167)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## registerAssetProxy + +## ▪ **registerAssetProxy**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:979](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L979)* + +Registers or deregisters an AssetProxy to be able to execute +`removeAuthorizedAddressAtIndex` without a timelock. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`assetProxyContract`: string, `isRegistered`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1025](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1025)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyContract` | string | Address of AssetProxy contract. | +`isRegistered` | boolean | Status of approval for AssetProxy 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**(`assetProxyContract`: string, `isRegistered`: boolean, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1093](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1093)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`assetProxyContract` | string | - | Address of AssetProxy contract. | +`isRegistered` | boolean | - | Status of approval for AssetProxy contract. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`assetProxyContract`: string, `isRegistered`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1059](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1059)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyContract` | string | Address of AssetProxy contract. | +`isRegistered` | boolean | Status of approval for AssetProxy contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1158)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1151](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1151)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxyContract`: string, `isRegistered`: boolean): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1141](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1141)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyContract` | string | Address of AssetProxy contract. | +`isRegistered` | boolean | Status of approval for AssetProxy contract. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`assetProxyContract`: string, `isRegistered`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:988](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L988)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetProxyContract` | string | Address of AssetProxy contract. | +`isRegistered` | boolean | Status of approval for AssetProxy contract. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`assetProxyContract`: string, `isRegistered`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1165](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1165)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetProxyContract` | string | +`isRegistered` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## removeOwner + +## ▪ **removeOwner**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L191)* + +Allows to remove an owner. Transaction has to be sent by wallet. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`owner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L227)* + +Sends an Ethereum transaction and waits 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 | Address of owner. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| 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, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L279)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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 | - | Address of owner. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:254](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L254)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`owner` | string | Address of owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:332](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L332)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:325](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L325)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`owner`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:317](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L317)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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 | Address of owner. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:199](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L199)* + +Sends an 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 | Address of owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:339](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L339)* + +**Parameters:** + +Name | Type | +------ | ------ | +`owner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## replaceOwner + +## ▪ **replaceOwner**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2836](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2836)* + +Allows to replace an owner with a new owner. Transaction has to be sent by wallet. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`owner`: string, `newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2882](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2882)* + +Sends an Ethereum transaction and waits 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 | Address of owner to be replaced. | +`newOwner` | string | Address of new owner. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| 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, `newOwner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2946](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2946)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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 | - | Address of owner to be replaced. | +`newOwner` | string | - | Address of new owner. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`owner`: string, `newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2916](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2916)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`owner` | string | Address of owner to be replaced. | +`newOwner` | string | Address of new owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3011](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3011)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3004](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3004)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`owner`: string, `newOwner`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2994](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2994)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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 | Address of owner to be replaced. | +`newOwner` | string | Address of new owner. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`owner`: string, `newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2845](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2845)* + +Sends an 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 | Address of owner to be replaced. | +`newOwner` | string | Address of new owner. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`owner`: string, `newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:3018](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3018)* + +**Parameters:** + +Name | Type | +------ | ------ | +`owner` | string | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## required + +## ▪ **required**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2771](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2771)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2777](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2777)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2825](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2825)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2818](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2818)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2813](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2813)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## revokeConfirmation + +## ▪ **revokeConfirmation**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L348)* + +Allows an owner to revoke a confirmation for a transaction. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L384)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:436](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L436)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`transactionId` | `BigNumber` | - | Transaction ID. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L411)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L493)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L486)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:478](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L478)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L356)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transactionId` | `BigNumber` | Transaction ID. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`transactionId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:500](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L500)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transactionId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## secondsTimeLocked + +## ▪ **secondsTimeLocked**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:831](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L831)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:837](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L837)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:885](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L885)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:878](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L878)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:873](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L873)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## submitTransaction + +## ▪ **submitTransaction**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2424)* + +Allows an owner to submit and confirm a transaction. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`destination`: string, `value`: `BigNumber`, `data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2475](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2475)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`destination` | string | Transaction target address. | +`value` | `BigNumber` | Transaction ether value. | +`data` | string | Transaction data payload. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`destination`: string, `value`: `BigNumber`, `data`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2552](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2552)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`destination` | string | - | Transaction target address. | +`value` | `BigNumber` | - | Transaction ether value. | +`data` | string | - | Transaction data payload. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Returns transaction ID. + +## estimateGasAsync + +▸ **estimateGasAsync**(`destination`: string, `value`: `BigNumber`, `data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2513](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2513)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`destination` | string | Transaction target address. | +`value` | `BigNumber` | Transaction ether value. | +`data` | string | Transaction data payload. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2623](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2623)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2616](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2616)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`destination`: string, `value`: `BigNumber`, `data`: string): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2604](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2604)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`destination` | string | Transaction target address. | +`value` | `BigNumber` | Transaction ether value. | +`data` | string | Transaction data payload. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`destination`: string, `value`: `BigNumber`, `data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2434](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2434)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`destination` | string | Transaction target address. | +`value` | `BigNumber` | Transaction ether value. | +`data` | string | Transaction data payload. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`destination`: string, `value`: `BigNumber`, `data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2630](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2630)* + +**Parameters:** + +Name | Type | +------ | ------ | +`destination` | string | +`value` | `BigNumber` | +`data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transactionCount + +## ▪ **transactionCount**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2033](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2033)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2039](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2039)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2087](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2087)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2080](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2080)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:2075](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2075)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## transactions + +## ▪ **transactions**: *object* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1726](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1726)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, BigNumber, string, boolean]>`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1732](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1732)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise<[string, BigNumber, string, boolean]>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `BigNumber`, string, boolean]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1786](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1786)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, `BigNumber`, string, boolean]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`, string, boolean]* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1779)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, `BigNumber`, string, boolean]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:1773](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1773)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +
+ +# Class: CoordinatorContract + +### Hierarchy + +* `BaseContract` + + * **CoordinatorContract** + + +### Constructors + +## constructer + +\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorContract](#class-coordinatorcontract)* + +*Overrides void* + +*Defined in [generated-wrappers/coordinator.ts:1389](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1389)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/coordinator.ts:1095](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1095)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:1048](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1048)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:1015](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1015)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## EIP712_COORDINATOR_DOMAIN_HASH + +## ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* + +*Defined in [generated-wrappers/coordinator.ts:953](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L953)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:959](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L959)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:1007](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1007)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:1000](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1000)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/coordinator.ts:995](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.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* + +___ + +## EIP712_EXCHANGE_DOMAIN_HASH + +## ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* + +*Defined in [generated-wrappers/coordinator.ts:597](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L597)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:603](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L603)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:651](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L651)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:644](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L644)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/coordinator.ts:639](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L639)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## assertValidCoordinatorApprovals + +## ▪ **assertValidCoordinatorApprovals**: *object* + +*Defined in [generated-wrappers/coordinator.ts:663](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L663)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:678](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L678)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/coordinator.ts:779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L779)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/coordinator.ts:770](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L770)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* + +*Defined in [generated-wrappers/coordinator.ts:746](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L746)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decodeOrdersFromFillData + +## ▪ **decodeOrdersFromFillData**: *object* + +*Defined in [generated-wrappers/coordinator.ts:792](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L792)* + +Decodes the orders from Exchange calldata representing any fill method. + +## callAsync + +▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise>`* + +*Defined in [generated-wrappers/coordinator.ts:800](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L800)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise>`* + +The orders from the Exchange calldata. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [generated-wrappers/coordinator.ts:915](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L915)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`Array`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [generated-wrappers/coordinator.ts:878](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L878)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`Array`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`data`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:872](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L872)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## executeTransaction + +## ▪ **executeTransaction**: *object* + +*Defined in [generated-wrappers/coordinator.ts:281](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L281)* + +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 [generated-wrappers/coordinator.ts:359](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L359)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:460](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L460)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:408](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L408)* + +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 [generated-wrappers/coordinator.ts:561](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L561)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/coordinator.ts:552](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L552)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* + +*Defined in [generated-wrappers/coordinator.ts:528](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L528)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:297](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L297)* + +Sends an 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 [generated-wrappers/coordinator.ts:570](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L570)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transaction` | object | +`txOrigin` | string | +`transactionSignature` | string | +`approvalExpirationTimeSeconds` | `BigNumber`[] | +`approvalSignatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## getCoordinatorApprovalHash + +## ▪ **getCoordinatorApprovalHash**: *object* + +*Defined in [generated-wrappers/coordinator.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L191)* + +Calculated the EIP712 hash of the Coordinator approval mesasage using the domain separator of this contract. + +## callAsync + +▸ **callAsync**(`approval`: object, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:200](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L200)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +EIP712 hash of the Coordinator approval message with the domain separator of this contract. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:270](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L270)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:263](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L263)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`approval`: object): *string* + +*Defined in [generated-wrappers/coordinator.ts:250](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L250)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getSignerAddress + +## ▪ **getSignerAddress**: *object* + +*Defined in [generated-wrappers/coordinator.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L33)* + +Recovers the address of a signer given a hash and signature. + +## callAsync + +▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L41)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:103](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L103)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L96)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:86](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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* + +___ + +## getTransactionHash + +## ▪ **getTransactionHash**: *object* + +*Defined in [generated-wrappers/coordinator.ts:114](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L114)* + +Calculates the EIP712 hash of a 0x transaction using the domain separator of the Exchange contract. + +## callAsync + +▸ **callAsync**(`transaction`: object, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L122)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +EIP712 hash of the transaction with the domain separator of this contract. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L180)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator.ts:173](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L173)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transaction`: object): *string* + +*Defined in [generated-wrappers/coordinator.ts:165](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L165)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +
+ +# Class: CoordinatorRegistryContract + +### Hierarchy + +* `BaseContract` + + * **CoordinatorRegistryContract** + + +### Constructors + +## constructer + +\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* + +*Overrides void* + +*Defined in [generated-wrappers/coordinator_registry.ts:494](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L494)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/coordinator_registry.ts:478](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L478)* + +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>>`* @@ -1709,902 +4705,6790 @@ Array of logs that match the parameters ___ -### getOwnerOfAsync +## subscribe -▸ **getOwnerOfAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [contract_wrappers/erc721_token_wrapper.ts:88](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L88)* +*Defined in [generated-wrappers/coordinator_registry.ts:436](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L436)* -Find the owner of an NFT -NFTs assigned to zero address are considered invalid, and queries about them do throw. +Subscribe to an event type emitted by the CoordinatorRegistry contract. + +**Type parameters:** + +▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`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 [generated-wrappers/coordinator_registry.ts:461](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L461)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/coordinator_registry.ts:467](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L467)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/coordinator_registry.ts:364](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L364)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/coordinator_registry.ts:322](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L322)* + +**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/coordinator_registry.ts:291](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L291)* + +**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 + +## getCoordinatorEndpoint + +## ▪ **getCoordinatorEndpoint**: *object* + +*Defined in [generated-wrappers/coordinator_registry.ts:216](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L216)* + +Gets the endpoint for a Coordinator. + +## callAsync + +▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/coordinator_registry.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L223)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:282](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L282)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:275](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L275)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`coordinatorOperator`: string): *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L267)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## setCoordinatorEndpoint + +## ▪ **setCoordinatorEndpoint**: *object* + +*Defined in [generated-wrappers/coordinator_registry.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/coordinator_registry.ts:88](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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`): *`Promise`* + +*Defined in [generated-wrappers/coordinator_registry.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.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 | +------ | ------ | ------ | ------ | +`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/coordinator_registry.ts:115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/coordinator_registry.ts:197](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L197)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/coordinator_registry.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L190)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:182](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L182)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/coordinator_registry.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/coordinator_registry.ts:204](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L204)* + +**Parameters:** + +Name | Type | +------ | ------ | +`coordinatorEndpoint` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DevUtilsContract + +### Hierarchy + +* `BaseContract` + + * **DevUtilsContract** + + +### Constructors + +## constructer + +\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DevUtilsContract](#class-devutilscontract)* + +*Overrides void* + +*Defined in [generated-wrappers/dev_utils.ts:3129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3129)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[DevUtilsContract](#class-devutilscontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/dev_utils.ts:2349](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2349)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:2301](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2301)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:2266](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2266)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## ERC1155_PROXY_ID + +## ▪ **ERC1155_PROXY_ID**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:193](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L193)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:199](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L199)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:247](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L247)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:240](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L240)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dev_utils.ts:235](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L235)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## ERC20_PROXY_ID + +## ▪ **ERC20_PROXY_ID**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:954](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L954)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:960](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L960)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1008](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1008)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1001](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1001)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dev_utils.ts:996](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L996)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## ERC721_PROXY_ID + +## ▪ **ERC721_PROXY_ID**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1380](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1380)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1386](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1386)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1434](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1434)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1427)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1422](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1422)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## MULTI_ASSET_PROXY_ID + +## ▪ **MULTI_ASSET_PROXY_ID**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1529](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1529)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1535](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1535)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1583](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1583)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1576](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1576)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1571](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1571)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## STATIC_CALL_PROXY_ID + +## ▪ **STATIC_CALL_PROXY_ID**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:2117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2117)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:2123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2123)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2171)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2164](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2164)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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). + +**Returns:** *string* + +___ + +## decodeERC1155AssetData + +## ▪ **decodeERC1155AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1227)* + +Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* + +*Defined in [generated-wrappers/dev_utils.ts:1236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1236)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:1296](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1296)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, string, `BigNumber`[], `BigNumber`[], string]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`[], `BigNumber`[], string]* + +*Defined in [generated-wrappers/dev_utils.ts:1287](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1287)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, string, `BigNumber`[], `BigNumber`[], string]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1281](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1281)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decodeERC20AssetData + +## ▪ **decodeERC20AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1019](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1019)* + +Decode ERC-20 asset data from the format described in the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, string]>`* + +*Defined in [generated-wrappers/dev_utils.ts:1027](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.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 | Description | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20 asset. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `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 [generated-wrappers/dev_utils.ts:1082](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1082)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, string]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* + +*Defined in [generated-wrappers/dev_utils.ts:1075](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1075)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, string]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1069](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1069)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decodeERC721AssetData + +## ▪ **decodeERC721AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L33)* + +Decode ERC-721 asset data from the format described in the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, string, BigNumber]>`* + +*Defined in [generated-wrappers/dev_utils.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.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 | +------ | ------ | ------ | ------ | +`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `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 [generated-wrappers/dev_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L98)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, string, `BigNumber`]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* + +*Defined in [generated-wrappers/dev_utils.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L91)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, string, `BigNumber`]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L85)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decodeMultiAssetData + +## ▪ **decodeMultiAssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1783](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1783)* + +Decode multi-asset data from the format described in the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, BigNumber[], string[]]>`* + +*Defined in [generated-wrappers/dev_utils.ts:1791](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1791)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:1846](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1846)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, `BigNumber`[], string[]]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`[], string[]]* + +*Defined in [generated-wrappers/dev_utils.ts:1839](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1839)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, `BigNumber`[], string[]]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1833](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1833)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decodeZeroExTransactionData + +## ▪ **decodeZeroExTransactionData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L512)* + +Decodes the call data for an Exchange contract method call. + +## callAsync + +▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, Array, BigNumber[], string[]]>`* + +*Defined in [generated-wrappers/dev_utils.ts:521](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L521)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:659](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L659)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[string, `Array`, `BigNumber`[], string[]]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `Array`, `BigNumber`[], string[]]* + +*Defined in [generated-wrappers/dev_utils.ts:612](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L612)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[string, `Array`, `BigNumber`[], string[]]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`transactionData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:604](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.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 | +------ | ------ | ------ | +`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | + +**Returns:** *string* + +___ + +## encodeERC1155AssetData + +## ▪ **encodeERC1155AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1594](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1594)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1607](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1607)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant asset data describing the set of assets. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1687](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1687)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1680](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1680)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1663](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1663)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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* + +___ + +## encodeERC20AssetData + +## ▪ **encodeERC20AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:432](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L432)* + +Encode ERC-20 asset data into the format described in the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L441)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant data describing the asset. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:501](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L501)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:494](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L494)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L486)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## encodeERC721AssetData + +## ▪ **encodeERC721AssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1445)* + +Encode ERC-721 asset data into the format described in the AssetProxy specification. + +## callAsync + +▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1455](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1455)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant asset data describing the asset. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1521](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1521)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1514](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1514)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1504](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1504)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## encodeMultiAssetData + +## ▪ **encodeMultiAssetData**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:2033](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2033)* + +Encode data for multiple assets, per the AssetProxy contract specification. + +## callAsync + +▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:2043](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2043)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +AssetProxy-compliant data describing the set of assets. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2109)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2102)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2092](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2092)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getAssetProxyAllowance + +## ▪ **getAssetProxyAllowance**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1946](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1946)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1956](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1956)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dev_utils.ts:2022](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2022)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dev_utils.ts:2015](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2015)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2005](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2005)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getBalance + +## ▪ **getBalance**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:710](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L710)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:720](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 | +------ | ------ | ------ | ------ | +`ownerAddress` | string | - | Owner of the assets specified by assetData. | +`assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Number of assets (or asset baskets) held by owner. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dev_utils.ts:786](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L786)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dev_utils.ts:779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L779)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:769](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L769)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getBalanceAndAssetProxyAllowance + +## ▪ **getBalanceAndAssetProxyAllowance**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L109)* + +Calls getBalance() and getAllowance() for assetData. + +## callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[BigNumber, BigNumber]>`* + +*Defined in [generated-wrappers/dev_utils.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L119)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L185)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [generated-wrappers/dev_utils.ts:178](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L178)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | + +**Returns:** *string* + +___ + +## getBatchAssetProxyAllowances + +## ▪ **getBatchAssetProxyAllowances**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L345)* + +Calls getAssetProxyAllowance() for each element of assetData. + +## callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L355)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:421](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L421)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/dev_utils.ts:414](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L414)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:404](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L404)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getBatchBalances + +## ▪ **getBatchBalances**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1859](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1859)* + +Calls getBalance() for each element of assetData. + +## callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1869](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1869)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:1935](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1935)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/dev_utils.ts:1928](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1928)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1918](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1918)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getBatchBalancesAndAssetProxyAllowances + +## ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:2182](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2182)* + +Calls getBatchBalances() and getBatchAllowances() for each element of assetData. + +## callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[BigNumber[], BigNumber[]]>`* + +*Defined in [generated-wrappers/dev_utils.ts:2192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2192)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:2258](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2258)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [generated-wrappers/dev_utils.ts:2251](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2251)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:2241](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2241)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getERC721TokenOwner + +## ▪ **getERC721TokenOwner**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1698](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1698)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1707](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1707)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Owner of tokenId or null address if unowned. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1772](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1772)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1765](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1765)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1755)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getEthBalances + +## ▪ **getEthBalances**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1309](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1309)* + +Batch fetches ETH balances + +## callAsync + +▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:1317](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1317)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Array of ETH balances. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/dev_utils.ts:1372](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1372)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/dev_utils.ts:1365](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1365)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1359](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1359)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getOrderRelevantState + +## ▪ **getOrderRelevantState**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:1093](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1093)* + +Fetches all order-relevant information needed to validate if the supplied order is fillable. + +## callAsync + +▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[object, BigNumber, boolean]>`* + +*Defined in [generated-wrappers/dev_utils.ts:1104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1104)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:1210](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1210)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[object, `BigNumber`, boolean]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, `BigNumber`, boolean]* + +*Defined in [generated-wrappers/dev_utils.ts:1197](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1197)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[object, `BigNumber`, boolean]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:1172](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1172)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`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* + +___ + +## getOrderRelevantStates + +## ▪ **getOrderRelevantStates**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:797](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L797)* + +Fetches all order-relevant information needed to validate if the supplied orders are fillable. + +## callAsync + +▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[Array, BigNumber[], boolean[]]>`* + +*Defined in [generated-wrappers/dev_utils.ts:808](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L808)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:932](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L932)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`Array`, `BigNumber`[], boolean[]]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, `BigNumber`[], boolean[]]* + +*Defined in [generated-wrappers/dev_utils.ts:911](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L911)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`Array`, `BigNumber`[], boolean[]]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[]): *string* + +*Defined in [generated-wrappers/dev_utils.ts:885](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.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 | 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* + +___ + +## getTransferableAssetAmount + +## ▪ **getTransferableAssetAmount**: *object* + +*Defined in [generated-wrappers/dev_utils.ts:258](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L258)* + +Gets the amount of an asset transferable by the owner. + +## callAsync + +▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dev_utils.ts:268](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L268)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dev_utils.ts:334](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L334)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dev_utils.ts:327](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L327)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* + +*Defined in [generated-wrappers/dev_utils.ts:317](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L317)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +
+ +# Class: DummyERC20TokenContract + +### Hierarchy + +* `BaseContract` + + * **DummyERC20TokenContract** + + +### Constructors + +## constructer + +\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* + +*Overrides void* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:2167](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2167)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:2151](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2151)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:2109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2109)* + +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 [generated-wrappers/dummy_erc20_token.ts:2134](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2134)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:2140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2140)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1780](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1780)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1730](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1730)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1691](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1691)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## MAX_MINT_AMOUNT + +## ▪ **MAX_MINT_AMOUNT**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1628](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1628)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1634)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1682](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1682)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1675](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1675)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1670](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1670)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## allowance + +## ▪ **allowance**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1202](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1202)* + +## callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1211](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1211)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Amount of remaining tokens allowed to spent + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1276)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1269](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1269)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1259](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1259)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L122)* + +`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 [generated-wrappers/dummy_erc20_token.ts:168](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L168)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:233](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.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 | +------ | ------ | ------ | ------ | +`_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` | - | - | + +**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 [generated-wrappers/dummy_erc20_token.ts:198](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L198)* + +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 [generated-wrappers/dummy_erc20_token.ts:298](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L298)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:291](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L291)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:281](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L281)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:131](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L131)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:305](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L305)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## balanceOf + +## ▪ **balanceOf**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L666)* + +Query the balance of owner + +## callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:674](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L674)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Balance of owner + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:729](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L729)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:722](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L722)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:716](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L716)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## decimals + +## ▪ **decimals**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:601](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L601)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:607](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L607)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:655](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L655)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:648](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L648)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L643)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## mint + +## ▪ **mint**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:864](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L864)* + +Mints new tokens for sender + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:900](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L900)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:952](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L952)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_value` | `BigNumber` | - | Amount of tokens to mint | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:927](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L927)* + +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 [generated-wrappers/dummy_erc20_token.ts:1003](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1003)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:996](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L996)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:990](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L990)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:872](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L872)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:1010](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1010)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## name + +## ▪ **name**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L57)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L111)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L104)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L99)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:737](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L737)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L743)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:791](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L791)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:784](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L784)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L779)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## setBalance + +## ▪ **setBalance**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1287](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1287)* + +Sets the balance of target address + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1333](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1333)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1397](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1397)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_target` | string | - | Address or which balance will be updated | +`_value` | `BigNumber` | - | New balance of target address | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1363](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1363)* + +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 [generated-wrappers/dummy_erc20_token.ts:1462](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1462)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1455](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1455)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1445)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1296](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1296)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:1469](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1469)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_target` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## symbol + +## ▪ **symbol**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:799](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L799)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:805](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L805)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:853](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L853)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:846](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L846)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:841](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L841)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## totalSupply + +## ▪ **totalSupply**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:318](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L318)* + +Query total supply of token + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:325](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L325)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Total supply of token + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:373](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L373)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L366)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:361](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L361)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## transfer + +## ▪ **transfer**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1022](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1022)* + +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 [generated-wrappers/dummy_erc20_token.ts:1065](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1065)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1123)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_to` | string | - | The address of the recipient | +`_value` | `BigNumber` | - | The amount of token to be transferred | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +True if transfer was successful + +## estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1095](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1095)* + +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 [generated-wrappers/dummy_erc20_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1185)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1178](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1178)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1168](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1168)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1031](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1031)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:1192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1192)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L384)* + +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 [generated-wrappers/dummy_erc20_token.ts:435](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L435)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:512](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L512)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Success of transfer. + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:473](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L473)* + +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 [generated-wrappers/dummy_erc20_token.ts:583](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L583)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:576](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L576)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:564](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L564)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:394](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L394)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L590)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1479](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1479)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1513](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1513)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1563](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1563)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1539](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1539)* + +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 [generated-wrappers/dummy_erc20_token.ts:1615](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1615)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1608](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1608)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1600](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1600)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:1486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1486)* + +Sends an 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 [generated-wrappers/dummy_erc20_token.ts:1622](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1622)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DummyERC721TokenContract + +### Hierarchy + +* `BaseContract` + + * **DummyERC721TokenContract** + + +### Constructors + +## constructer + +\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* + +*Overrides void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2695](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2695)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2679](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2679)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2637](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2637)* + +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 [generated-wrappers/dummy_erc721_token.ts:2662](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2662)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2668](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2668)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2260](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2260)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2212](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2212)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2177](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2177)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:208](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L208)* + +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 [generated-wrappers/dummy_erc721_token.ts:254](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L254)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:318](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L318)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:284](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L284)* + +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 [generated-wrappers/dummy_erc721_token.ts:383](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L383)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L376)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L366)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:217](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L217)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:390](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L390)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_approved` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## balanceOf + +## ▪ **balanceOf**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1108](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1108)* + +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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1116](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1116)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +The number of NFTs owned by `_owner`, possibly zero + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1171)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1164](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1164)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1158)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## burn + +## ▪ **burn**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1307](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1307)* + +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 [generated-wrappers/dummy_erc721_token.ts:1350](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1350)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1411)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1380](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1380)* + +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 [generated-wrappers/dummy_erc721_token.ts:1473](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1473)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1466](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1466)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1456](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1456)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1316](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1316)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:1480](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1480)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_owner` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## getApproved + +## ▪ **getApproved**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L132)* + +Throws if `_tokenId` is not a valid NFT. + +## callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_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 | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +The approved address for this NFT, or the zero address if there is none + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:195](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L195)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:188](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L188)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:182](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L182)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## isApprovedForAll + +## ▪ **isApprovedForAll**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1945](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1945)* + +## callAsync + +▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1954](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1954)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_owner` | string | - | The address that owns the NFTs | +`_operator` | string | - | The address that acts on behalf of the owner | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +True if `_operator` is an approved operator for `_owner`, false otherwise + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2019](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2019)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2012](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2012)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2002](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2002)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## mint + +## ▪ **mint**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:626](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L626)* + +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 [generated-wrappers/dummy_erc721_token.ts:669](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L669)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:730](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L730)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:699](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L699)* + +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 [generated-wrappers/dummy_erc721_token.ts:792](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L792)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L785)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:775](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L775)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:635](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L635)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:799](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L799)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## name + +## ▪ **name**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L67)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L121)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:114](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L114)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L109)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1179)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1185)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1233](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1233)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1226)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1221](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1221)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +___ + +## ownerOf + +## ▪ **ownerOf**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1033](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1033)* + +NFTs assigned to zero address are considered invalid, and queries +about them do throw. + +## callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1041](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1041)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_tokenId` | `BigNumber` | - | The identifier for an NFT | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | **Returns:** *`Promise`* The address of the owner of the NFT -___ +## getABIDecodedReturnData -### getTokenCountAsync +▸ **getABIDecodedReturnData**(`returnData`: string): *string* -▸ **getTokenCountAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L61)* - -Count all NFTs assigned to an owner -NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address. +*Defined in [generated-wrappers/dummy_erc721_token.ts:1096](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1096)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address whose balance you would like to check. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The number of NFTs owned by `ownerAddress`, possibly zero - -___ - -### isApprovedForAllAsync - -▸ **isApprovedForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `operatorAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L116)* - -Query if an address is an authorized operator for all NFT's of `ownerAddress` - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`operatorAddress` | string | - | The hex encoded user Ethereum address of the operator you'd like to check if approved. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if `operatorAddress` is an approved operator for `ownerAddress`, false otherwise - -___ - -### isProxyApprovedAsync - -▸ **isProxyApprovedAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:197](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L197)* - -Checks if 0x proxy is approved for a single NFT -Throws if `_tokenId` is not a valid NFT - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if 0x proxy is approved - -___ - -### isProxyApprovedForAllAsync - -▸ **isProxyApprovedForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:148](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L148)* - -Query if 0x proxy is an authorized operator for all NFT's of `ownerAddress` - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -True if `operatorAddress` is an approved operator for `ownerAddress`, false otherwise - -___ - -### setApprovalAsync - -▸ **setApprovalAsync**(`tokenAddress`: string, `approvedAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:280](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L280)* - -Set or reaffirm the approved address for an NFT -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. -Throws if `_tokenId` is not a valid NFT -Emits the Approval event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`approvedAddress` | string | - | The hex encoded user Ethereum address you'd like to set approval for. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setApprovalForAllAsync - -▸ **setApprovalForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `operatorAddress`: string, `isApproved`: boolean, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:218](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L218)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`operatorAddress` | string | - | The hex encoded user Ethereum address of the operator you'd like to set approval for. | -`isApproved` | boolean | - | The boolean variable to set the approval to. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyApprovalAsync - -▸ **setProxyApprovalAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:318](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L318)* - -Set or reaffirm 0x proxy as an approved address for an NFT -Throws unless `msg.sender` is the current NFT owner, or an authorized operator of the current owner. -Throws if `_tokenId` is not a valid NFT -Emits the Approval event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### setProxyApprovalForAllAsync - -▸ **setProxyApprovalForAllAsync**(`tokenAddress`: string, `ownerAddress`: string, `isApproved`: boolean, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:258](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L258)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`ownerAddress` | string | - | The hex encoded user Ethereum address of the token owner. | -`isApproved` | boolean | - | The boolean variable to set the approval to. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`tokenAddress`: string, `eventName`: `ERC721TokenEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:390](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L390)* - -Subscribe to an event type emitted by the Token contract. - -**Type parameters:** - -▪ **ArgsType**: *`ERC721TokenEventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded address where the ERC721 token is deployed. | -`eventName` | `ERC721TokenEvents` | - | The token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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) | +Name | Type | +------ | ------ | +`returnData` | string | **Returns:** *string* -Subscription token used later to unsubscribe +## getABIDecodedTransactionData -___ +▸ **getABIDecodedTransactionData**(`callData`: string): *string* -### transferFromAsync - -▸ **transferFromAsync**(`tokenAddress`: string, `receiverAddress`: string, `senderAddress`: string, `tokenId`: `BigNumber`, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:338](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L338)* - -Enable or disable approval for a third party ("operator") to manage all of `ownerAddress`'s assets. -Throws if `_tokenId` is not a valid NFT -Emits the ApprovalForAll event. +*Defined in [generated-wrappers/dummy_erc721_token.ts:1089](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1089)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The hex encoded contract Ethereum address where the ERC721 token is deployed. | -`receiverAddress` | string | - | The hex encoded Ethereum address of the user to send the NFT to. | -`senderAddress` | string | - | The hex encoded Ethereum address of the user to send the NFT to. | -`tokenId` | `BigNumber` | - | The identifier for an NFT | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L417)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract_wrappers/erc721_token_wrapper.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/erc721_token_wrapper.ts#L424)* - -Cancels all existing subscriptions - -**Returns:** *void* - -
- -> # Class: EtherTokenWrapper - -This class includes all the functionality related to interacting with a wrapped Ether ERC20 token contract. -The caller can convert ETH into the equivalent number of wrapped ETH ERC20 tokens and back. - -## Hierarchy - -* **EtherTokenWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) - -### Methods - -* [depositAsync](#depositasync) -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [withdrawAsync](#withdrawasync) - -## Constructors - -### constructor - -\+ **new EtherTokenWrapper**(`web3Wrapper`: `Web3Wrapper`, `erc20TokenWrapper`: [ERC20TokenWrapper](#class-ethertokenwrapper)* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L28)* - -Instantiate EtherTokenWrapper. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use | -`erc20TokenWrapper` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | The ERC20TokenWrapper instance to use | -`blockPollingIntervalMs?` | undefined \| number | - | - -**Returns:** *[EtherTokenWrapper](#class-ethertokenwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = WETH9.compilerOutput.abi - -*Defined in [contract_wrappers/ether_token_wrapper.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L21)* - -## Methods - -### depositAsync - -▸ **depositAsync**(`etherTokenAddress`: string, `amountInWei`: `BigNumber`, `depositor`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L53)* - -Deposit ETH into the Wrapped ETH smart contract and issues the equivalent number of wrapped ETH tokens -to the depositor address. These wrapped ETH tokens can be used in 0x trades and are redeemable for 1-to-1 -for ETH. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`etherTokenAddress` | string | - | EtherToken address you wish to deposit into. | -`amountInWei` | `BigNumber` | - | Amount of ETH in Wei the caller wishes to deposit. | -`depositor` | string | - | The hex encoded user Ethereum address that would like to make the deposit. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`etherTokenAddress`: string, `eventName`: `WETH9Events`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L131)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`WETH9EventArgs`* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`etherTokenAddress` | string | An address of the ether token that emitted the logs. | -`eventName` | `WETH9Events` | The ether token contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 `{_owner: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`etherTokenAddress`: string, `eventName`: `WETH9Events`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L161)* - -Subscribe to an event type emitted by the Token contract. - -**Type parameters:** - -▪ **ArgsType**: *`WETH9EventArgs`* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`etherTokenAddress` | string | - | The hex encoded address where the ether token is deployed. | -`eventName` | `WETH9Events` | - | The ether token contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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 `{_owner: 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) | +Name | Type | +------ | ------ | +`callData` | string | **Returns:** *string* -Subscription token used later to unsubscribe +## getABIEncodedTransactionData -___ +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* -### unsubscribe +*Defined in [generated-wrappers/dummy_erc721_token.ts:1083](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1083)* -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [contract_wrappers/ether_token_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L188)* - -Cancel a subscription +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | +`_tokenId` | `BigNumber` | The identifier for an NFT | -**Returns:** *void* +**Returns:** *string* ___ -### unsubscribeAll +## safeTransferFrom1 -▸ **unsubscribeAll**(): *void* +## ▪ **safeTransferFrom1**: *object* -*Defined in [contract_wrappers/ether_token_wrapper.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L195)* +*Defined in [generated-wrappers/dummy_erc721_token.ts:813](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L813)* -Cancels all existing subscriptions +This works identically to the other function with an extra data parameter, +except this function just sets data to "". -**Returns:** *void* +## awaitTransactionSuccessAsync -___ +▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -### withdrawAsync +*Defined in [generated-wrappers/dummy_erc721_token.ts:864](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L864)* -▸ **withdrawAsync**(`etherTokenAddress`: string, `amountInWei`: `BigNumber`, `withdrawer`: string, `txOpts`: [TransactionOpts](#interface-transactionopts)): *`Promise`* +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. -*Defined in [contract_wrappers/ether_token_wrapper.ts:89](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts#L89)* +**Parameters:** -Withdraw ETH to the withdrawer's address from the wrapped ETH smart contract in exchange for the -equivalent number of wrapped ETH tokens. +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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:940](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L940)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`etherTokenAddress` | string | - | EtherToken address you wish to withdraw from. | -`amountInWei` | `BigNumber` | - | Amount of ETH in Wei the caller wishes to withdraw. | -`withdrawer` | string | - | The hex encoded user Ethereum address that would like to make the withdrawal. | -`txOpts` | [TransactionOpts](#interface-transactionopts) | {} | Transaction parameters. | +`_from` | string | - | The current owner of the NFT | +`_to` | string | - | The new owner | +`_tokenId` | `BigNumber` | - | The NFT to transfer | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -Transaction hash. +## estimateGasAsync -
+▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -> # Class: ExchangeWrapper +*Defined in [generated-wrappers/dummy_erc721_token.ts:902](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L902)* -This class includes all the functionality related to calling methods, sending transactions and subscribing to -events of the 0x V2 Exchange smart contract. - -## Hierarchy - -* **ExchangeWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [zrxTokenAddress](#zrxtokenaddress) - -### Methods - -* [batchCancelOrdersAsync](#batchcancelordersasync) -* [batchFillOrKillOrdersAsync](#batchfillorkillordersasync) -* [batchFillOrdersAsync](#batchfillordersasync) -* [batchFillOrdersNoThrowAsync](#batchfillordersnothrowasync) -* [cancelOrderAsync](#cancelorderasync) -* [cancelOrdersUpToAsync](#cancelordersuptoasync) -* [executeTransactionAsync](#executetransactionasync) -* [fillOrKillOrderAsync](#fillorkillorderasync) -* [fillOrderAsync](#fillorderasync) -* [fillOrderNoThrowAsync](#fillordernothrowasync) -* [getAssetProxyBySignatureAsync](#getassetproxybysignatureasync) -* [getFilledTakerAssetAmountAsync](#getfilledtakerassetamountasync) -* [getLogsAsync](#getlogsasync) -* [getOrderEpochAsync](#getorderepochasync) -* [getOrderInfoAsync](#getorderinfoasync) -* [getOrdersInfoAsync](#getordersinfoasync) -* [getVersionAsync](#getversionasync) -* [getZRXAssetData](#getzrxassetdata) -* [isAllowedValidatorAsync](#isallowedvalidatorasync) -* [isCancelledAsync](#iscancelledasync) -* [isPreSignedAsync](#ispresignedasync) -* [isTransactionExecutedAsync](#istransactionexecutedasync) -* [isValidSignatureAsync](#isvalidsignatureasync) -* [marketBuyOrdersAsync](#marketbuyordersasync) -* [marketBuyOrdersNoThrowAsync](#marketbuyordersnothrowasync) -* [marketSellOrdersAsync](#marketsellordersasync) -* [marketSellOrdersNoThrowAsync](#marketsellordersnothrowasync) -* [matchOrdersAsync](#matchordersasync) -* [preSignAsync](#presignasync) -* [setSignatureValidatorApprovalAsync](#setsignaturevalidatorapprovalasync) -* [subscribe](#subscribe) -* [transactionEncoderAsync](#transactionencoderasync) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [validateFillOrderThrowIfInvalidAsync](#validatefillorderthrowifinvalidasync) -* [validateMakerTransferThrowIfInvalidAsync](#validatemakertransferthrowifinvalidasync) -* [validateOrderFillableOrThrowAsync](#validateorderfillableorthrowasync) - -## Constructors - -### constructor - -\+ **new ExchangeWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `erc20TokenWrapper`: [ERC20TokenWrapper](#class-exchangewrapper)* - -*Defined in [contract_wrappers/exchange_wrapper.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L55)* - -Instantiate ExchangeWrapper +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`erc20TokenWrapper` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | ERC20TokenWrapper instance to use. | -`erc721TokenWrapper` | [ERC721TokenWrapper](#class-erc721tokenwrapper) | ERC721TokenWrapper instance to use. | -`address?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`zrxTokenAddress?` | undefined \| string | The address of the ZRXToken contract. If undefined, will default to the known address corresponding to the networkId. | -`blockPollingIntervalMs?` | undefined \| number | The block polling interval to use for active subscriptions. | +`_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:** *[ExchangeWrapper](#class-exchangewrapper)* +**Returns:** *`Promise`* -## Properties +The hash of the transaction -### abi +## getABIDecodedReturnData -• **abi**: *`ContractAbi`* = Exchange.compilerOutput.abi +▸ **getABIDecodedReturnData**(`returnData`: string): *void* -*Defined in [contract_wrappers/exchange_wrapper.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L48)* +*Defined in [generated-wrappers/dummy_erc721_token.ts:1011](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1011)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1004](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1004)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:992](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L992)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:823](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L823)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:1018](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1018)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### address +## safeTransferFrom2 + +## ▪ **safeTransferFrom2**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1699](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1699)* + +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 [generated-wrappers/dummy_erc721_token.ts:1761](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1761)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1845](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1845)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1803](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1803)* + +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 [generated-wrappers/dummy_erc721_token.ts:1920](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1920)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1913](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1913)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1901](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1901)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1710](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1710)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:1927](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1927)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`_data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## setApprovalForAll + +## ▪ **setApprovalForAll**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1494](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1494)* + +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 [generated-wrappers/dummy_erc721_token.ts:1540](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1540)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1608](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1608)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1574](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1574)* + +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 [generated-wrappers/dummy_erc721_token.ts:1673](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1673)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1666)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1656](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1656)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1503](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1503)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:1680](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1680)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_operator` | string | +`_approved` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## symbol + +## ▪ **symbol**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1241)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1247](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1247)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1295](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1295)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1288](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1288)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:1283](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1283)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:406](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L406)* + +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 [generated-wrappers/dummy_erc721_token.ts:457](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L457)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:533](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L533)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_from` | string | - | The current owner of the NFT | +`_to` | string | - | The new owner | +`_tokenId` | `BigNumber` | - | The NFT to transfer | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:495](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L495)* + +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 [generated-wrappers/dummy_erc721_token.ts:604](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L604)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:597](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L597)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:585](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L585)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:416](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L416)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L611)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2027](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2027)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2061](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2061)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2111](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2111)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2087](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2087)* + +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 [generated-wrappers/dummy_erc721_token.ts:2163](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2163)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2156](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2156)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2148](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2148)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:2034](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2034)* + +Sends an 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 [generated-wrappers/dummy_erc721_token.ts:2170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2170)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: DutchAuctionContract + +### Hierarchy + +* `BaseContract` + + * **DutchAuctionContract** + + +### Constructors + +## constructer + +\+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DutchAuctionContract](#class-dutchauctioncontract)* + +*Overrides void* + +*Defined in [generated-wrappers/dutch_auction.ts:1215](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L1215)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address • **address**: *string* -*Defined in [contract_wrappers/exchange_wrapper.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L49)* + + + ___ -### zrxTokenAddress +## constructerArgs -• **zrxTokenAddress**: *string* +• **constructorArgs**: *any[]* -*Defined in [contract_wrappers/exchange_wrapper.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L50)* -## Methods -### batchCancelOrdersAsync -▸ **batchCancelOrdersAsync**(`orders`: `Array`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/exchange_wrapper.ts:713](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L713)* +___ -Batch version of cancelOrderAsync. Executes multiple cancels atomically in a single transaction. +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/dutch_auction.ts:923](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L923)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:876](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L876)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | An array of orders to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *`Promise`* - -Transaction hash. +**Returns:** *`Promise`* ___ -### batchFillOrKillOrdersAsync +## `Static` deployFrom0xArtifactAsync -▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [contract_wrappers/exchange_wrapper.ts:665](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L665)* - -Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. +*Defined in [generated-wrappers/dutch_auction.ts:843](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L843)* **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. | +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *`Promise`* - -Transaction hash. +**Returns:** *`Promise`* ___ -### batchFillOrdersAsync +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + -▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [contract_wrappers/exchange_wrapper.ts:382](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L382)* -Batch version of fillOrderAsync. 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. | +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -**Returns:** *`Promise`* +**Returns:** *string* -Transaction hash. +### Object literals -___ +## getAuctionDetails -### batchFillOrdersNoThrowAsync +## ▪ **getAuctionDetails**: *object* -▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +*Defined in [generated-wrappers/dutch_auction.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L33)* -*Defined in [contract_wrappers/exchange_wrapper.ts:614](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L614)* +Calculates the Auction Details for the given order -No throw version of batchFillOrdersAsync +## awaitTransactionSuccessAsync -**Parameters:** +▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* -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. | +*Defined in [generated-wrappers/dutch_auction.ts:87](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L87)* -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### cancelOrderAsync - -▸ **cancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:986](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L986)* - -Cancel a given order. - -**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. - -___ - -### cancelOrdersUpToAsync - -▸ **cancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1061](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1061)* - -Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch -and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). - -**Parameters:** - -Name | Type | 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. - -___ - -### executeTransactionAsync - -▸ **executeTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L334)* - -Executes a 0x transaction. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address (see [ZEIP18](https://github.com/0xProject/ZEIPs/issues/18)). -This is especially useful for implementing filter contracts. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`salt` | `BigNumber` | - | Salt | -`signerAddress` | string | - | Signer address | -`data` | string | - | Transaction data | -`signature` | string | - | Signature | -`senderAddress` | string | - | Sender address | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Transaction hash. - -___ - -### fillOrKillOrderAsync - -▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:283](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L283)* - -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/exchange_wrapper.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L190)* - -Fills a signed order with an amount denominated in baseUnits of the taker asset. - -**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/exchange_wrapper.ts:234](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L234)* - -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. - -___ - -### getAssetProxyBySignatureAsync - -▸ **getAssetProxyBySignatureAsync**(`proxyId`: `AssetProxyId`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L97)* - -Retrieve the address of an asset proxy by signature. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`proxyId` | `AssetProxyId` | - | The 4 bytes signature of an asset proxy | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The address of an asset proxy for a given signature - -___ - -### getFilledTakerAssetAmountAsync - -▸ **getFilledTakerAssetAmountAsync**(`orderHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L115)* - -Retrieve the takerAssetAmount of an order that has already been filled. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orderHash` | string | - | The hex encoded orderHash for which you would like to retrieve the filled takerAssetAmount. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -The amount of the order (in taker asset base units) that has already been filled. - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: `ExchangeEvents`, `blockRange`: [BlockRange](#interface-blockrange), `indexFilterValues`: [IndexedFilterValues](#interface-indexedfiltervalues)): *`Promise>>`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1135](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1135)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *`ExchangeEventArgs`* +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`eventName` | `ExchangeEvents` | The exchange contract event you would like to subscribe to. | -`blockRange` | [BlockRange](#interface-blockrange) | Block range to get logs from. | -`indexFilterValues` | [IndexedFilterValues](#interface-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}` | +`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`): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L170)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +AuctionDetails + +## estimateGasAsync + +▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L126)* + +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 [generated-wrappers/dutch_auction.ts:289](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L289)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/dutch_auction.ts:264](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L264)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [generated-wrappers/dutch_auction.ts:243](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L243)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The sell order | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L41)* + +Sends an 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 [generated-wrappers/dutch_auction.ts:314](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L314)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## matchOrders + +## ▪ **matchOrders**: *object* + +*Defined in [generated-wrappers/dutch_auction.ts:353](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L353)* + +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 [generated-wrappers/dutch_auction.ts:435](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L435)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:570](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L570)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/dutch_auction.ts:503](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L503)* + +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 [generated-wrappers/dutch_auction.ts:760](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L760)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/dutch_auction.ts:721](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L721)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string): *string* + +*Defined in [generated-wrappers/dutch_auction.ts:680](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L680)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/dutch_auction.ts:366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L366)* + +Sends an 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 [generated-wrappers/dutch_auction.ts:799](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L799)* + +**Parameters:** + +Name | Type | +------ | ------ | +`buyOrder` | object | +`sellOrder` | object | +`buySignature` | string | +`sellSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC20ProxyContract + +### Hierarchy + +* `BaseContract` + + * **ERC20ProxyContract** + + +### Constructors + +## constructer + +\+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20ProxyContract](#class-erc20proxycontract)* + +*Overrides void* + +*Defined in [generated-wrappers/erc20_proxy.ts:1378](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1378)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/erc20_proxy.ts:1362](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1362)* + +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>>`* @@ -2612,400 +11496,4943 @@ Array of logs that match the parameters ___ -### getOrderEpochAsync +## subscribe -▸ **getOrderEpochAsync**(`makerAddress`: string, `senderAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [contract_wrappers/exchange_wrapper.ts:146](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L146)* +*Defined in [generated-wrappers/erc20_proxy.ts:1320](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1320)* -Retrieve the set order epoch for a given makerAddress & senderAddress pair. -Orders can be bulk cancelled by setting the order epoch to a value lower then the salt value of orders one wishes to cancel. +Subscribe to an event type emitted by the ERC20Proxy contract. + +**Type parameters:** + +▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`makerAddress` | string | - | Maker address | -`senderAddress` | string | - | Sender address | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Order epoch. Defaults to 0. - -___ - -### getOrderInfoAsync - -▸ **getOrderInfoAsync**(`order`: `Order` | `SignedOrder`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:947](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L947)* - -Get order info - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | `Order` \| `SignedOrder` | - | Order | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Order info - -___ - -### getOrdersInfoAsync - -▸ **getOrdersInfoAsync**(`orders`: `Array`, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:963](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L963)* - -Get order info for multiple orders - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Orders | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Array of Order infos - -___ - -### getVersionAsync - -▸ **getVersionAsync**(`methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L132)* - -Retrieve the exchange contract version - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | - -**Returns:** *`Promise`* - -Version - -___ - -### getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1259](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1259)* - -Returns the ZRX asset data used by the exchange contract. +`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* -ZRX asset data +Subscription token used later to unsubscribe ___ -### isAllowedValidatorAsync +## unsubscribe -▸ **isAllowedValidatorAsync**(`signerAddress`: string, `validatorAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [contract_wrappers/exchange_wrapper.ts:874](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L874)* +*Defined in [generated-wrappers/erc20_proxy.ts:1345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1345)* -Checks if the validator is allowed by the signer. +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/erc20_proxy.ts:1351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1351)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/erc20_proxy.ts:1123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1123)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:1081](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1081)* + +**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/erc20_proxy.ts:1056](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1056)* + +**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 + +## addAuthorizedAddress + +## ▪ **addAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc20_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:148](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 | ------ | ------ | ------ | ------ | -`signerAddress` | string | - | Address of a signer | -`validatorAddress` | string | - | Address of a validator | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`target` | string | - | Address to authorize. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc20_proxy.ts:201](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L201)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc20_proxy.ts:194](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L194)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L186)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc20_proxy.ts:208](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L208)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## authorities + +## ▪ **authorities**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:214](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L214)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:220](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L220)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:274](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L274)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L267)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:261](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L261)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *string* + +___ + +## authorized + +## ▪ **authorized**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:770](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L770)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:776](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L776)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | **Returns:** *`Promise`* -If the validator is allowed +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L832)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_proxy.ts:825](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L825)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:817](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L817)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* ___ -### isCancelledAsync +## getAuthorizedAddresses -▸ **isCancelledAsync**(`orderHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +## ▪ **getAuthorizedAddresses**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:169](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L169)* +*Defined in [generated-wrappers/erc20_proxy.ts:843](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L843)* -Check if an order has been cancelled. Order cancellations are binary +Gets all authorized addresses. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:850](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L850)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/erc20_proxy.ts:898](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L898)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/erc20_proxy.ts:891](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L891)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:886](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L886)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +___ + +## getProxyId + +## ▪ **getProxyId**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:707](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L707)* + +Gets the proxy id associated with the proxy address. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:714](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L714)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Proxy id. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L762)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L755)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:750](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.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). + +**Returns:** *string* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L439)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L445)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L493)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L486)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L481)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## removeAuthorizedAddress + +## ▪ **removeAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:285](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L285)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc20_proxy.ts:321](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L321)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:373](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L373)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`orderHash` | string | - | The hex encoded orderHash for which you would like to retrieve the cancelled takerAmount. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`target` | string | - | Address to remove authorization from. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L348)* + +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 [generated-wrappers/erc20_proxy.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L426)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc20_proxy.ts:419](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L419)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L411)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:293](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L293)* + +Sends an 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 [generated-wrappers/erc20_proxy.ts:433](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L433)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## removeAuthorizedAddressAtIndex + +## ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:504](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L504)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc20_proxy.ts:550](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L550)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:618](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L618)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:584](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L584)* + +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 [generated-wrappers/erc20_proxy.ts:683](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L683)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc20_proxy.ts:676](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L676)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L666)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:513](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L513)* + +Sends an 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 [generated-wrappers/erc20_proxy.ts:690](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L690)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/erc20_proxy.ts:906](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L906)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc20_proxy.ts:940](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L940)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:990](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L990)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:966](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L966)* + +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 [generated-wrappers/erc20_proxy.ts:1042](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1042)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc20_proxy.ts:1035](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1035)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:1027](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1027)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_proxy.ts:913](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L913)* + +Sends an 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 [generated-wrappers/erc20_proxy.ts:1049](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1049)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC20TokenContract + +### Hierarchy + +* `BaseContract` + + * **ERC20TokenContract** + + +### Constructors + +## constructer + +\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20TokenContract](#class-erc20tokencontract)* + +*Overrides void* + +*Defined in [generated-wrappers/erc20_token.ts:1193](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1193)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/erc20_token.ts:1177](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1177)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/erc20_token.ts:1135](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1135)* + +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 [generated-wrappers/erc20_token.ts:1160](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1160)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/erc20_token.ts:1166](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1166)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/erc20_token.ts:946](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L946)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:904](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L904)* + +**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/erc20_token.ts:879](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L879)* + +**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 + +## allowance + +## ▪ **allowance**: *object* + +*Defined in [generated-wrappers/erc20_token.ts:796](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L796)* + +## callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:805](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L805)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Amount of remaining tokens allowed to spent + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:870](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L870)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:863](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L863)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [generated-wrappers/erc20_token.ts:853](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L853)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/erc20_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L60)* + +`msg.sender` approves `_spender` to spend `_value` tokens + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc20_token.ts:106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L106)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L171)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | **Returns:** *`Promise`* -Whether the order has been cancelled. +Always true if the call has enough gas to complete execution + +## estimateGasAsync + +▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:136](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L136)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_token.ts:236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L236)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_token.ts:229](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L229)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc20_token.ts:219](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L219)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:69](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L69)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_spender` | string | The address of the account able to transfer the tokens | +`_value` | `BigNumber` | The amount of wei to be approved for transfer | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:243](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L243)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### isPreSignedAsync +## balanceOf -▸ **isPreSignedAsync**(`hash`: string, `signerAddress`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +## ▪ **balanceOf**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:903](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L903)* +*Defined in [generated-wrappers/erc20_token.ts:542](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L542)* -Check whether the hash is pre-signed on-chain. +Query the balance of owner + +## callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L550)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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 | - | Hash to check if pre-signed | -`signerAddress` | string | - | Address that should have signed the given hash. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`_owner` | string | - | The address from which the balance will be retrieved | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Balance of owner + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:605](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L605)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:598](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L598)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [generated-wrappers/erc20_token.ts:592](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L592)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## totalSupply + +## ▪ **totalSupply**: *object* + +*Defined in [generated-wrappers/erc20_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L256)* + +Query total supply of token + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:263](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L263)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Total supply of token + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:311](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L311)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:304](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L304)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc20_token.ts:299](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L299)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## transfer + +## ▪ **transfer**: *object* + +*Defined in [generated-wrappers/erc20_token.ts:616](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L616)* + +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 [generated-wrappers/erc20_token.ts:659](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L659)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:717](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L717)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`_to` | string | - | The address of the recipient | +`_value` | `BigNumber` | - | The amount of token to be transferred | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | **Returns:** *`Promise`* -Whether the hash is pre-signed. +True if transfer was successful + +## estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:689](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L689)* + +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 [generated-wrappers/erc20_token.ts:779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L779)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L772)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc20_token.ts:762](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L762)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L625)* + +Sends an 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 [generated-wrappers/erc20_token.ts:786](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L786)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### isTransactionExecutedAsync +## transferFrom -▸ **isTransactionExecutedAsync**(`transactionHash`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +## ▪ **transferFrom**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:927](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L927)* +*Defined in [generated-wrappers/erc20_token.ts:322](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L322)* -Checks if transaction is already executed. +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 [generated-wrappers/erc20_token.ts:373](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L373)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:450](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L450)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`transactionHash` | string | - | Transaction hash to check | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`_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` | - | - | **Returns:** *`Promise`* -If transaction is already executed. +True if transfer was successful + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L411)* + +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 [generated-wrappers/erc20_token.ts:521](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L521)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc20_token.ts:514](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L514)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc20_token.ts:502](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L502)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc20_token.ts:332](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L332)* + +Sends an 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 [generated-wrappers/erc20_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L528)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC721ProxyContract + +### Hierarchy + +* `BaseContract` + + * **ERC721ProxyContract** + + +### Constructors + +## constructer + +\+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721ProxyContract](#class-erc721proxycontract)* + +*Overrides void* + +*Defined in [generated-wrappers/erc721_proxy.ts:1378](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1378)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + ___ -### isValidSignatureAsync +## address -▸ **isValidSignatureAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `methodOpts`: [MethodOpts](#interface-methodopts)): *`Promise`* +• **address**: *string* -*Defined in [contract_wrappers/exchange_wrapper.ts:846](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L846)* -Checks if the signature is valid. + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/erc721_proxy.ts:1362](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1362)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:1320](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1320)* + +Subscribe to an event type emitted by the ERC721Proxy contract. + +**Type parameters:** + +▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`hash` | string | - | Hash to pre-sign | -`signerAddress` | string | - | Address that should have signed the given hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`methodOpts` | [MethodOpts](#interface-methodopts) | {} | Optional arguments this method accepts. | +`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 [generated-wrappers/erc721_proxy.ts:1345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1345)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/erc721_proxy.ts:1351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1351)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/erc721_proxy.ts:1123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1123)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:1081](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1081)* + +**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/erc721_proxy.ts:1056](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1056)* + +**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 + +## addAuthorizedAddress + +## ▪ **addAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc721_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:148](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc721_proxy.ts:201](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L201)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_proxy.ts:194](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L194)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L186)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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 [generated-wrappers/erc721_proxy.ts:208](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L208)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## authorities + +## ▪ **authorities**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:214](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L214)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:220](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L220)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:274](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L274)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L267)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:261](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L261)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *string* + +___ + +## authorized + +## ▪ **authorized**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:770](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L770)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:776](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L776)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | **Returns:** *`Promise`* -If the signature is valid +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/erc721_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L832)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc721_proxy.ts:825](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L825)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:817](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L817)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* ___ -### marketBuyOrdersAsync +## getAuthorizedAddresses -▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **getAuthorizedAddresses**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L428)* +*Defined in [generated-wrappers/erc721_proxy.ts:843](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L843)* -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. +Gets all authorized addresses. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:850](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L850)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/erc721_proxy.ts:898](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L898)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/erc721_proxy.ts:891](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L891)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:886](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L886)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +___ + +## getProxyId + +## ▪ **getProxyId**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:707](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L707)* + +Gets the proxy id associated with the proxy address. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:714](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L714)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Proxy id. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L762)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L755)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:750](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.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). + +**Returns:** *string* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L439)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L445)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L493)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L486)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L481)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## removeAuthorizedAddress + +## ▪ **removeAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/erc721_proxy.ts:285](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L285)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc721_proxy.ts:321](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L321)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:373](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L373)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **Parameters:** Name | Type | Default | 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. | +`target` | string | - | Address to remove authorization from. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L348)* + +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 [generated-wrappers/erc721_proxy.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L426)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_proxy.ts:419](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L419)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L411)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:293](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L293)* + +Sends an 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`* -Transaction hash. +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:433](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L433)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### marketBuyOrdersNoThrowAsync +## removeAuthorizedAddressAtIndex -▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **removeAuthorizedAddressAtIndex**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L516)* +*Defined in [generated-wrappers/erc721_proxy.ts:504](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L504)* -No throw version of marketBuyOrdersAsync +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc721_proxy.ts:550](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L550)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:618](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L618)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **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. | +`target` | string | - | Address to remove authorization from. | +`index` | `BigNumber` | - | Index of target in authorities array. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:584](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L584)* + +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 [generated-wrappers/erc721_proxy.ts:683](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L683)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_proxy.ts:676](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L676)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L666)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:513](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L513)* + +Sends an 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`* -Transaction hash. +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:690](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L690)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### marketSellOrdersAsync +## transferOwnership -▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **transferOwnership**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:472](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L472)* +*Defined in [generated-wrappers/erc721_proxy.ts:906](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L906)* -Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/erc721_proxy.ts:940](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L940)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:990](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L990)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:966](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L966)* + +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 [generated-wrappers/erc721_proxy.ts:1042](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1042)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_proxy.ts:1035](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1035)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:1027](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1027)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_proxy.ts:913](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L913)* + +Sends an 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 [generated-wrappers/erc721_proxy.ts:1049](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1049)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ERC721TokenContract + +### Hierarchy + +* `BaseContract` + + * **ERC721TokenContract** + + +### Constructors + +## constructer + +\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721TokenContract](#class-erc721tokencontract)* + +*Overrides void* + +*Defined in [generated-wrappers/erc721_token.ts:1862](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1862)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/erc721_token.ts:1846](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1846)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/erc721_token.ts:1804](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1804)* + +Subscribe to an event type emitted by the ERC721Token contract. + +**Type parameters:** + +▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* **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. | +`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | - | The ERC721Token contract event you would like to subscribe to. | +`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | +`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | +`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | +`blockPollingIntervalMs?` | undefined \| number | - | - | -**Returns:** *`Promise`* +**Returns:** *string* -Transaction hash. +Subscription token used later to unsubscribe ___ -### marketSellOrdersNoThrowAsync +## unsubscribe -▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [contract_wrappers/exchange_wrapper.ts:565](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L565)* +*Defined in [generated-wrappers/erc721_token.ts:1829](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1829)* -No throw version of marketSellOrdersAsync +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/erc721_token.ts:1835](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1835)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/erc721_token.ts:1535](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1535)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1493)* + +**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/erc721_token.ts:1468](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1468)* + +**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 + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/erc721_token.ts:146](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L146)* + +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 [generated-wrappers/erc721_token.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L192)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.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 | 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. | +`_approved` | string | - | The new approved NFT controller | +`_tokenId` | `BigNumber` | - | The NFT to approve | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L222)* + +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 [generated-wrappers/erc721_token.ts:321](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L321)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_token.ts:314](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L314)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_token.ts:304](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L304)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L155)* + +Sends an 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`* -Transaction hash. +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:328](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L328)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_approved` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* ___ -### matchOrdersAsync +## balanceOf -▸ **matchOrdersAsync**(`leftSignedOrder`: `SignedOrder`, `rightSignedOrder`: `SignedOrder`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **balanceOf**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:752](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L752)* +*Defined in [generated-wrappers/erc721_token.ts:859](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L859)* -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 (whoever matched the two orders). +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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:867](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.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 | Description | ------ | ------ | ------ | ------ | -`leftSignedOrder` | `SignedOrder` | - | First order to match. | -`rightSignedOrder` | `SignedOrder` | - | Second order to match. | -`takerAddress` | string | - | The address that sends the transaction and gets the spread. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | +`_owner` | string | - | An address for whom to query the balance | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -Transaction hash. +The number of NFTs owned by `_owner`, possibly zero + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc721_token.ts:922](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L922)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/erc721_token.ts:915](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L915)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:909](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L909)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | + +**Returns:** *string* ___ -### preSignAsync +## getApproved -▸ **preSignAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **getApproved**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:808](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L808)* +*Defined in [generated-wrappers/erc721_token.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L70)* -Approves a hash on-chain using any valid signature type. -After presigning a hash, the preSign signature type will become valid for that hash and signer. +Throws if `_tokenId` is not a valid NFT. + +## callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:78](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L78)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`hash` | string | - | Hash to pre-sign | -`signerAddress` | string | - | Address that should have signed the given hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`senderAddress` | string | - | Address that should send the transaction. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | +`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | **Returns:** *`Promise`* -Transaction hash. +The approved address for this NFT, or the zero address if there is none + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L133)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L126)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_token.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L120)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* ___ -### setSignatureValidatorApprovalAsync +## isApprovedForAll -▸ **setSignatureValidatorApprovalAsync**(`validatorAddress`: string, `isApproved`: boolean, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **isApprovedForAll**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:1020](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1020)* +*Defined in [generated-wrappers/erc721_token.ts:1385](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1385)* -Sets the signature validator approval +## callAsync + +▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1394](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1394)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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 | - | Validator contract address. | -`isApproved` | boolean | - | Boolean value to set approval to. | -`senderAddress` | string | - | Sender address. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | +`_owner` | string | - | The address that owns the NFTs | +`_operator` | string | - | The address that acts on behalf of the owner | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -Transaction hash. +True if `_operator` is an approved operator for `_owner`, false otherwise + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/erc721_token.ts:1459](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1459)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/erc721_token.ts:1452](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1452)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:1442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1442)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* ___ -### subscribe +## ownerOf -▸ **subscribe**<**ArgsType**>(`eventName`: `ExchangeEvents`, `indexFilterValues`: [IndexedFilterValues](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean): *string* +## ▪ **ownerOf**: *object* -*Defined in [contract_wrappers/exchange_wrapper.ts:1096](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1096)* +*Defined in [generated-wrappers/erc721_token.ts:784](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L784)* + +NFTs assigned to zero address are considered invalid, and queries +about them do throw. + +## callAsync + +▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:792](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L792)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +The address of the owner of the NFT + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:847](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L847)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:840](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L840)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_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 | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | + +**Returns:** *string* + +___ + +## safeTransferFrom1 + +## ▪ **safeTransferFrom1**: *object* + +*Defined in [generated-wrappers/erc721_token.ts:564](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L564)* + +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 [generated-wrappers/erc721_token.ts:615](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L615)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:691](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L691)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:653](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L653)* + +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 [generated-wrappers/erc721_token.ts:762](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L762)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_token.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L755)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L743)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:574](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L574)* + +Sends an 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 [generated-wrappers/erc721_token.ts:769](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L769)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## safeTransferFrom2 + +## ▪ **safeTransferFrom2**: *object* + +*Defined in [generated-wrappers/erc721_token.ts:1139](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1139)* + +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 [generated-wrappers/erc721_token.ts:1201](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1201)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1285](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1285)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1243](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1243)* + +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 [generated-wrappers/erc721_token.ts:1360](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1360)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_token.ts:1353](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1353)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* + +*Defined in [generated-wrappers/erc721_token.ts:1341](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1341)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1150)* + +Sends an 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 [generated-wrappers/erc721_token.ts:1367](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1367)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`_data` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## setApprovalForAll + +## ▪ **setApprovalForAll**: *object* + +*Defined in [generated-wrappers/erc721_token.ts:934](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L934)* + +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 [generated-wrappers/erc721_token.ts:980](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L980)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1048](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_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 | +------ | ------ | ------ | ------ | +`_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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:1014](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1014)* + +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 [generated-wrappers/erc721_token.ts:1113](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1113)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_token.ts:1106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1106)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* + +*Defined in [generated-wrappers/erc721_token.ts:1096](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1096)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:943](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L943)* + +Sends an 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 [generated-wrappers/erc721_token.ts:1120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1120)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_operator` | string | +`_approved` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/erc721_token.ts:344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L344)* + +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 [generated-wrappers/erc721_token.ts:395](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L395)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The 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`): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:471](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L471)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:433](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L433)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The 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 [generated-wrappers/erc721_token.ts:542](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L542)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/erc721_token.ts:535](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L535)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/erc721_token.ts:523](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L523)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/erc721_token.ts:354](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L354)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The 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 [generated-wrappers/erc721_token.ts:549](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L549)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_tokenId` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: EthBalanceCheckerContract + +### Hierarchy + +* `BaseContract` + + * **EthBalanceCheckerContract** + + +### Constructors + +## constructer + +\+ **new EthBalanceCheckerContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[EthBalanceCheckerContract](#class-ethbalancecheckercontract)* + +*Overrides void* + +*Defined in [generated-wrappers/eth_balance_checker.ts:194](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L194)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[EthBalanceCheckerContract](#class-ethbalancecheckercontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/eth_balance_checker.ts:171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L171)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/eth_balance_checker.ts:129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L129)* + +**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/eth_balance_checker.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L104)* + +**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 + +## getEthBalances + +## ▪ **getEthBalances**: *object* + +*Defined in [generated-wrappers/eth_balance_checker.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L33)* + +Batch fetches ETH balances + +## callAsync + +▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/eth_balance_checker.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L41)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Array of ETH balances. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/eth_balance_checker.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L96)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* + +*Defined in [generated-wrappers/eth_balance_checker.ts:89](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L89)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* + +*Defined in [generated-wrappers/eth_balance_checker.ts:83](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/eth_balance_checker.ts#L83)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +
+ +# Class: ExchangeContract + +### Hierarchy + +* `BaseContract` + + * **ExchangeContract** + + +### Constructors + +## constructer + +\+ **new ExchangeContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ExchangeContract](#class-exchangecontract)* + +*Overrides void* + +*Defined in [generated-wrappers/exchange.ts:9031](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L9031)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ExchangeContract](#class-exchangecontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/exchange.ts:9015](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L9015)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/exchange.ts:8973](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8973)* Subscribe to an event type emitted by the Exchange contract. **Type parameters:** -▪ **ArgsType**: *`ExchangeEventArgs`* +▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`eventName` | `ExchangeEvents` | - | The exchange contract event you would like to subscribe to. | -`indexFilterValues` | [IndexedFilterValues](#interface-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}` | +`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* @@ -3013,26 +16440,11 @@ Subscription token used later to unsubscribe ___ -### transactionEncoderAsync - -▸ **transactionEncoderAsync**(): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1268)* - -Returns a Transaction Encoder. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address. - -**Returns:** *`Promise`* - -TransactionEncoder - -___ - -### unsubscribe +## unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [contract_wrappers/exchange_wrapper.ts:1118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1118)* +*Defined in [generated-wrappers/exchange.ts:8998](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8998)* Cancel a subscription @@ -3046,11 +16458,11 @@ Name | Type | Description | ___ -### unsubscribeAll +## unsubscribeAll ▸ **unsubscribeAll**(): *void* -*Defined in [contract_wrappers/exchange_wrapper.ts:1124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1124)* +*Defined in [generated-wrappers/exchange.ts:9004](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L9004)* Cancels all existing subscriptions @@ -3058,609 +16470,11483 @@ Cancels all existing subscriptions ___ -### validateFillOrderThrowIfInvalidAsync +## `Static` ABI -▸ **validateFillOrderThrowIfInvalidAsync**(`signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string): *`Promise`* +▸ **ABI**(): *`ContractAbi`* -*Defined in [contract_wrappers/exchange_wrapper.ts:1231](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1231)* +*Defined in [generated-wrappers/exchange.ts:6988](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6988)* -Validate a call to FillOrder and throw if it wouldn't succeed +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6941](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6941)* **Parameters:** -Name | Type | Description | +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6908](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6908)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## EIP712_DOMAIN_HASH + +## ▪ **EIP712_DOMAIN_HASH**: *object* + +*Defined in [generated-wrappers/exchange.ts:6229](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6229)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6235](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6235)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`fillTakerAssetAmount` | `BigNumber` | Amount we'd like to fill the order for | -`takerAddress` | string | The taker of the order | - -**Returns:** *`Promise`* - -___ - -### validateMakerTransferThrowIfInvalidAsync - -▸ **validateMakerTransferThrowIfInvalidAsync**(`signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1211](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1211)* - -Validate the transfer from the maker to the taker. This is simulated on-chain -via an eth_call. If this call fails, the asset is currently nontransferable. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`makerAssetAmount` | `BigNumber` | Amount to transfer from the maker | -`takerAddress?` | undefined \| string | The address to transfer to, defaults to signedOrder.takerAddress | - -**Returns:** *`Promise`* - -___ - -### validateOrderFillableOrThrowAsync - -▸ **validateOrderFillableOrThrowAsync**(`signedOrder`: `SignedOrder`, `opts`: [ValidateOrderFillableOpts](#interface-validateorderfillableopts)): *`Promise`* - -*Defined in [contract_wrappers/exchange_wrapper.ts:1153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/exchange_wrapper.ts#L1153)* - -Validate if the supplied order is fillable, and throw if it isn't - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrder` | `SignedOrder` | - | SignedOrder of interest | -`opts` | [ValidateOrderFillableOpts](#interface-validateorderfillableopts) | {} | ValidateOrderFillableOpts options (e.g expectedFillTakerTokenAmount. If it isn't supplied, we check if the order is fillable for the remaining amount. To check if the order is fillable for a non-zero amount, set `validateRemainingOrderAmountIsFillable` to false.) | - -**Returns:** *`Promise`* - -
- -> # Class: ForwarderWrapper - -This class includes the functionality related to interacting with the Forwarder contract. - -## Hierarchy - -* **ForwarderWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [etherTokenAddress](#ethertokenaddress) -* [zrxTokenAddress](#zrxtokenaddress) - -### Methods - -* [marketBuyOrdersWithEthAsync](#marketbuyorderswithethasync) -* [marketSellOrdersWithEthAsync](#marketsellorderswithethasync) - -## Constructors - -### constructor - -\+ **new ForwarderWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string, `zrxTokenAddress?`: undefined | string, `etherTokenAddress?`: undefined | string): *[ForwarderWrapper](#class-forwarderwrapper)* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L29)* - -Instantiate ForwarderWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | -`zrxTokenAddress?` | undefined \| string | The address of the ZRXToken contract. If undefined, will default to the known address corresponding to the networkId. | -`etherTokenAddress?` | undefined \| string | The address of a WETH (Ether token) contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[ForwarderWrapper](#class-forwarderwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = Forwarder.compilerOutput.abi - -*Defined in [contract_wrappers/forwarder_wrapper.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L24)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L25)* - -___ - -### etherTokenAddress - -• **etherTokenAddress**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L27)* - -___ - -### zrxTokenAddress - -• **zrxTokenAddress**: *string* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L26)* - -## Methods - -### marketBuyOrdersWithEthAsync - -▸ **marketBuyOrdersWithEthAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `ethAmount`: `BigNumber`, `signedFeeOrders`: `SignedOrder`[], `feePercentage`: number, `feeRecipientAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* - -*Defined in [contract_wrappers/forwarder_wrapper.ts:168](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L168)* - -Attempt to purchase makerAssetFillAmount of makerAsset by selling ethAmount provided with transaction. -Any ZRX required to pay fees for primary orders will automatically be purchased by the contract. -Any ETH not spent will be refunded to sender. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of objects that conform to the SignedOrder interface. All orders must specify the same makerAsset. All orders must specify WETH as the takerAsset | -`makerAssetFillAmount` | `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. | -`ethAmount` | `BigNumber` | - | The amount of eth to send with the transaction (in wei). | -`signedFeeOrders` | `SignedOrder`[] | [] | An array of objects that conform to the SignedOrder interface. All orders must specify ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feePercentage` | number | 0 | The percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. Defaults to 0. | -`feeRecipientAddress` | string | constants.NULL_ADDRESS | The address that will receive ETH when signedFeeOrders are filled. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Transaction parameters. | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | **Returns:** *`Promise`* -Transaction hash. +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6283](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6283)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6276)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/exchange.ts:6271](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6271)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* ___ -### marketSellOrdersWithEthAsync +## VERSION -▸ **marketSellOrdersWithEthAsync**(`signedOrders`: `SignedOrder`[], `takerAddress`: string, `ethAmount`: `BigNumber`, `signedFeeOrders`: `SignedOrder`[], `feePercentage`: number, `feeRecipientAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +## ▪ **VERSION**: *object* -*Defined in [contract_wrappers/forwarder_wrapper.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/forwarder_wrapper.ts#L82)* +*Defined in [generated-wrappers/exchange.ts:6845](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6845)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6851](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6851)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6899](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6899)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6892](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6892)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/exchange.ts:6887](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6887)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## ZRX_ASSET_DATA + +## ▪ **ZRX_ASSET_DATA**: *object* + +*Defined in [generated-wrappers/exchange.ts:5823](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5823)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5829](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5829)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:5877](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5877)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:5870](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5870)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/exchange.ts:5865](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5865)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## allowedValidators + +## ▪ **allowedValidators**: *object* + +*Defined in [generated-wrappers/exchange.ts:3500](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3500)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3506](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3506)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:3569](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3569)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:3562](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3562)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:3552](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3552)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## assetProxies + +## ▪ **assetProxies**: *object* + +*Defined in [generated-wrappers/exchange.ts:1617](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1617)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1623](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1623)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:1673](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1673)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:1666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1666)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:1660](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1660)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## batchCancelOrders + +## ▪ **batchCancelOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:1684](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1684)* + +Synchronously cancels multiple orders in a single transaction. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:1739](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1739)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1823](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1823)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1779)* + +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 [generated-wrappers/exchange.ts:1916](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1916)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:1907](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1907)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* + +*Defined in [generated-wrappers/exchange.ts:1883](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1883)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1692](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1692)* + +Sends an 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 [generated-wrappers/exchange.ts:1925](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1925)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## batchFillOrKillOrders + +## ▪ **batchFillOrKillOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:1950](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1950)* + +Synchronously executes multiple calls of fillOrKill. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:2015](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2015)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2119)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. + +## estimateGasAsync + +▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2067](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2067)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:2245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2245)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:2224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2224)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:2196](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2196)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1961](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1961)* + +Sends an 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 [generated-wrappers/exchange.ts:2266](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2266)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## batchFillOrders + +## ▪ **batchFillOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:164](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L164)* + +Synchronously executes multiple calls of fillOrder. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:229](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L229)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:333](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.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 | 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` | - | - | + +**Returns:** *`Promise`* + +Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. + +## estimateGasAsync + +▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:281](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L281)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:459](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L459)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:438](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L438)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:410](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L410)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:175](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L175)* + +Sends an 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 [generated-wrappers/exchange.ts:480](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L480)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## batchFillOrdersNoThrow + +## ▪ **batchFillOrdersNoThrow**: *object* + +*Defined in [generated-wrappers/exchange.ts:2469](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2469)* + +Fills an order with specified parameters and ECDSA signature. +Returns false if the transaction would otherwise revert. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:2534](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2534)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2638](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2638)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. + +## estimateGasAsync + +▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2586](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2586)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:2764](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2764)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:2743](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2743)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:2715](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2715)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2480](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2480)* + +Sends an 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 [generated-wrappers/exchange.ts:2785](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2785)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmounts` | `BigNumber`[] | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## cancelOrder + +## ▪ **cancelOrder**: *object* + +*Defined in [generated-wrappers/exchange.ts:5490](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5490)* + +After calling, the order can not be filled anymore. +Throws if order is invalid or sender does not have permission to cancel. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:5544](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5544)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5626](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5626)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`order` | object | - | Order to cancel. Order must be OrderStatus.FILLABLE. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5583](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5583)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:5715](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5715)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:5706](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5706)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [generated-wrappers/exchange.ts:5685](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5685)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5498](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5498)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5724](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5724)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## cancelOrdersUpTo + +## ▪ **cancelOrdersUpTo**: *object* + +*Defined in [generated-wrappers/exchange.ts:2299](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2299)* + +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 [generated-wrappers/exchange.ts:2337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2337)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2391](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2391)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2365](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2365)* + +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 [generated-wrappers/exchange.ts:2449](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2449)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:2442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2442)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* + +*Defined in [generated-wrappers/exchange.ts:2434](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2434)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2308](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2308)* + +Sends an 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 [generated-wrappers/exchange.ts:2456](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2456)* + +**Parameters:** + +Name | Type | +------ | ------ | +`targetOrderEpoch` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## cancelled + +## ▪ **cancelled**: *object* + +*Defined in [generated-wrappers/exchange.ts:509](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L509)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:515](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L515)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:569](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L569)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:562](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L562)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:556](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L556)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +___ + +## currentContextAddress + +## ▪ **currentContextAddress**: *object* + +*Defined in [generated-wrappers/exchange.ts:6634](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6634)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6640](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6640)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6688](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6688)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6681](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6681)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/exchange.ts:6676](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6676)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## executeTransaction + +## ▪ **executeTransaction**: *object* + +*Defined in [generated-wrappers/exchange.ts:4955](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4955)* + +Executes an exchange method call in the context of signer. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:5011](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5011)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | +`signerAddress` | string | Address of transaction signer. | +`data` | string | AbiV2 encoded calldata. | +`signature` | string | Proof of signer transaction by signer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5095](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5095)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`salt` | `BigNumber` | - | Arbitrary number to ensure uniqueness of transaction hash. | +`signerAddress` | string | - | Address of transaction signer. | +`data` | string | - | AbiV2 encoded calldata. | +`signature` | string | - | Proof of signer transaction by signer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5053](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5053)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | +`signerAddress` | string | Address of transaction signer. | +`data` | string | AbiV2 encoded calldata. | +`signature` | string | Proof of signer transaction by signer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:5170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5170)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:5163](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5163)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:5151](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5151)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | +`signerAddress` | string | Address of transaction signer. | +`data` | string | AbiV2 encoded calldata. | +`signature` | string | Proof of signer transaction by signer. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4966](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4966)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | +`signerAddress` | string | Address of transaction signer. | +`data` | string | AbiV2 encoded calldata. | +`signature` | string | Proof of signer transaction by signer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5177](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5177)* + +**Parameters:** + +Name | Type | +------ | ------ | +`salt` | `BigNumber` | +`signerAddress` | string | +`data` | string | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## fillOrKillOrder + +## ▪ **fillOrKillOrder**: *object* + +*Defined in [generated-wrappers/exchange.ts:2959](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2959)* + +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 [generated-wrappers/exchange.ts:3021](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3021)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3120)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3071](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3071)* + +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 [generated-wrappers/exchange.ts:3243](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3243)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:3222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3222)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:3195](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3195)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2969](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2969)* + +Sends an 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 [generated-wrappers/exchange.ts:3264](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3264)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## fillOrder + +## ▪ **fillOrder**: *object* + +*Defined in [generated-wrappers/exchange.ts:4622](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4622)* + +Fills the input order. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:4684](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4684)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4779](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4779)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:4729](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4729)* + +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 [generated-wrappers/exchange.ts:4902](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4902)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:4881](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4881)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:4854](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4854)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4632](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4632)* + +Sends an 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 [generated-wrappers/exchange.ts:4923](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4923)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## fillOrderNoThrow + +## ▪ **fillOrderNoThrow**: *object* + +*Defined in [generated-wrappers/exchange.ts:1282](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1282)* + +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 [generated-wrappers/exchange.ts:1344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1344)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1444](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1444)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:1394](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1394)* + +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 [generated-wrappers/exchange.ts:1567](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1567)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:1546](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1546)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:1519](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1519)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1292](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1292)* + +Sends an 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 [generated-wrappers/exchange.ts:1588](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1588)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`takerAssetFillAmount` | `BigNumber` | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## filled + +## ▪ **filled**: *object* + +*Defined in [generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L93)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L99)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:153](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L153)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:146](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L146)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L140)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getAssetProxy + +## ▪ **getAssetProxy**: *object* + +*Defined in [generated-wrappers/exchange.ts:2817](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2817)* + +Gets an asset proxy. + +## callAsync + +▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2825](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2825)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:2880](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2880)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:2873](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2873)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:2867](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2867)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getOrderInfo + +## ▪ **getOrderInfo**: *object* + +*Defined in [generated-wrappers/exchange.ts:5363](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5363)* + +Gets information about an order: status, hash, and amount filled. + +## callAsync + +▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5371](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5371)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:5470](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5470)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:5455](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5455)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object): *string* + +*Defined in [generated-wrappers/exchange.ts:5434](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5434)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getOrdersInfo + +## ▪ **getOrdersInfo**: *object* + +*Defined in [generated-wrappers/exchange.ts:3923](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3923)* + +Fetches information for all passed in orders. + +## callAsync + +▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise>`* + +*Defined in [generated-wrappers/exchange.ts:3931](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3931)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise>`* + +Array of OrderInfo instances that correspond to each order. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [generated-wrappers/exchange.ts:4030](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4030)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`Array`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [generated-wrappers/exchange.ts:4017](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4017)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`Array`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* + +*Defined in [generated-wrappers/exchange.ts:3993](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3993)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## isValidSignature + +## ▪ **isValidSignature**: *object* + +*Defined in [generated-wrappers/exchange.ts:4186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4186)* + +Verifies that a hash has been signed by the given signer. + +## callAsync + +▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4196](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4196)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +True if the address recovered from the provided signature matches the input signer address. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:4267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4267)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:4260](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4260)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:4248](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4248)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## marketBuyOrders + +## ▪ **marketBuyOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:6294](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6294)* + +Synchronously executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:6357](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6357)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6459](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6459)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:6408](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6408)* + +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 [generated-wrappers/exchange.ts:6584](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6584)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:6563](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6563)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:6535](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6535)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6304](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6304)* + +Sends an 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 [generated-wrappers/exchange.ts:6605](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6605)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## marketBuyOrdersNoThrow + +## ▪ **marketBuyOrdersNoThrow**: *object* + +*Defined in [generated-wrappers/exchange.ts:4279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4279)* + +Synchronously executes multiple fill orders in a single transaction until total amount is bought by taker. +Returns false if the transaction would otherwise revert. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:4342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4342)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4444](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4444)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:4393](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4393)* + +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 [generated-wrappers/exchange.ts:4569](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4569)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:4548](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4548)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:4520](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4520)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4289](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4289)* + +Sends an 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 [generated-wrappers/exchange.ts:4590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4590)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`makerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## marketSellOrders + +## ▪ **marketSellOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:3580](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3580)* + +Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:3643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3643)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3745](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3745)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`orders` | `Array` | - | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | - | Desired amount of takerAsset to sell. | +`signatures` | string[] | - | Proofs that orders have been created by makers. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**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 [generated-wrappers/exchange.ts:3694](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3694)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:3870](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3870)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:3849](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3849)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:3821](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3821)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been created by makers. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3590)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3891](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3891)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## marketSellOrdersNoThrow + +## ▪ **marketSellOrdersNoThrow**: *object* + +*Defined in [generated-wrappers/exchange.ts:5889](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5889)* + +Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. +Returns false if the transaction would otherwise revert. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:5952](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5952)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6054](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6054)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:6003](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6003)* + +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 [generated-wrappers/exchange.ts:6179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6179)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:6158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6158)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* + +*Defined in [generated-wrappers/exchange.ts:6130](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6130)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5899](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5899)* + +Sends an 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 [generated-wrappers/exchange.ts:6200](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6200)* + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAssetFillAmount` | `BigNumber` | +`signatures` | string[] | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## matchOrders + +## ▪ **matchOrders**: *object* + +*Defined in [generated-wrappers/exchange.ts:798](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L798)* + +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 [generated-wrappers/exchange.ts:876](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L876)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:1007](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1007)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/exchange.ts:942](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L942)* + +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 [generated-wrappers/exchange.ts:1195](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1195)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/exchange.ts:1156](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1156)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:1115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.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). + +**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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:809](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L809)* + +Sends an 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 [generated-wrappers/exchange.ts:1234](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1234)* + +**Parameters:** + +Name | Type | +------ | ------ | +`leftOrder` | object | +`rightOrder` | object | +`leftSignature` | string | +`rightSignature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## orderEpoch + +## ▪ **orderEpoch**: *object* + +*Defined in [generated-wrappers/exchange.ts:5746](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5746)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5752](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5752)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:5815](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5815)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:5808](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5808)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:5798](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5798)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | + +**Returns:** *string* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/exchange.ts:4121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4121)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4127](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4127)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:4175](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4175)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:4168](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4168)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/exchange.ts:4163](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4163)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## preSign + +## ▪ **preSign**: *object* + +*Defined in [generated-wrappers/exchange.ts:581](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L581)* + +Approves a hash on-chain using any valid signature type. +After presigning a hash, the preSign signature type will become valid for that hash and signer. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:630](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L630)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | - | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | +`txData?` | `Partial` | Additional data for transaction | +`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | +`timeoutMs?` | undefined \| number | - | + +**Returns:** *`PromiseWithTransactionHash`* + +A promise that resolves when the transaction is successful + +## callAsync + +▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:704](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L704)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | - | +`signerAddress` | string | - | Address that should have signed the given hash. | +`signature` | string | - | Proof that the hash has been signed by signer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:667](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L667)* + +Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | - | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:774](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L774)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:767](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L767)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L755)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | - | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L590)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | - | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof that the hash has been signed by signer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## validateAndSendTransactionAsync + +▸ **validateAndSendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:781](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L781)* + +**Parameters:** + +Name | Type | +------ | ------ | +`hash` | string | +`signerAddress` | string | +`signature` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## preSigned + +## ▪ **preSigned**: *object* + +*Defined in [generated-wrappers/exchange.ts:4044](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4044)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:4050](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4050)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:4113](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4113)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:4106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4106)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:4096](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4096)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## registerAssetProxy + +## ▪ **registerAssetProxy**: *object* + +*Defined in [generated-wrappers/exchange.ts:5199](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5199)* + +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 [generated-wrappers/exchange.ts:5235](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5235)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5287](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5287)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5262](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5262)* + +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 [generated-wrappers/exchange.ts:5344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5344)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:5337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5337)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:5329](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5329)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:5207](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5207)* + +Sends an 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 [generated-wrappers/exchange.ts:5351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5351)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetProxy` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## setSignatureValidatorApproval + +## ▪ **setSignatureValidatorApproval**: *object* + +*Defined in [generated-wrappers/exchange.ts:3296](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3296)* + +Approves/unnapproves a Validator contract to verify signatures on signer's behalf. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:3346](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3346)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3414](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3414)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3380](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3380)* + +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 [generated-wrappers/exchange.ts:3479](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3479)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:3472](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3472)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* + +*Defined in [generated-wrappers/exchange.ts:3462](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3462)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:3305](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3305)* + +Sends an 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 [generated-wrappers/exchange.ts:3486](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3486)* + +**Parameters:** + +Name | Type | +------ | ------ | +`validatorAddress` | string | +`approval` | boolean | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transactions + +## ▪ **transactions**: *object* + +*Defined in [generated-wrappers/exchange.ts:2888](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2888)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:2894](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2894)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:2948](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2948)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/exchange.ts:2941](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2941)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:2935](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2935)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/exchange.ts:6696](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6696)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/exchange.ts:6730](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6730)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6780](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6780)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6756](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6756)* + +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 [generated-wrappers/exchange.ts:6832](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6832)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/exchange.ts:6825](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6825)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/exchange.ts:6817](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6817)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/exchange.ts:6703](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6703)* + +Sends an 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 [generated-wrappers/exchange.ts:6839](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6839)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ForwarderContract + +### Hierarchy + +* `BaseContract` + + * **ForwarderContract** + + +### Constructors + +## constructer + +\+ **new ForwarderContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ForwarderContract](#class-forwardercontract)* + +*Overrides void* + +*Defined in [generated-wrappers/forwarder.ts:2135](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L2135)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ForwarderContract](#class-forwardercontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/forwarder.ts:1696](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1696)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:1647](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1647)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | +`_wethAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:1610](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1610)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | +`_wethAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## marketBuyOrdersWithEth + +## ▪ **marketBuyOrdersWithEth**: *object* + +*Defined in [generated-wrappers/forwarder.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L35)* + +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 [generated-wrappers/forwarder.ts:150](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L150)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | 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`): *`Promise<[object, object]>`* + +*Defined in [generated-wrappers/forwarder.ts:320](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L320)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**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 [generated-wrappers/forwarder.ts:233](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L233)* + +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 [generated-wrappers/forwarder.ts:548](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L548)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[object, object]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, object]* + +*Defined in [generated-wrappers/forwarder.ts:509](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L509)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[object, object]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* + +*Defined in [generated-wrappers/forwarder.ts:452](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L452)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L52)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | 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 [generated-wrappers/forwarder.ts:587](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L587)* + +**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 [generated-wrappers/forwarder.ts:902](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L902)* 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 [generated-wrappers/forwarder.ts:1004](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1004)* + +Sends an Ethereum transaction and waits 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`): *`Promise<[object, object]>`* + +*Defined in [generated-wrappers/forwarder.ts:1159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1159)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`signedOrders` | `SignedOrder`[] | - | An array of objects that conform to the SignedOrder interface. All orders must specify the same makerAsset. All orders must specify WETH as the takerAsset | -`takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | -`ethAmount` | `BigNumber` | - | The amount of eth to send with the transaction (in wei). | -`signedFeeOrders` | `SignedOrder`[] | [] | An array of objects that conform to the SignedOrder interface. All orders must specify ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feePercentage` | number | 0 | The percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. Defaults to 0. | -`feeRecipientAddress` | string | constants.NULL_ADDRESS | The address that will receive ETH when signedFeeOrders are filled. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Transaction parameters. | +`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` | - | - | + +**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 [generated-wrappers/forwarder.ts:1083](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1083)* + +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 [generated-wrappers/forwarder.ts:1366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1366)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[object, object]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, object]* + +*Defined in [generated-wrappers/forwarder.ts:1327](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1327)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[object, object]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* + +*Defined in [generated-wrappers/forwarder.ts:1280](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1280)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:918](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L918)* + +Sends an 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`* -Transaction hash. +The hash of the transaction -
+## validateAndSendTransactionAsync -> # Class: OrderValidatorWrapper +▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* -This class includes the functionality related to interacting with the OrderValidator contract. - -## Hierarchy - -* **OrderValidatorWrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) - -### Methods - -* [getBalanceAndAllowanceAsync](#getbalanceandallowanceasync) -* [getBalancesAndAllowancesAsync](#getbalancesandallowancesasync) -* [getERC721TokenOwnerAsync](#geterc721tokenownerasync) -* [getOrderAndTraderInfoAsync](#getorderandtraderinfoasync) -* [getOrdersAndTradersInfoAsync](#getordersandtradersinfoasync) -* [getTraderInfoAsync](#gettraderinfoasync) -* [getTradersInfoAsync](#gettradersinfoasync) - -## Constructors - -### constructor - -\+ **new OrderValidatorWrapper**(`web3Wrapper`: `Web3Wrapper`, `networkId`: number, `address?`: undefined | string): *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L21)* - -Instantiate OrderValidatorWrapper - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`web3Wrapper` | `Web3Wrapper` | Web3Wrapper instance to use. | -`networkId` | number | Desired networkId. | -`address?` | undefined \| string | The address of the OrderValidator contract. If undefined, will default to the known address corresponding to the networkId. | - -**Returns:** *[OrderValidatorWrapper](#class-ordervalidatorwrapper)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* = OrderValidator.compilerOutput.abi - -*Defined in [contract_wrappers/order_validator_wrapper.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L18)* - -___ - -### address - -• **address**: *string* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L19)* - -## Methods - -### getBalanceAndAllowanceAsync - -▸ **getBalanceAndAllowanceAsync**(`address`: string, `assetData`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L120)* - -Get an object conforming to BalanceAndAllowance containing on-chain balance and allowance for some address and assetData - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | An ethereum address | -`assetData` | string | An encoded string that can be decoded by a specified proxy contract | - -**Returns:** *`Promise`* - -BalanceAndAllowance - -___ - -### getBalancesAndAllowancesAsync - -▸ **getBalancesAndAllowancesAsync**(`address`: string, `assetDatas`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:139](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L139)* - -Get an array of objects conforming to BalanceAndAllowance containing on-chain balance and allowance for some address and array of assetDatas - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | An ethereum address | -`assetDatas` | string[] | An array of encoded strings that can be decoded by a specified proxy contract | - -**Returns:** *`Promise`* - -BalanceAndAllowance - -___ - -### getERC721TokenOwnerAsync - -▸ **getERC721TokenOwnerAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L163)* - -Get owner address of tokenId by calling `token.ownerOf(tokenId)`, but returns a null owner instead of reverting on an unowned token. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | An ethereum address | -`tokenId` | `BigNumber` | An ERC721 tokenId | - -**Returns:** *`Promise`* - -Owner of tokenId or null address if unowned - -___ - -### getOrderAndTraderInfoAsync - -▸ **getOrderAndTraderInfoAsync**(`order`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L44)* - -Get an object conforming to OrderAndTraderInfo containing on-chain information of the provided order and address - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `SignedOrder` | An object conforming to SignedOrder | -`takerAddress` | string | An ethereum address | - -**Returns:** *`Promise`* - -OrderAndTraderInfo - -___ - -### getOrdersAndTradersInfoAsync - -▸ **getOrdersAndTradersInfoAsync**(`orders`: `SignedOrder`[], `takerAddresses`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L63)* - -Get an array of objects conforming to OrderAndTraderInfo containing on-chain information of the provided orders and addresses - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects conforming to SignedOrder | -`takerAddresses` | string[] | An array of ethereum addresses | - -**Returns:** *`Promise`* - -array of OrderAndTraderInfo - -___ - -### getTraderInfoAsync - -▸ **getTraderInfoAsync**(`order`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L93)* - -Get an object conforming to TraderInfo containing on-chain balance and allowances for maker and taker of order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `SignedOrder` | An object conforming to SignedOrder | -`takerAddress` | string | An ethereum address | - -**Returns:** *`Promise`* - -TraderInfo - -___ - -### getTradersInfoAsync - -▸ **getTradersInfoAsync**(`orders`: `SignedOrder`[], `takerAddresses`: string[]): *`Promise`* - -*Defined in [contract_wrappers/order_validator_wrapper.ts:105](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/contract_wrappers/order_validator_wrapper.ts#L105)* - -Get an array of objects conforming to TraderInfo containing on-chain balance and allowances for maker and taker of order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of objects conforming to SignedOrder | -`takerAddresses` | string[] | An array of ethereum addresses | - -**Returns:** *`Promise`* - -array of TraderInfo - -
- -> # Class: AssetBalanceAndProxyAllowanceFetcher - -## Hierarchy - -* **AssetBalanceAndProxyAllowanceFetcher** - -## Implements - -* `AbstractBalanceAndProxyAllowanceFetcher` - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getBalanceAsync](#getbalanceasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) - -## Constructors - -### constructor - -\+ **new AssetBalanceAndProxyAllowanceFetcher**(`erc20Token`: [ERC20TokenWrapper](#class-assetbalanceandproxyallowancefetcher)* - -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L12)* +*Defined in [generated-wrappers/forwarder.ts:1405](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1405)* **Parameters:** Name | Type | ------ | ------ | -`erc20Token` | [ERC20TokenWrapper](#class-erc20tokenwrapper) | -`erc721Token` | [ERC721TokenWrapper](#class-erc721tokenwrapper) | -`stateLayer` | `BlockParamLiteral` | +`orders` | `Array` | +`signatures` | string[] | +`feeOrders` | `Array` | +`feeSignatures` | string[] | +`feePercentage` | `BigNumber` | +`feeRecipient` | string | +`txData?` | `Partial` \| undefined | -**Returns:** *[AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher)* - -## Methods - -### getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L18)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ -### getProxyAllowanceAsync +## owner -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* +## ▪ **owner**: *object* -*Defined in [fetchers/asset_balance_and_proxy_allowance_fetcher.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/asset_balance_and_proxy_allowance_fetcher.ts#L49)* +*Defined in [generated-wrappers/forwarder.ts:834](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L834)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:840](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L840)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/forwarder.ts:888](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L888)* **Parameters:** Name | Type | ------ | ------ | -`assetData` | string | -`userAddress` | string | +`returnData` | string | -**Returns:** *`Promise`* +**Returns:** *string* -
+## getABIDecodedTransactionData -> # Class: OrderFilledCancelledFetcher +▸ **getABIDecodedTransactionData**(`callData`: string): *string* -## Hierarchy - -* **OrderFilledCancelledFetcher** - -## Implements - -* `AbstractOrderFilledCancelledFetcher` - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getFilledTakerAmountAsync](#getfilledtakeramountasync) -* [getZRXAssetData](#getzrxassetdata) -* [isOrderCancelledAsync](#isordercancelledasync) - -## Constructors - -### constructor - -\+ **new OrderFilledCancelledFetcher**(`exchange`: [ExchangeWrapper](#class-orderfilledcancelledfetcher)* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L11)* +*Defined in [generated-wrappers/forwarder.ts:881](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L881)* **Parameters:** Name | Type | ------ | ------ | -`exchange` | [ExchangeWrapper](#class-exchangewrapper) | -`stateLayer` | `BlockParamLiteral` | +`callData` | string | -**Returns:** *[OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher)* +**Returns:** *string* -## Methods +## getABIEncodedTransactionData -### getFilledTakerAmountAsync +▸ **getABIEncodedTransactionData**(): *string* -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* +*Defined in [generated-wrappers/forwarder.ts:876](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L876)* -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L16)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *`Promise`* - -___ - -### getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L35)* +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* ___ -### isOrderCancelledAsync +## transferOwnership -▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* +## ▪ **transferOwnership**: *object* -*Defined in [fetchers/order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/fetchers/order_filled_cancelled_fetcher.ts#L22)* +*Defined in [generated-wrappers/forwarder.ts:1461](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1461)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/forwarder.ts:1495](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1495)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:1545](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1545)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:1521](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1521)* + +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 [generated-wrappers/forwarder.ts:1597](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1597)* **Parameters:** Name | Type | ------ | ------ | -`signedOrder` | `SignedOrder` | +`returnData` | string | -**Returns:** *`Promise`* +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/forwarder.ts:1590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1590)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/forwarder.ts:1582](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1582)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:1468](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1468)* + +Sends an 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 [generated-wrappers/forwarder.ts:1604](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1604)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## withdrawAsset + +## ▪ **withdrawAsset**: *object* + +*Defined in [generated-wrappers/forwarder.ts:651](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L651)* + +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 [generated-wrappers/forwarder.ts:694](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L694)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L755)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:724](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L724)* + +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 [generated-wrappers/forwarder.ts:817](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L817)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/forwarder.ts:810](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L810)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* + +*Defined in [generated-wrappers/forwarder.ts:800](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L800)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/forwarder.ts:660](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L660)* + +Sends an 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 [generated-wrappers/forwarder.ts:824](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L824)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | +`amount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`*
-> # Class: CoordinatorServerError +# Class: IAssetProxyContract -## Hierarchy +### Hierarchy + +* `BaseContract` + + * **IAssetProxyContract** + + +### Constructors + +## constructer + +\+ **new IAssetProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IAssetProxyContract](#class-iassetproxycontract)* + +*Overrides void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1250](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1250)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[IAssetProxyContract](#class-iassetproxycontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1132](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1132)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1090](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1090)* + +**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_asset_proxy.ts:1065](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1065)* + +**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 + +## addAuthorizedAddress + +## ▪ **addAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L33)* + +Authorizes an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:69](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L69)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L121)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`target` | string | - | Address to authorize. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L96)* + +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 [generated-wrappers/i_asset_proxy.ts:174](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L174)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:167](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L167)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L159)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L41)* + +Sends an 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 [generated-wrappers/i_asset_proxy.ts:181](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L181)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## getAuthorizedAddresses + +## ▪ **getAuthorizedAddresses**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:853](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L853)* + +Gets all authorized addresses. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:860](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L860)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/i_asset_proxy.ts:908](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L908)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/i_asset_proxy.ts:901](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L901)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:896](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L896)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## getProxyId + +## ▪ **getProxyId**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:787](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L787)* + +Gets the proxy id associated with the proxy address. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:794](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L794)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Proxy id. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:842](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L842)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:835](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L835)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:830](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L830)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## removeAuthorizedAddress + +## ▪ **removeAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L190)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L226)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:278](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L278)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:253](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L253)* + +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 [generated-wrappers/i_asset_proxy.ts:331](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L331)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:324](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L324)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:316](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.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). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:198](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L198)* + +Sends an 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 [generated-wrappers/i_asset_proxy.ts:338](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L338)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## removeAuthorizedAddressAtIndex + +## ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L347)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:393](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L393)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:461](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L461)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L427)* + +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 [generated-wrappers/i_asset_proxy.ts:526](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L526)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:519](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L519)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:509](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L509)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L356)* + +Sends an 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 [generated-wrappers/i_asset_proxy.ts:533](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L533)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:550](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L550)* + +Transfers 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 [generated-wrappers/i_asset_proxy.ts:606](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L606)* + +Sends an Ethereum transaction and waits 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. | +`from` | string | Address to transfer asset from. | +`to` | string | Address to transfer asset to. | +`amount` | `BigNumber` | Amount of asset 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**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:690](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L690)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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. | +`from` | string | - | Address to transfer asset from. | +`to` | string | - | Address to transfer asset to. | +`amount` | `BigNumber` | - | Amount of asset to transfer. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:648](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L648)* + +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. | +`from` | string | Address to transfer asset from. | +`to` | string | Address to transfer asset to. | +`amount` | `BigNumber` | Amount of asset to transfer. | +`txData?` | `Partial` \| undefined | Additional data for transaction | + +**Returns:** *`Promise`* + +The hash of the transaction + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:765](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L765)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:758](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L758)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:746](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L746)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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. | +`from` | string | Address to transfer asset from. | +`to` | string | Address to transfer asset to. | +`amount` | `BigNumber` | Amount of asset to transfer. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:561](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L561)* + +Sends an 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. | +`from` | string | Address to transfer asset from. | +`to` | string | Address to transfer asset to. | +`amount` | `BigNumber` | Amount of asset to transfer. | +`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 [generated-wrappers/i_asset_proxy.ts:772](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L772)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | +`from` | string | +`to` | string | +`amount` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/i_asset_proxy.ts:916](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L916)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:950](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L950)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1000](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1000)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:976](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L976)* + +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 [generated-wrappers/i_asset_proxy.ts:1052](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1052)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1045](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1045)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/i_asset_proxy.ts:1037](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1037)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/i_asset_proxy.ts:923](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L923)* + +Sends an 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 [generated-wrappers/i_asset_proxy.ts:1059](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1059)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: IValidatorContract + +### Hierarchy + +* `BaseContract` + + * **IValidatorContract** + + +### Constructors + +## constructer + +\+ **new IValidatorContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IValidatorContract](#class-ivalidatorcontract)* + +*Overrides void* + +*Defined in [generated-wrappers/i_validator.ts:220](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L220)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/i_validator.ts:189](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L189)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/i_validator.ts:147](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L147)* + +**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_validator.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L122)* + +**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_validator.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L33)* + +Verifies that a signature is valid. + +## callAsync + +▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/i_validator.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L43)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`hash` | string | - | Message hash that is signed. | +`signerAddress` | string | - | Address that should have signed the given hash. | +`signature` | string | - | Proof of signing. | +`callData` | `Partial` | {} | - | +`defaultBlock?` | `BlockParam` | - | - | + +**Returns:** *`Promise`* + +Validity of order signature. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/i_validator.ts:114](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L114)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/i_validator.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.ts#L107)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/i_validator.ts:95](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_validator.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. | +`signerAddress` | string | Address that should have signed the given hash. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +
+ +# Class: IWalletContract + +### Hierarchy + +* `BaseContract` + + * **IWalletContract** + + +### Constructors + +## constructer + +\+ **new IWalletContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IWalletContract](#class-iwalletcontract)* + +*Overrides void* + +*Defined in [generated-wrappers/i_wallet.ts:206](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/i_wallet.ts:179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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`* + +Validity of order signature. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L104)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/i_wallet.ts:97](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L97)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* + +*Defined in [generated-wrappers/i_wallet.ts:87](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signature` | string | Proof of signing. | + +**Returns:** *string* + +
+ +# Class: MultiAssetProxyContract + +### Hierarchy + +* `BaseContract` + + * **MultiAssetProxyContract** + + +### Constructors + +## constructer + +\+ **new MultiAssetProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[MultiAssetProxyContract](#class-multiassetproxycontract)* + +*Overrides void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1758](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1758)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[MultiAssetProxyContract](#class-multiassetproxycontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [MultiAssetProxyEvents](#enumeration-multiassetproxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1742](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1742)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[MultiAssetProxyEventArgs](#multiassetproxyeventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [MultiAssetProxyEvents](#enumeration-multiassetproxyevents) | The MultiAssetProxy 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`: [MultiAssetProxyEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1700](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1700)* + +Subscribe to an event type emitted by the MultiAssetProxy contract. + +**Type parameters:** + +▪ **ArgsType**: *[MultiAssetProxyEventArgs](#multiassetproxyeventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [MultiAssetProxyEvents](#enumeration-multiassetproxyevents) | - | The MultiAssetProxy 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 [generated-wrappers/multi_asset_proxy.ts:1725](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1725)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1731](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1731)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1433](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1433)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1391](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1391)* + +**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/multi_asset_proxy.ts:1366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1366)* + +**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 + +## addAuthorizedAddress + +## ▪ **addAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:131](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L131)* + +Authorizes an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:167](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L167)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:219](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L219)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:194](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L194)* + +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 [generated-wrappers/multi_asset_proxy.ts:272](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L272)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:265](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L265)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:257](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L257)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:139](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L139)* + +Sends an 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 [generated-wrappers/multi_asset_proxy.ts:279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L279)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## assetProxies + +## ▪ **assetProxies**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L64)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L70)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L120)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:113](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L113)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L107)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## authorities + +## ▪ **authorities**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:285](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L285)* + +## callAsync + +▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:291](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L291)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L345)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:338](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L338)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:332](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L332)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## authorized + +## ▪ **authorized**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:915](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L915)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:921](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_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 | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:977](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L977)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:970](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L970)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:962](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L962)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *string* + +___ + +## getAssetProxy + +## ▪ **getAssetProxy**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L356)* + +Gets an asset proxy. + +## callAsync + +▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:364](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L364)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:419](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L419)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:412](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L412)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:406](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L406)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +___ + +## getAuthorizedAddresses + +## ▪ **getAuthorizedAddresses**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1153](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1153)* + +Gets all authorized addresses. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1160](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1160)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Array of authorized addresses. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1208](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1208)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string[]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1201](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1201)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string[]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1196](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1196)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## getProxyId + +## ▪ **getProxyId**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:852](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L852)* + +Gets the proxy id associated with the proxy address. + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:859](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L859)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +Proxy id. + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:907](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L907)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:900](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L900)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:895](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L895)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## owner + +## ▪ **owner**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:584](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L584)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:590](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L590)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:638](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L638)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:631](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L631)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:626](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L626)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +___ + +## registerAssetProxy + +## ▪ **registerAssetProxy**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:989](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L989)* + +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 [generated-wrappers/multi_asset_proxy.ts:1025](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1025)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1077](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1077)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1052](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1052)* + +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 [generated-wrappers/multi_asset_proxy.ts:1134](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1134)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1127](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1127)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1119)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:997](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L997)* + +Sends an 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 [generated-wrappers/multi_asset_proxy.ts:1141](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1141)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetProxy` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## removeAuthorizedAddress + +## ▪ **removeAuthorizedAddress**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L430)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:466](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L466)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:518](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L518)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L493)* + +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 [generated-wrappers/multi_asset_proxy.ts:571](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L571)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:564](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L564)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:556](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L556)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:438](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L438)* + +Sends an 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 [generated-wrappers/multi_asset_proxy.ts:578](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L578)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## removeAuthorizedAddressAtIndex + +## ▪ **removeAuthorizedAddressAtIndex**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:649](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L649)* + +Removes authorizion of an address. + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:695](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L695)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:763](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L763)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:729](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L729)* + +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 [generated-wrappers/multi_asset_proxy.ts:828](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L828)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:821](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L821)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:811](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L811)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:658](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L658)* + +Sends an 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 [generated-wrappers/multi_asset_proxy.ts:835](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L835)* + +**Parameters:** + +Name | Type | +------ | ------ | +`target` | string | +`index` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferOwnership + +## ▪ **transferOwnership**: *object* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1216](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1216)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1250](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1250)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1300](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1300)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1276)* + +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 [generated-wrappers/multi_asset_proxy.ts:1352](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1352)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1345)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1337)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:1223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1223)* + +Sends an 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 [generated-wrappers/multi_asset_proxy.ts:1359](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1359)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: OrderValidatorContract + +### Hierarchy + +* `BaseContract` + + * **OrderValidatorContract** + + +### Constructors + +## constructer + +\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[OrderValidatorContract](#class-ordervalidatorcontract)* + +*Overrides void* + +*Defined in [generated-wrappers/order_validator.ts:1641](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L1641)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/order_validator.ts:1080](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L1080)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/order_validator.ts:1032](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L1032)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | `ContractAbi` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* + +*Defined in [generated-wrappers/order_validator.ts:997](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L997)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | `SupportedProvider` | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | + +**Returns:** *`Promise`* + +___ + +## `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + + + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +### Object literals + +## getBalanceAndAllowance + +## ▪ **getBalanceAndAllowance**: *object* + +*Defined in [generated-wrappers/order_validator.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L224)* + +## callAsync + +▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[BigNumber, BigNumber]>`* + +*Defined in [generated-wrappers/order_validator.ts:230](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.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 | +------ | ------ | ------ | +`target` | string | - | +`assetData` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise<[BigNumber, BigNumber]>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [generated-wrappers/order_validator.ts:293](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L293)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`, `BigNumber`]* + +*Defined in [generated-wrappers/order_validator.ts:286](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L286)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`BigNumber`, `BigNumber`]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string): *string* + +*Defined in [generated-wrappers/order_validator.ts:276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L276)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getBalancesAndAllowances + +## ▪ **getBalancesAndAllowances**: *object* + +*Defined in [generated-wrappers/order_validator.ts:752](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L752)* + +## callAsync + +▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[BigNumber[], BigNumber[]]>`* + +*Defined in [generated-wrappers/order_validator.ts:758](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L758)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [generated-wrappers/order_validator.ts:821](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L821)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`[], `BigNumber`[]]* + +*Defined in [generated-wrappers/order_validator.ts:814](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L814)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`BigNumber`[], `BigNumber`[]]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string[]): *string* + +*Defined in [generated-wrappers/order_validator.ts:804](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L804)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getERC721TokenOwner + +## ▪ **getERC721TokenOwner**: *object* + +*Defined in [generated-wrappers/order_validator.ts:675](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L675)* + +## callAsync + +▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/order_validator.ts:681](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L681)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/order_validator.ts:744](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L744)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/order_validator.ts:737](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L737)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`token`: string, `tokenId`: `BigNumber`): *string* + +*Defined in [generated-wrappers/order_validator.ts:727](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L727)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getOrderAndTraderInfo + +## ▪ **getOrderAndTraderInfo**: *object* + +*Defined in [generated-wrappers/order_validator.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L30)* + +## callAsync + +▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[object, object]>`* + +*Defined in [generated-wrappers/order_validator.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L36)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise<[object, object]>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* + +*Defined in [generated-wrappers/order_validator.ts:186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L186)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[object, object]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[object, object]* + +*Defined in [generated-wrappers/order_validator.ts:149](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L149)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[object, object]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* + +*Defined in [generated-wrappers/order_validator.ts:124](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L124)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getOrdersAndTradersInfo + +## ▪ **getOrdersAndTradersInfo**: *object* + +*Defined in [generated-wrappers/order_validator.ts:301](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L301)* + +## callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[Array, Array]>`* + +*Defined in [generated-wrappers/order_validator.ts:307](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L307)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise<[Array, Array]>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `Array`]* + +*Defined in [generated-wrappers/order_validator.ts:459](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L459)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *[`Array`, `Array`]* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, `Array`]* + +*Defined in [generated-wrappers/order_validator.ts:422](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L422)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *[`Array`, `Array`]* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* + +*Defined in [generated-wrappers/order_validator.ts:396](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L396)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getTraderInfo + +## ▪ **getTraderInfo**: *object* + +*Defined in [generated-wrappers/order_validator.ts:829](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L829)* + +## callAsync + +▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/order_validator.ts:835](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L835)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *object* + +*Defined in [generated-wrappers/order_validator.ts:967](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L967)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *object* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *object* + +*Defined in [generated-wrappers/order_validator.ts:938](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L938)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *object* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* + +*Defined in [generated-wrappers/order_validator.ts:913](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L913)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## getTradersInfo + +## ▪ **getTradersInfo**: *object* + +*Defined in [generated-wrappers/order_validator.ts:497](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L497)* + +## callAsync + +▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise>`* + +*Defined in [generated-wrappers/order_validator.ts:503](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L503)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`orders` | `Array` | - | +`takerAddresses` | string[] | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise>`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* + +*Defined in [generated-wrappers/order_validator.ts:643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L643)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`Array`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* + +*Defined in [generated-wrappers/order_validator.ts:612](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L612)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`Array`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* + +*Defined in [generated-wrappers/order_validator.ts:586](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/order_validator.ts#L586)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Parameters:** + +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | + +**Returns:** *string* + +
+ +# Class: WETH9Contract + +### Hierarchy + +* `BaseContract` + + * **WETH9Contract** + + +### Constructors + +## constructer + +\+ **new WETH9Contract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[WETH9Contract](#class-weth9contract)* + +*Overrides void* + +*Defined in [generated-wrappers/weth9.ts:1710](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1710)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[WETH9Contract](#class-weth9contract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/weth9.ts:1694](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1694)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/weth9.ts:1652](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1652)* + +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 [generated-wrappers/weth9.ts:1677](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1677)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/weth9.ts:1683](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1683)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/weth9.ts:1355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1355)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:1313](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1313)* + +**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/weth9.ts:1288](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1288)* + +**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 + +## allowance + +## ▪ **allowance**: *object* + +*Defined in [generated-wrappers/weth9.ts:1210](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1210)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:1216](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1216)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:1279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1279)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:1272](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1272)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:1262](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1262)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/weth9.ts:135](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L135)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/weth9.ts:170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L170)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L223)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:198](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L198)* + +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 [generated-wrappers/weth9.ts:283](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L283)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/weth9.ts:276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L276)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* + +*Defined in [generated-wrappers/weth9.ts:266](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.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 | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | + +**Returns:** *string* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:142](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.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 | +------ | ------ | ------ | +`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 [generated-wrappers/weth9.ts:290](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L290)* + +**Parameters:** + +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## balanceOf + +## ▪ **balanceOf**: *object* + +*Defined in [generated-wrappers/weth9.ts:772](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L772)* + +## callAsync + +▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:778](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L778)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`index_0` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:834](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L834)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:827](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L827)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`index_0`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:819](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L819)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## decimals + +## ▪ **decimals**: *object* + +*Defined in [generated-wrappers/weth9.ts:710](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L710)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:716](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L716)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [generated-wrappers/weth9.ts:764](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L764)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *number* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *number* + +*Defined in [generated-wrappers/weth9.ts:757](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L757)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *number* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/weth9.ts:752](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-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). + +**Returns:** *string* + +___ + +## deposit + +## ▪ **deposit**: *object* + +*Defined in [generated-wrappers/weth9.ts:1069](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1069)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/weth9.ts:1102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1102)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:1149](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1149)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:1126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1126)* + +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 [generated-wrappers/weth9.ts:1197](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1197)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/weth9.ts:1190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1190)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/weth9.ts:1185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1185)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:1076](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1076)* + +Sends an 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 [generated-wrappers/weth9.ts:1204](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1204)* + +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## name + +## ▪ **name**: *object* + +*Defined in [generated-wrappers/weth9.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L73)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L79)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:127](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L127)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L120)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/weth9.ts:115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L115)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## symbol + +## ▪ **symbol**: *object* + +*Defined in [generated-wrappers/weth9.ts:842](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L842)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:848](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L848)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:896](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L896)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/weth9.ts:889](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L889)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/weth9.ts:884](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L884)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## totalSupply + +## ▪ **totalSupply**: *object* + +*Defined in [generated-wrappers/weth9.ts:300](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L300)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:306](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L306)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:354](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L354)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L347)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/weth9.ts:342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L342)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used +to create a 0x transaction (see protocol spec for more details). + +**Returns:** *string* + +___ + +## transfer + +## ▪ **transfer**: *object* + +*Defined in [generated-wrappers/weth9.ts:904](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L904)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/weth9.ts:939](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L939)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:992](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L992)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:967](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L967)* + +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 [generated-wrappers/weth9.ts:1052](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1052)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/weth9.ts:1045](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1045)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [generated-wrappers/weth9.ts:1035](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1035)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:911](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L911)* + +Sends an 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 [generated-wrappers/weth9.ts:1059](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1059)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/weth9.ts:362](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L362)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/weth9.ts:407](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L407)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:477](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L477)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L442)* + +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 [generated-wrappers/weth9.ts:545](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L545)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/weth9.ts:538](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L538)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* + +*Defined in [generated-wrappers/weth9.ts:526](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L526)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:369](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L369)* + +Sends an 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 [generated-wrappers/weth9.ts:552](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L552)* + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## withdraw + +## ▪ **withdraw**: *object* + +*Defined in [generated-wrappers/weth9.ts:563](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L563)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/weth9.ts:597](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L597)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:647](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.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 | +------ | ------ | ------ | +`wad` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:623](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L623)* + +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 [generated-wrappers/weth9.ts:697](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L697)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *void* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *void* + +*Defined in [generated-wrappers/weth9.ts:690](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L690)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *void* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* + +*Defined in [generated-wrappers/weth9.ts:684](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L684)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/weth9.ts:570](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L570)* + +Sends an 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 [generated-wrappers/weth9.ts:704](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L704)* + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: ZRXTokenContract + +### Hierarchy + +* `BaseContract` + + * **ZRXTokenContract** + + +### Constructors + +## constructer + +\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ZRXTokenContract](#class-zrxtokencontract)* + +*Overrides void* + +*Defined in [generated-wrappers/zrx_token.ts:1375](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1375)* + +**Parameters:** + +Name | Type | +------ | ------ | +`address` | string | +`supportedProvider` | `SupportedProvider` | +`txDefaults?` | `Partial` | +`logDecodeDependencies?` | undefined \| object | + +**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* + +### Properties + +## abi + +• **abi**: *`ContractAbi`* + + + + + +___ + +## address + +• **address**: *string* + + + + + +___ + +## constructerArgs + +• **constructorArgs**: *any[]* + + + + + +___ + +## contractName + +• **contractName**: *string* + + + + + +### Methods + +## getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [generated-wrappers/zrx_token.ts:1359](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1359)* + +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](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [generated-wrappers/zrx_token.ts:1317](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1317)* + +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 [generated-wrappers/zrx_token.ts:1342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1342)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +## unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [generated-wrappers/zrx_token.ts:1348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1348)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +## `Static` ABI + +▸ **ABI**(): *`ContractAbi`* + +*Defined in [generated-wrappers/zrx_token.ts:1089](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1089)* + +**Returns:** *`ContractAbi`* + +The contract ABI + +___ + +## `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:1047](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1047)* + +**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/zrx_token.ts:1022](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1022)* + +**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 + +## allowance + +## ▪ **allowance**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:944](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L944)* + +## callAsync + +▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:950](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L950)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:1013](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1013)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:1006](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1006)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:996](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L996)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## approve + +## ▪ **approve**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L119)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/zrx_token.ts:161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L161)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:221](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L221)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:189](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L189)* + +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 [generated-wrappers/zrx_token.ts:284](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L284)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/zrx_token.ts:277](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L277)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/zrx_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L267)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L126)* + +Sends an 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 [generated-wrappers/zrx_token.ts:291](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L291)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_spender` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## balanceOf + +## ▪ **balanceOf**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:645](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L645)* + +## callAsync + +▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_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 | +------ | ------ | ------ | +`_owner` | string | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:705](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L705)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:698](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L698)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_owner`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:692](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L692)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +___ + +## decimals + +## ▪ **decimals**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:583](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L583)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:589](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L589)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *number* + +*Defined in [generated-wrappers/zrx_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L637)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *number* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *number* + +*Defined in [generated-wrappers/zrx_token.ts:630](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L630)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *number* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/zrx_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L625)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## name + +## ▪ **name**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L57)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L63)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas +since they don't modify state. + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L111)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L104)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/zrx_token.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L99)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## symbol + +## ▪ **symbol**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:713](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L713)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:719](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L719)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:767](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L767)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *string* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *string* + +*Defined in [generated-wrappers/zrx_token.ts:760](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L760)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *string* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/zrx_token.ts:755](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L755)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## totalSupply + +## ▪ **totalSupply**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:301](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L301)* + +## callAsync + +▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:307](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L307)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to 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` | - | + +**Returns:** *`Promise`* + +## getABIDecodedReturnData + +▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L355)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *`BigNumber`* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L348)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *`BigNumber`* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [generated-wrappers/zrx_token.ts:343](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L343)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data 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* + +___ + +## transfer + +## ▪ **transfer**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:775](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L775)* + +## awaitTransactionSuccessAsync + +▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* + +*Defined in [generated-wrappers/zrx_token.ts:814](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L814)* + +Sends an Ethereum transaction and waits 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`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:867](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.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 | +------ | ------ | ------ | +`_to` | string | - | +`_value` | `BigNumber` | - | +`callData` | `Partial` | {} | +`defaultBlock?` | `BlockParam` | - | + +**Returns:** *`Promise`* + +## estimateGasAsync + +▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:842](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L842)* + +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 [generated-wrappers/zrx_token.ts:927](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L927)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/zrx_token.ts:920](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L920)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/zrx_token.ts:910](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L910)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:782](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L782)* + +Sends an 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 [generated-wrappers/zrx_token.ts:934](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L934)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +___ + +## transferFrom + +## ▪ **transferFrom**: *object* + +*Defined in [generated-wrappers/zrx_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L366)* + +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 [generated-wrappers/zrx_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L417)* + +Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. +If the transaction was mined, but reverted, an error is thrown. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | 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`): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:494](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L494)* + +Sends a read-only call to the contract method. Returns the result that would happen if one were to send an +Ethereum transaction to this 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` | - | - | + +**Returns:** *`Promise`* + +Success of transfer. + +## estimateGasAsync + +▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:455](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L455)* + +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 [generated-wrappers/zrx_token.ts:565](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L565)* + +**Parameters:** + +Name | Type | +------ | ------ | +`returnData` | string | + +**Returns:** *boolean* + +## getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* + +*Defined in [generated-wrappers/zrx_token.ts:558](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L558)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData` | string | + +**Returns:** *boolean* + +## getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* + +*Defined in [generated-wrappers/zrx_token.ts:546](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L546)* + +Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before +sending the Ethereum tx, this encoded tx data can first be sent 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* + +## sendTransactionAsync + +▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* + +*Defined in [generated-wrappers/zrx_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L376)* + +Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write +Ethereum operation and will cost gas. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | 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 [generated-wrappers/zrx_token.ts:572](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L572)* + +**Parameters:** + +Name | Type | +------ | ------ | +`_from` | string | +`_to` | string | +`_value` | `BigNumber` | +`txData?` | `Partial` \| undefined | + +**Returns:** *`Promise`* + +
+ +# Class: CoordinatorServerError + +### Hierarchy * `Error` * **CoordinatorServerError** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Properties +\+ **new CoordinatorServerError**(`message`: [CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg), `approvedOrders`: `SignedOrder`[], `cancellations`: [CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[], `errors`: [CoordinatorServerResponse](#interface-coordinatorserverresponse)[]): *[CoordinatorServerError](#class-coordinatorservererror)* -* [approvedOrders](#optional-approvedorders) -* [cancellations](#optional-cancellations) -* [errors](#errors) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [Error](#static-error) - -## Constructors - -### constructor - -\+ **new CoordinatorServerError**(`message`: [CoordinatorServerErrorMsg](#class-coordinatorservererror)* - -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* +*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* **Parameters:** @@ -3673,1985 +27959,2928 @@ Name | Type | **Returns:** *[CoordinatorServerError](#class-coordinatorservererror)* -## Properties +### Properties -### `Optional` approvedOrders +## `Optional` approvedOrders • **approvedOrders**? : *`SignedOrder`[]* = [] -*Defined in [utils/coordinator_server_types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L41)* +*Defined in [utils/coordinator_server_types.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L41)* ___ -### `Optional` cancellations +## `Optional` cancellations • **cancellations**? : *[CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[]* = [] -*Defined in [utils/coordinator_server_types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L42)* +*Defined in [utils/coordinator_server_types.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L42)* ___ -### errors +## errors • **errors**: *[CoordinatorServerResponse](#interface-coordinatorserverresponse)[]* -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* +*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* ___ -### message +## message • **message**: *[CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg)* *Overrides void* -*Defined in [utils/coordinator_server_types.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L40)* +*Defined in [utils/coordinator_server_types.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L40)* ___ -### name +## name • **name**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 + + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 + ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 +
-> # Class: TransactionEncoder +# Enumeration: AssetProxyOwnerEvents -Transaction Encoder. Transaction messages exist for the purpose of calling methods on the Exchange contract -in the context of another address. For example, UserA can encode and sign a fillOrder transaction and UserB -can submit this to the blockchain. The Exchange context executes as if UserA had directly submitted this transaction. - -## Hierarchy - -* **TransactionEncoder** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [batchCancelOrdersTx](#batchcancelorderstx) -* [batchFillOrKillOrdersTx](#batchfillorkillorderstx) -* [batchFillOrdersNoThrowTx](#batchfillordersnothrowtx) -* [batchFillOrdersTx](#batchfillorderstx) -* [cancelOrderTx](#cancelordertx) -* [cancelOrdersUpToTx](#cancelordersuptotx) -* [fillOrKillOrderTx](#fillorkillordertx) -* [fillOrderNoThrowTx](#fillordernothrowtx) -* [fillOrderTx](#fillordertx) -* [getTransactionHashHex](#gettransactionhashhex) -* [marketBuyOrdersNoThrowTx](#marketbuyordersnothrowtx) -* [marketBuyOrdersTx](#marketbuyorderstx) -* [marketSellOrdersNoThrowTx](#marketsellordersnothrowtx) -* [marketSellOrdersTx](#marketsellorderstx) -* [matchOrdersTx](#matchorderstx) -* [preSignTx](#presigntx) -* [setSignatureValidatorApprovalTx](#setsignaturevalidatorapprovaltx) - -## Constructors - -### constructor - -\+ **new TransactionEncoder**(`exchangeInstance`: `ExchangeContract`): *[TransactionEncoder](#class-transactionencoder)* - -*Defined in [utils/transaction_encoder.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L17)* - -**Parameters:** - -Name | Type | ------- | ------ | -`exchangeInstance` | `ExchangeContract` | - -**Returns:** *[TransactionEncoder](#class-transactionencoder)* - -## Methods - -### batchCancelOrdersTx - -▸ **batchCancelOrdersTx**(`signedOrders`: `SignedOrder`[]): *string* - -*Defined in [utils/transaction_encoder.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L149)* - -Encodes a batchCancelOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of orders to cancel. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrKillOrdersTx - -▸ **batchFillOrKillOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:112](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L112)* - -Encodes a batchFillOrKillOrders transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrdersNoThrowTx - -▸ **batchFillOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L131)* - -Encodes a batchFillOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### batchFillOrdersTx - -▸ **batchFillOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[]): *string* - -*Defined in [utils/transaction_encoder.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L93)* - -Encodes a batchFillOrders transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### cancelOrderTx - -▸ **cancelOrderTx**(`order`: `Order` | `SignedOrder`): *string* - -*Defined in [utils/transaction_encoder.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L171)* - -Encodes a cancelOrder transaction. - -**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:** *string* - -Hex encoded abi of the function call. - -___ - -### cancelOrdersUpToTx - -▸ **cancelOrdersUpToTx**(`targetOrderEpoch`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L159)* - -Encodes a cancelOrdersUpTo transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | Target order epoch. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrKillOrderTx - -▸ **fillOrKillOrderTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L77)* - -Encodes a fillOrKillOrder transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrderNoThrowTx - -▸ **fillOrderNoThrowTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L61)* - -Encodes a fillOrderNoThrow transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### fillOrderTx - -▸ **fillOrderTx**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L45)* - -Encodes a fillOrder transaction. - -**Parameters:** - -Name | Type | 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. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### getTransactionHashHex - -▸ **getTransactionHashHex**(`data`: string, `salt`: `BigNumber`, `signerAddress`: string): *string* - -*Defined in [utils/transaction_encoder.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L28)* - -Hashes the transaction data for use with the Exchange contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | The ABI Encoded 0x Exchange method. I.e fillOrder | -`salt` | `BigNumber` | A random value to provide uniqueness and prevent replay attacks. | -`signerAddress` | string | The address which will sign this transaction. | - -**Returns:** *string* - -The hash of the 0x transaction. - -___ - -### marketBuyOrdersNoThrowTx - -▸ **marketBuyOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:233](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L233)* - -Encodes a maketBuyOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | Maker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketBuyOrdersTx - -▸ **marketBuyOrdersTx**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:216](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L216)* - -Encodes a maketBuyOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`makerAssetFillAmount` | `BigNumber` | Maker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketSellOrdersNoThrowTx - -▸ **marketSellOrdersNoThrowTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L199)* - -Encodes a marketSellOrdersNoThrow transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | Taker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### marketSellOrdersTx - -▸ **marketSellOrdersTx**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`): *string* - -*Defined in [utils/transaction_encoder.ts:182](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L182)* - -Encodes a marketSellOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrders` | `SignedOrder`[] | An array of signed orders to fill. | -`takerAssetFillAmount` | `BigNumber` | Taker asset fill amount. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### matchOrdersTx - -▸ **matchOrdersTx**(`leftOrder`: `SignedOrder`, `rightOrder`: `SignedOrder`): *string* - -*Defined in [utils/transaction_encoder.ts:250](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L250)* - -Encodes a matchOrders transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrder` | `SignedOrder` | First order to match. | -`rightOrder` | `SignedOrder` | Second order to match. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### preSignTx - -▸ **preSignTx**(`hash`: string, `signerAddress`: string, `signature`: string): *string* - -*Defined in [utils/transaction_encoder.ts:268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L268)* - -Encodes a preSign transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Hash to pre-sign | -`signerAddress` | string | Address that should have signed the given hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -___ - -### setSignatureValidatorApprovalTx - -▸ **setSignatureValidatorApprovalTx**(`validatorAddress`: string, `isApproved`: boolean): *string* - -*Defined in [utils/transaction_encoder.ts:285](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/transaction_encoder.ts#L285)* - -Encodes a setSignatureValidatorApproval transaction. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`validatorAddress` | string | Validator contract address. | -`isApproved` | boolean | Boolean value to set approval to. | - -**Returns:** *string* - -Hex encoded abi of the function call. - -
- -> # Enumeration: ContractWrappersError - -## Index ### Enumeration members -* [ContractNotDeployedOnNetwork](#contractnotdeployedonnetwork) -* [ERC721NoApproval](#erc721noapproval) -* [ERC721OwnerNotFound](#erc721ownernotfound) -* [InsufficientAllowanceForTransfer](#insufficientallowancefortransfer) -* [InsufficientBalanceForTransfer](#insufficientbalancefortransfer) -* [InsufficientEthBalanceForDeposit](#insufficientethbalancefordeposit) -* [InsufficientWEthBalanceForWithdrawal](#insufficientwethbalanceforwithdrawal) -* [InvalidJump](#invalidjump) -* [OutOfGas](#outofgas) -* [SignatureRequestDenied](#signaturerequestdenied) -* [SubscriptionAlreadyPresent](#subscriptionalreadypresent) -* [SubscriptionNotFound](#subscriptionnotfound) +## AssetProxyRegistration -## Enumeration members +• **AssetProxyRegistration**: = "AssetProxyRegistration" -### ContractNotDeployedOnNetwork +*Defined in [generated-wrappers/asset_proxy_owner.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L49)* + +___ + +## Confirmation + +• **Confirmation**: = "Confirmation" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L52)* + +___ + +## ConfirmationTimeSet + +• **ConfirmationTimeSet**: = "ConfirmationTimeSet" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L50)* + +___ + +## Deposit + +• **Deposit**: = "Deposit" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L57)* + +___ + +## Execution + +• **Execution**: = "Execution" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L55)* + +___ + +## ExecutionFailure + +• **ExecutionFailure**: = "ExecutionFailure" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L56)* + +___ + +## OwnerAddition + +• **OwnerAddition**: = "OwnerAddition" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:58](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L58)* + +___ + +## OwnerRemoval + +• **OwnerRemoval**: = "OwnerRemoval" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L59)* + +___ + +## RequirementChange + +• **RequirementChange**: = "RequirementChange" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L60)* + +___ + +## Revocation + +• **Revocation**: = "Revocation" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L53)* + +___ + +## Submission + +• **Submission**: = "Submission" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L54)* + +___ + +## TimeLockChange + +• **TimeLockChange**: = "TimeLockChange" + +*Defined in [generated-wrappers/asset_proxy_owner.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L51)* + +
+ +# Enumeration: CoordinatorRegistryEvents + + +### Enumeration members + +## CoordinatorEndpointSet + +• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" + +*Defined in [generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* + +
+ +# Enumeration: DummyERC20TokenEvents + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* + +
+ +# Enumeration: DummyERC721TokenEvents + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* + +___ + +## ApprovalForAll + +• **ApprovalForAll**: = "ApprovalForAll" + +*Defined in [generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L42)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* + +
+ +# Enumeration: ERC20ProxyEvents + + +### Enumeration members + +## AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [generated-wrappers/erc20_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L39)* + +___ + +## AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [generated-wrappers/erc20_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)* + +
+ +# Enumeration: ERC20TokenEvents + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L38)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L37)* + +
+ +# Enumeration: ERC721ProxyEvents + + +### Enumeration members + +## AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [generated-wrappers/erc721_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L39)* + +___ + +## AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [generated-wrappers/erc721_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)* + +
+ +# Enumeration: ERC721TokenEvents + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L41)* + +___ + +## ApprovalForAll + +• **ApprovalForAll**: = "ApprovalForAll" + +*Defined in [generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L42)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L40)* + +
+ +# Enumeration: ExchangeEvents + + +### Enumeration members + +## AssetProxyRegistered + +• **AssetProxyRegistered**: = "AssetProxyRegistered" + +*Defined in [generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L46)* + +___ + +## Cancel + +• **Cancel**: = "Cancel" + +*Defined in [generated-wrappers/exchange.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L44)* + +___ + +## CancelUpTo + +• **CancelUpTo**: = "CancelUpTo" + +*Defined in [generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L45)* + +___ + +## Fill + +• **Fill**: = "Fill" + +*Defined in [generated-wrappers/exchange.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L43)* + +___ + +## SignatureValidatorApproval + +• **SignatureValidatorApproval**: = "SignatureValidatorApproval" + +*Defined in [generated-wrappers/exchange.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L42)* + +
+ +# Enumeration: MultiAssetProxyEvents + + +### Enumeration members + +## AssetProxyRegistered + +• **AssetProxyRegistered**: = "AssetProxyRegistered" + +*Defined in [generated-wrappers/multi_asset_proxy.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L42)* + +___ + +## AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [generated-wrappers/multi_asset_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L40)* + +___ + +## AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [generated-wrappers/multi_asset_proxy.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L41)* + +
+ +# Enumeration: WETH9Events + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L41)* + +___ + +## Deposit + +• **Deposit**: = "Deposit" + +*Defined in [generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L43)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L42)* + +___ + +## Withdrawal + +• **Withdrawal**: = "Withdrawal" + +*Defined in [generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L44)* + +
+ +# Enumeration: ZRXTokenEvents + + +### Enumeration members + +## Approval + +• **Approval**: = "Approval" + +*Defined in [generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L38)* + +___ + +## Transfer + +• **Transfer**: = "Transfer" + +*Defined in [generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L37)* + +
+ +# Enumeration: ContractError + + +### Enumeration members + +## ContractNotDeployedOnNetwork • **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L26)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L32)* ___ -### ERC721NoApproval +## ERC721NoApproval • **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L36)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L42)* ___ -### ERC721OwnerNotFound +## ERC721OwnerNotFound • **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L35)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L41)* ___ -### InsufficientAllowanceForTransfer +## InsufficientAllowanceForTransfer • **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" -*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L27)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L33)* ___ -### InsufficientBalanceForTransfer +## InsufficientBalanceForTransfer • **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L28)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L34)* ___ -### InsufficientEthBalanceForDeposit +## InsufficientEthBalanceForDeposit • **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" -*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L29)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L35)* ___ -### InsufficientWEthBalanceForWithdrawal +## InsufficientWEthBalanceForWithdrawal • **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L30)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L36)* ___ -### InvalidJump +## InvalidJump • **InvalidJump**: = "INVALID_JUMP" -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L31)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L37)* ___ -### OutOfGas +## OutOfGas • **OutOfGas**: = "OUT_OF_GAS" -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L32)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L38)* ___ -### SignatureRequestDenied +## SignatureRequestDenied • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L37)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L43)* ___ -### SubscriptionAlreadyPresent +## SubscriptionAlreadyPresent • **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L34)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L40)* ___ -### SubscriptionNotFound +## SubscriptionNotFound • **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L33)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L39)*
-> # Enumeration: DutchAuctionWrapperError +# Enumeration: ForwarderError -## Index ### Enumeration members -* [AssetDataMismatch](#assetdatamismatch) - -## Enumeration members - -### AssetDataMismatch - -• **AssetDataMismatch**: = "ASSET_DATA_MISMATCH" - -*Defined in [types.ts:220](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L220)* - -
- -> # Enumeration: ExchangeWrapperError - -## Index - -### Enumeration members - -* [AssetDataMismatch](#assetdatamismatch) - -## Enumeration members - -### AssetDataMismatch - -• **AssetDataMismatch**: = "ASSET_DATA_MISMATCH" - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L18)* - -
- -> # Enumeration: ForwarderWrapperError - -## Index - -### Enumeration members - -* [CompleteFillFailed](#completefillfailed) - -## Enumeration members - -### CompleteFillFailed +## CompleteFillFailed • **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L22)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L28)*
-> # Enumeration: InternalContractWrappersError +# Enumeration: OrderStatus -## Index ### Enumeration members -* [NoAbiDecoder](#noabidecoder) - -## Enumeration members - -### NoAbiDecoder - -• **NoAbiDecoder**: = "NO_ABI_DECODER" - -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L41)* - -
- -> # Enumeration: OrderStatus - -## Index - -### Enumeration members - -* [Cancelled](#cancelled) -* [Expired](#expired) -* [Fillable](#fillable) -* [FullyFilled](#fullyfilled) -* [Invalid](#invalid) -* [InvalidMakerAssetAmount](#invalidmakerassetamount) -* [InvalidTakerAssetAmount](#invalidtakerassetamount) - -## Enumeration members - -### Cancelled +## Cancelled • **Cancelled**: -*Defined in [types.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L195)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L91)* ___ -### Expired +## Expired • **Expired**: -*Defined in [types.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L193)* +*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L89)* ___ -### Fillable +## Fillable • **Fillable**: -*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L192)* +*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L88)* ___ -### FullyFilled +## FullyFilled • **FullyFilled**: -*Defined in [types.ts:194](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L194)* +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L90)* ___ -### Invalid +## Invalid • **Invalid**: = 0 -*Defined in [types.ts:189](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L189)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L85)* ___ -### InvalidMakerAssetAmount +## InvalidMakerAssetAmount • **InvalidMakerAssetAmount**: -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L190)* +*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L86)* ___ -### InvalidTakerAssetAmount +## InvalidTakerAssetAmount • **InvalidTakerAssetAmount**: -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L191)* +*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L87)*
-> # Enumeration: TradeSide +# Enumeration: CoordinatorServerErrorMsg -## Index ### Enumeration members -* [Maker](#maker) -* [Taker](#taker) - -## Enumeration members - -### Maker - -• **Maker**: = "maker" - -*Defined in [types.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L171)* - -___ - -### Taker - -• **Taker**: = "taker" - -*Defined in [types.ts:172](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L172)* - -
- -> # Enumeration: TransferType - -## Index - -### Enumeration members - -* [Fee](#fee) -* [Trade](#trade) - -## Enumeration members - -### Fee - -• **Fee**: = "fee" - -*Defined in [types.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L177)* - -___ - -### Trade - -• **Trade**: = "trade" - -*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L176)* - -
- -> # Enumeration: CoordinatorServerErrorMsg - -## Index - -### Enumeration members - -* [CancellationFailed](#cancellationfailed) -* [FillFailed](#fillfailed) - -## Enumeration members - -### CancellationFailed +## 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/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L59)* +*Defined in [utils/coordinator_server_types.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L59)* ___ -### FillFailed +## 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/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)* +*Defined in [utils/coordinator_server_types.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)*
-> # Interface: BalanceAndAllowance +# Enumeration: ContractError -## Hierarchy -* **BalanceAndAllowance** +### Enumeration members -## Index +## ContractNotDeployedOnNetwork -### Properties +• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" -* [allowance](#allowance) -* [balance](#balance) +*Defined in [utils/decorators.ts:4](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/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/a6f43f536/packages/contract-wrappers/src/utils/decorators.ts#L11)* + +
+ +# Interface: AssetProxyOwnerAssetProxyRegistrationEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerAssetProxyRegistrationEventArgs** + + +### Index ## Properties -### allowance - -• **allowance**: *`BigNumber`* - -*Defined in [types.ts:216](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L216)* - -___ - -### balance - -• **balance**: *`BigNumber`* - -*Defined in [types.ts:215](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L215)* - -
- -> # Interface: BlockRange - -## Hierarchy - -* **BlockRange** - -## Index +* [assetProxyContract](#assetproxycontract) +* [isRegistered](#isregistered) ### Properties -* [fromBlock](#fromblock) -* [toBlock](#toblock) +## assetProxyContract -## Properties +• **assetProxyContract**: *string* -### fromBlock - -• **fromBlock**: *`BlockParam`* - -*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L97)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L64)* ___ -### toBlock +## isRegistered -• **toBlock**: *`BlockParam`* +• **isRegistered**: *boolean* -*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L98)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L65)*
-> # Interface: ContractEvent +# Interface: AssetProxyOwnerConfirmationEventArgs -## Hierarchy +### Hierarchy -* **ContractEvent** +* `DecodedLogArgs` -## Index + * **AssetProxyOwnerConfirmationEventArgs** + + +### Index + +## Properties + +* [sender](#sender) +* [transactionId](#transactionid) ### Properties -* [address](#address) -* [args](#args) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [event](#event) -* [logIndex](#logindex) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) -* [type](#type) +## sender -## Properties +• **sender**: *string* -### address - -• **address**: *string* - -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L61)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:78](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L78)* ___ -### args +## transactionId -• **args**: *[ContractEventArgs](#contracteventargs)* +• **transactionId**: *`BigNumber`* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L64)* - -___ - -### blockHash - -• **blockHash**: *string* - -*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L59)* - -___ - -### blockNumber - -• **blockNumber**: *number* - -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L60)* - -___ - -### event - -• **event**: *string* - -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L63)* - -___ - -### logIndex - -• **logIndex**: *number* - -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L56)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [types.ts:58](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L58)* - -___ - -### transactionIndex - -• **transactionIndex**: *number* - -*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L57)* - -___ - -### type - -• **type**: *string* - -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L62)* +*Defined in [generated-wrappers/asset_proxy_owner.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L79)*
-> # Interface: ContractWrappersConfig +# Interface: AssetProxyOwnerConfirmationTimeSetEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerConfirmationTimeSetEventArgs** + + +### Index + +## Properties + +* [confirmationTime](#confirmationtime) +* [transactionId](#transactionid) + +### Properties + +## confirmationTime + +• **confirmationTime**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L70)* + +___ + +## transactionId + +• **transactionId**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:69](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L69)* + +
+ +# Interface: AssetProxyOwnerDepositEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerDepositEventArgs** + + +### Index + +## Properties + +* [sender](#sender) +* [value](#value) + +### Properties + +## sender + +• **sender**: *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:100](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L100)* + +___ + +## value + +• **value**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:101](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L101)* + +
+ +# Interface: AssetProxyOwnerExecutionEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerExecutionEventArgs** + + +### Index + +## Properties + +* [transactionId](#transactionid) + +### Properties + +## transactionId + +• **transactionId**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:92](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L92)* + +
+ +# Interface: AssetProxyOwnerExecutionFailureEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerExecutionFailureEventArgs** + + +### Index + +## Properties + +* [transactionId](#transactionid) + +### Properties + +## transactionId + +• **transactionId**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L96)* + +
+ +# Interface: AssetProxyOwnerOwnerAdditionEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerOwnerAdditionEventArgs** + + +### Index + +## Properties + +* [owner](#owner) + +### Properties + +## owner + +• **owner**: *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:105](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L105)* + +
+ +# Interface: AssetProxyOwnerOwnerRemovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerOwnerRemovalEventArgs** + + +### Index + +## Properties + +* [owner](#owner) + +### Properties + +## owner + +• **owner**: *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L109)* + +
+ +# Interface: AssetProxyOwnerRequirementChangeEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerRequirementChangeEventArgs** + + +### Index + +## Properties + +* [required](#required) + +### Properties + +## required + +• **required**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:113](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L113)* + +
+ +# Interface: AssetProxyOwnerRevocationEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerRevocationEventArgs** + + +### Index + +## Properties + +* [sender](#sender) +* [transactionId](#transactionid) + +### Properties + +## sender + +• **sender**: *string* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:83](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L83)* + +___ + +## transactionId + +• **transactionId**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:84](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L84)* + +
+ +# Interface: AssetProxyOwnerSubmissionEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerSubmissionEventArgs** + + +### Index + +## Properties + +* [transactionId](#transactionid) + +### Properties + +## transactionId + +• **transactionId**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:88](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L88)* + +
+ +# Interface: AssetProxyOwnerTimeLockChangeEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **AssetProxyOwnerTimeLockChangeEventArgs** + + +### Index + +## Properties + +* [secondsTimeLocked](#secondstimelocked) + +### Properties + +## secondsTimeLocked + +• **secondsTimeLocked**: *`BigNumber`* + +*Defined in [generated-wrappers/asset_proxy_owner.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L74)* + +
+ +# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **CoordinatorRegistryCoordinatorEndpointSetEventArgs** + + +### Index + +## Properties + +* [coordinatorEndpoint](#coordinatorendpoint) +* [coordinatorOperator](#coordinatoroperator) + +### Properties + +## coordinatorEndpoint + +• **coordinatorEndpoint**: *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L42)* + +___ + +## coordinatorOperator + +• **coordinatorOperator**: *string* + +*Defined in [generated-wrappers/coordinator_registry.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)* + +
+ +# Interface: DummyERC20TokenApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **DummyERC20TokenApprovalEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L48)* + +___ + +## _spender + +• **_spender**: *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L49)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)* + +
+ +# Interface: DummyERC20TokenTransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **DummyERC20TokenTransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* + +
+ +# Interface: DummyERC721TokenApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **DummyERC721TokenApprovalEventArgs** + + +### Index + +## Properties + +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) + +### Properties + +## _approved + +• **_approved**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* + +___ + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* + +___ + +## _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* + +
+ +# Interface: DummyERC721TokenApprovalForAllEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **DummyERC721TokenApprovalForAllEventArgs** + + +### Index + +## Properties + +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) + +### Properties + +## _approved + +• **_approved**: *boolean* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L60)* + +___ + +## _operator + +• **_operator**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L59)* + +___ + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)* + +
+ +# Interface: DummyERC721TokenTransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **DummyERC721TokenTransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* + +___ + +## _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* + +
+ +# Interface: ERC20ProxyAuthorizedAddressAddedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC20ProxyAuthorizedAddressAddedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L45)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L44)* + +
+ +# Interface: ERC20ProxyAuthorizedAddressRemovedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC20ProxyAuthorizedAddressRemovedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L50)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/erc20_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)* + +
+ +# Interface: ERC20TokenApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC20TokenApprovalEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L48)* + +___ + +## _spender + +• **_spender**: *string* + +*Defined in [generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L49)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L50)* + +
+ +# Interface: ERC20TokenTransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC20TokenTransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L42)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L43)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L44)* + +
+ +# Interface: ERC721ProxyAuthorizedAddressAddedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC721ProxyAuthorizedAddressAddedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L45)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L44)* + +
+ +# Interface: ERC721ProxyAuthorizedAddressRemovedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC721ProxyAuthorizedAddressRemovedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L50)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/erc721_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)* + +
+ +# Interface: ERC721TokenApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC721TokenApprovalEventArgs** + + +### Index + +## Properties + +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) + +### Properties + +## _approved + +• **_approved**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L53)* + +___ + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L52)* + +___ + +## _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L54)* + +
+ +# Interface: ERC721TokenApprovalForAllEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC721TokenApprovalForAllEventArgs** + + +### Index + +## Properties + +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) + +### Properties + +## _approved + +• **_approved**: *boolean* + +*Defined in [generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L60)* + +___ + +## _operator + +• **_operator**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L59)* + +___ + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L58)* + +
+ +# Interface: ERC721TokenTransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ERC721TokenTransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L46)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L47)* + +___ + +## _tokenId + +• **_tokenId**: *`BigNumber`* + +*Defined in [generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L48)* + +
+ +# Interface: ExchangeAssetProxyRegisteredEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ExchangeAssetProxyRegisteredEventArgs** + + +### Index + +## Properties + +* [assetProxy](#assetproxy) +* [id](#id) + +### Properties + +## assetProxy + +• **assetProxy**: *string* + +*Defined in [generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L86)* + +___ + +## id + +• **id**: *string* + +*Defined in [generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L85)* + +
+ +# Interface: ExchangeCancelEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ExchangeCancelEventArgs** + + +### Index + +## Properties + +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [orderHash](#orderhash) +* [senderAddress](#senderaddress) +* [takerAssetData](#takerassetdata) + +### Properties + +## feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L71)* + +___ + +## makerAddress + +• **makerAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L70)* + +___ + +## makerAssetData + +• **makerAssetData**: *string* + +*Defined in [generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L74)* + +___ + +## orderHash + +• **orderHash**: *string* + +*Defined in [generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L73)* + +___ + +## senderAddress + +• **senderAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L72)* + +___ + +## takerAssetData + +• **takerAssetData**: *string* + +*Defined in [generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L75)* + +
+ +# Interface: ExchangeCancelUpToEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ExchangeCancelUpToEventArgs** + + +### Index + +## Properties + +* [makerAddress](#makeraddress) +* [orderEpoch](#orderepoch) +* [senderAddress](#senderaddress) + +### Properties + +## makerAddress + +• **makerAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L79)* + +___ + +## orderEpoch + +• **orderEpoch**: *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L81)* + +___ + +## senderAddress + +• **senderAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L80)* + +
+ +# Interface: ExchangeFillEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ExchangeFillEventArgs** + + +### Index + +## Properties + +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [makerAssetFilledAmount](#makerassetfilledamount) +* [makerFeePaid](#makerfeepaid) +* [orderHash](#orderhash) +* [senderAddress](#senderaddress) +* [takerAddress](#takeraddress) +* [takerAssetData](#takerassetdata) +* [takerAssetFilledAmount](#takerassetfilledamount) +* [takerFeePaid](#takerfeepaid) + +### Properties + +## feeRecipientAddress + +• **feeRecipientAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L57)* + +___ + +## makerAddress + +• **makerAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L56)* + +___ + +## makerAssetData + +• **makerAssetData**: *string* + +*Defined in [generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L65)* + +___ + +## makerAssetFilledAmount + +• **makerAssetFilledAmount**: *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L60)* + +___ + +## makerFeePaid + +• **makerFeePaid**: *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L62)* + +___ + +## orderHash + +• **orderHash**: *string* + +*Defined in [generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L64)* + +___ + +## senderAddress + +• **senderAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L59)* + +___ + +## takerAddress + +• **takerAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L58)* + +___ + +## takerAssetData + +• **takerAssetData**: *string* + +*Defined in [generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L66)* + +___ + +## takerAssetFilledAmount + +• **takerAssetFilledAmount**: *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L61)* + +___ + +## takerFeePaid + +• **takerFeePaid**: *`BigNumber`* + +*Defined in [generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L63)* + +
+ +# Interface: ExchangeSignatureValidatorApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ExchangeSignatureValidatorApprovalEventArgs** + + +### Index + +## Properties + +* [approved](#approved) +* [signerAddress](#signeraddress) +* [validatorAddress](#validatoraddress) + +### Properties + +## approved + +• **approved**: *boolean* + +*Defined in [generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L52)* + +___ + +## signerAddress + +• **signerAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L50)* + +___ + +## validatorAddress + +• **validatorAddress**: *string* + +*Defined in [generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L51)* + +
+ +# Interface: MultiAssetProxyAssetProxyRegisteredEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **MultiAssetProxyAssetProxyRegisteredEventArgs** + + +### Index + +## Properties + +* [assetProxy](#assetproxy) +* [id](#id) + +### Properties + +## assetProxy + +• **assetProxy**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L57)* + +___ + +## id + +• **id**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L56)* + +
+ +# Interface: MultiAssetProxyAuthorizedAddressAddedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **MultiAssetProxyAuthorizedAddressAddedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L47)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L46)* + +
+ +# Interface: MultiAssetProxyAuthorizedAddressRemovedEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **MultiAssetProxyAuthorizedAddressRemovedEventArgs** + + +### Index + +## Properties + +* [caller](#caller) +* [target](#target) + +### Properties + +## caller + +• **caller**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L52)* + +___ + +## target + +• **target**: *string* + +*Defined in [generated-wrappers/multi_asset_proxy.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L51)* + +
+ +# Interface: WETH9ApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **WETH9ApprovalEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L48)* + +___ + +## _spender + +• **_spender**: *string* + +*Defined in [generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L49)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L50)* + +
+ +# Interface: WETH9DepositEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **WETH9DepositEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L60)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L61)* + +
+ +# Interface: WETH9TransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **WETH9TransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L54)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L55)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L56)* + +
+ +# Interface: WETH9WithdrawalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **WETH9WithdrawalEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L65)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L66)* + +
+ +# Interface: ZRXTokenApprovalEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ZRXTokenApprovalEventArgs** + + +### Index + +## Properties + +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) + +### Properties + +## _owner + +• **_owner**: *string* + +*Defined in [generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L48)* + +___ + +## _spender + +• **_spender**: *string* + +*Defined in [generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L49)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L50)* + +
+ +# Interface: ZRXTokenTransferEventArgs + +### Hierarchy + +* `DecodedLogArgs` + + * **ZRXTokenTransferEventArgs** + + +### Index + +## Properties + +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) + +### Properties + +## _from + +• **_from**: *string* + +*Defined in [generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L42)* + +___ + +## _to + +• **_to**: *string* + +*Defined in [generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L43)* + +___ + +## _value + +• **_value**: *`BigNumber`* + +*Defined in [generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L44)* + +
+ +# 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) -## Hierarchy +### Hierarchy * **ContractWrappersConfig** -## Index ### Properties -* [blockPollingIntervalMs](#optional-blockpollingintervalms) -* [contractAddresses](#optional-contractaddresses) -* [gasPrice](#optional-gasprice) -* [networkId](#networkid) - -## Properties - -### `Optional` blockPollingIntervalMs +## `Optional` blockPollingIntervalMs • **blockPollingIntervalMs**? : *undefined | number* -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L119)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L56)* ___ -### `Optional` contractAddresses +## `Optional` contractAddresses • **contractAddresses**? : *`ContractAddresses`* -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L118)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L55)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L117)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L54)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L116)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L53)*
-> # Interface: CoordinatorTransaction +# Interface: CoordinatorTransaction -## Hierarchy +### Hierarchy * **CoordinatorTransaction** -## Index ### Properties -* [data](#data) -* [salt](#salt) -* [signerAddress](#signeraddress) - -## Properties - -### data +## data • **data**: *string* -*Defined in [types.ts:228](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L228)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L115)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L226)* +*Defined in [types.ts:113](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L113)* ___ -### signerAddress +## signerAddress • **signerAddress**: *string* -*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L227)* +*Defined in [types.ts:114](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L114)*
-> # Interface: DecodedLogEvent <**ArgsType**> +# Interface: DecodedLogEvent <**ArgsType**> -## Type parameters +### Type parameters ▪ **ArgsType**: *`DecodedLogArgs`* -## Hierarchy +### Hierarchy * **DecodedLogEvent** -## Index ### Properties -* [isRemoved](#isremoved) -* [log](#log) - -## Properties - -### isRemoved +## isRemoved • **isRemoved**: *boolean* -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L46)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L7)* ___ -### log +## log • **log**: *`LogWithDecodedArgs`* -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L47)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L8)*
-> # Interface: IndexedFilterValues +# Interface: IndexedFilterValues -## Hierarchy +### Hierarchy * **IndexedFilterValues** -## Indexable -● \[▪ **index**: *string*\]: `ContractEventArg` - -
- -> # Interface: MethodOpts - -defaultBlock: The block up to which to query the blockchain state. Setting this to a historical block number -let's the user query the blockchain's state at an arbitrary point in time. In order for this to work, the -backing Ethereum node must keep the entire historical state of the chain (e.g setting `--pruning=archive` -flag when running Parity). - -## Hierarchy - -* **MethodOpts** - -## Index - -### Properties - -* [defaultBlock](#optional-defaultblock) - -## Properties - -### `Optional` defaultBlock - -• **defaultBlock**? : *`BlockParam`* - -*Defined in [types.ts:148](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L148)* - -
- -> # Interface: OrderAndTraderInfo - -## Hierarchy +### Hierarchy * **OrderAndTraderInfo** -## Index ### Properties -* [orderInfo](#orderinfo) -* [traderInfo](#traderinfo) - -## Properties - -### orderInfo +## orderInfo • **orderInfo**: *[OrderInfo](#interface-orderinfo)* -*Defined in [types.ts:210](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L210)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L106)* ___ -### traderInfo +## traderInfo • **traderInfo**: *[TraderInfo](#interface-traderinfo)* -*Defined in [types.ts:211](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L211)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L107)*
-> # Interface: OrderFillRequest +# Interface: OrderInfo -## Hierarchy - -* **OrderFillRequest** - -## Index - -### Properties - -* [signedOrder](#signedorder) -* [takerAssetFillAmount](#takerassetfillamount) - -## Properties - -### signedOrder - -• **signedOrder**: *`SignedOrder`* - -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L102)* - -___ - -### takerAssetFillAmount - -• **takerAssetFillAmount**: *`BigNumber`* - -*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L103)* - -
- -> # Interface: OrderInfo - -## Hierarchy +### Hierarchy * **OrderInfo** -## Index ### Properties -* [orderHash](#orderhash) -* [orderStatus](#orderstatus) -* [orderTakerAssetFilledAmount](#ordertakerassetfilledamount) - -## Properties - -### orderHash +## orderHash • **orderHash**: *string* -*Defined in [types.ts:184](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L184)* +*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L80)* ___ -### orderStatus +## orderStatus • **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* -*Defined in [types.ts:183](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L183)* +*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L79)* ___ -### orderTakerAssetFilledAmount +## orderTakerAssetFilledAmount • **orderTakerAssetFilledAmount**: *`BigNumber`* -*Defined in [types.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L185)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L81)*
-> # Interface: OrderTransactionOpts +# 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. -## Hierarchy +### Hierarchy * [TransactionOpts](#interface-transactionopts) * **OrderTransactionOpts** -## Index ### Properties -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [shouldValidate](#optional-shouldvalidate) - -## Properties - -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* *Inherited from [TransactionOpts](#optional-gaslimit)* -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L158)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L66)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Inherited from [TransactionOpts](#optional-gasprice)* -*Defined in [types.ts:157](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L157)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L65)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [TransactionOpts](#optional-nonce)* -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L159)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L67)* ___ -### `Optional` shouldValidate +## `Optional` shouldValidate • **shouldValidate**? : *undefined | false | true* -*Defined in [types.ts:167](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L167)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L75)*
-> # Interface: Token +# Interface: TraderInfo -## Hierarchy - -* **Token** - -## Index - -### Properties - -* [address](#address) -* [decimals](#decimals) -* [name](#name) -* [symbol](#symbol) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L74)* - -___ - -### decimals - -• **decimals**: *number* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L76)* - -___ - -### name - -• **name**: *string* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L73)* - -___ - -### symbol - -• **symbol**: *string* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L75)* - -
- -> # Interface: TokenAddressBySymbol - -## Hierarchy - -* **TokenAddressBySymbol** - -## Indexable - -● \[▪ **symbol**: *string*\]: string - -
- -> # Interface: TraderInfo - -## Hierarchy +### Hierarchy * **TraderInfo** -## Index ### Properties -* [makerAllowance](#makerallowance) -* [makerBalance](#makerbalance) -* [makerZrxAllowance](#makerzrxallowance) -* [makerZrxBalance](#makerzrxbalance) -* [takerAllowance](#takerallowance) -* [takerBalance](#takerbalance) -* [takerZrxAllowance](#takerzrxallowance) -* [takerZrxBalance](#takerzrxbalance) - -## Properties - -### makerAllowance +## makerAllowance • **makerAllowance**: *`BigNumber`* -*Defined in [types.ts:200](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L200)* +*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L96)* ___ -### makerBalance +## makerBalance • **makerBalance**: *`BigNumber`* -*Defined in [types.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L199)* +*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L95)* ___ -### makerZrxAllowance +## makerZrxAllowance • **makerZrxAllowance**: *`BigNumber`* -*Defined in [types.ts:204](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L204)* +*Defined in [types.ts:100](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L100)* ___ -### makerZrxBalance +## makerZrxBalance • **makerZrxBalance**: *`BigNumber`* -*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L203)* +*Defined in [types.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L99)* ___ -### takerAllowance +## takerAllowance • **takerAllowance**: *`BigNumber`* -*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L202)* +*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L98)* ___ -### takerBalance +## takerBalance • **takerBalance**: *`BigNumber`* -*Defined in [types.ts:201](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L201)* +*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L97)* ___ -### takerZrxAllowance +## takerZrxAllowance • **takerZrxAllowance**: *`BigNumber`* -*Defined in [types.ts:206](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L206)* +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L102)* ___ -### takerZrxBalance +## takerZrxBalance • **takerZrxBalance**: *`BigNumber`* -*Defined in [types.ts:205](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L205)* +*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L101)*
-> # Interface: TransactionOpts +# Interface: TransactionOpts gasPrice: Gas price in Wei to use for a transaction gasLimit: The amount of gas to send with a transaction (in Gwei) nonce: The nonce to use for a transaction. If not specified, it defaults to the next incremented nonce. -## Hierarchy +### Hierarchy * **TransactionOpts** * [OrderTransactionOpts](#interface-ordertransactionopts) -## Index ### Properties -* [gasLimit](#optional-gaslimit) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) - -## Properties - -### `Optional` gasLimit +## `Optional` gasLimit • **gasLimit**? : *undefined | number* -*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L158)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L66)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:157](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L157)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L65)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L159)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L67)*
-> # Interface: TxOpts +# Interface: TxOpts -## Hierarchy +### Hierarchy * **TxOpts** -## Index ### Properties -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [value](#optional-value) - -## Properties - -### from +## from • **from**: *string* -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L80)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L17)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *undefined | number* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L81)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L18)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L83)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L20)* ___ -### `Optional` value +## `Optional` value • **value**? : *`BigNumber`* -*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L82)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/types.ts#L19)*
-> # Interface: ValidateOrderFillableOpts +# Interface: CoordinatorOutstandingFillSignatures -`expectedFillTakerTokenAmount`: If specified, the validation method will ensure that the supplied order maker has a sufficient - allowance/balance to fill this amount of the order's takerTokenAmount. - -`validateRemainingOrderAmountIsFillable`: The validation method ensures that the maker has sufficient allowance/balance to fill - the entire remaining order amount. If this option is set to false, the balances - and allowances are calculated to determine the order is fillable for a - non-zero amount (some value less than or equal to the order remaining amount). - We call such orders "partially fillable orders". Default is `true`. - -`simulationTakerAddress`: During the maker transfer simulation, tokens are sent from the maker to the `simulationTakerAddress`. This defaults - to the `takerAddress` specified in the order. Some tokens prevent transfer to the NULL address so this address can be specified. - -## Hierarchy - -* **ValidateOrderFillableOpts** - -## Index - -### Properties - -* [expectedFillTakerTokenAmount](#optional-expectedfilltakertokenamount) -* [simulationTakerAddress](#optional-simulationtakeraddress) -* [validateRemainingOrderAmountIsFillable](#optional-validateremainingorderamountisfillable) - -## Properties - -### `Optional` expectedFillTakerTokenAmount - -• **expectedFillTakerTokenAmount**? : *`BigNumber`* - -*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L136)* - -___ - -### `Optional` simulationTakerAddress - -• **simulationTakerAddress**? : *undefined | string* - -*Defined in [types.ts:138](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L138)* - -___ - -### `Optional` validateRemainingOrderAmountIsFillable - -• **validateRemainingOrderAmountIsFillable**? : *undefined | false | true* - -*Defined in [types.ts:137](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/types.ts#L137)* - -
- -> # Interface: CoordinatorOutstandingFillSignatures - -## Hierarchy +### Hierarchy * **CoordinatorOutstandingFillSignatures** -## Index ### Properties -* [approvalSignatures](#approvalsignatures) -* [expirationTimeSeconds](#expirationtimeseconds) -* [orderHash](#orderhash) -* [takerAssetFillAmount](#takerassetfillamount) - -## Properties - -### approvalSignatures +## approvalSignatures • **approvalSignatures**: *string[]* -*Defined in [utils/coordinator_server_types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L19)* +*Defined in [utils/coordinator_server_types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L19)* ___ -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [utils/coordinator_server_types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L20)* +*Defined in [utils/coordinator_server_types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L20)* ___ -### orderHash +## orderHash • **orderHash**: *string* -*Defined in [utils/coordinator_server_types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L18)* +*Defined in [utils/coordinator_server_types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L18)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [utils/coordinator_server_types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L21)* +*Defined in [utils/coordinator_server_types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L21)*
-> # Interface: CoordinatorServerApprovalRawResponse +# Interface: CoordinatorServerApprovalRawResponse -## Hierarchy +### Hierarchy * **CoordinatorServerApprovalRawResponse** -## Index ### Properties -* [expirationTimeSeconds](#expirationtimeseconds) -* [signatures](#signatures) - -## Properties - -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [utils/coordinator_server_types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L10)* +*Defined in [utils/coordinator_server_types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L10)* ___ -### signatures +## signatures • **signatures**: *string[]* -*Defined in [utils/coordinator_server_types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L9)* +*Defined in [utils/coordinator_server_types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L9)*
-> # Interface: CoordinatorServerApprovalResponse +# Interface: CoordinatorServerApprovalResponse -## Hierarchy +### Hierarchy * **CoordinatorServerApprovalResponse** -## Index ### Properties -* [expirationTimeSeconds](#expirationtimeseconds) -* [signatures](#signatures) - -## Properties - -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`[]* -*Defined in [utils/coordinator_server_types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L6)* +*Defined in [utils/coordinator_server_types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L6)* ___ -### signatures +## signatures • **signatures**: *string[]* -*Defined in [utils/coordinator_server_types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L5)* +*Defined in [utils/coordinator_server_types.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L5)*
-> # Interface: CoordinatorServerCancellationResponse +# Interface: CoordinatorServerCancellationResponse -## Hierarchy +### Hierarchy * **CoordinatorServerCancellationResponse** -## Index ### Properties -* [cancellationSignatures](#cancellationsignatures) -* [outstandingFillSignatures](#outstandingfillsignatures) - -## Properties - -### cancellationSignatures +## cancellationSignatures • **cancellationSignatures**: *string[]* -*Defined in [utils/coordinator_server_types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L15)* +*Defined in [utils/coordinator_server_types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L15)* ___ -### outstandingFillSignatures +## outstandingFillSignatures • **outstandingFillSignatures**: *[CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures)[]* -*Defined in [utils/coordinator_server_types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L14)* +*Defined in [utils/coordinator_server_types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L14)*
-> # Interface: CoordinatorServerRequest +# Interface: CoordinatorServerRequest -## Hierarchy +### Hierarchy * **CoordinatorServerRequest** -## Index ### Properties -* [signedTransaction](#signedtransaction) -* [txOrigin](#txorigin) - -## Properties - -### signedTransaction +## signedTransaction • **signedTransaction**: *`SignedZeroExTransaction`* -*Defined in [utils/coordinator_server_types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L35)* +*Defined in [utils/coordinator_server_types.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L35)* ___ -### txOrigin +## txOrigin • **txOrigin**: *string* -*Defined in [utils/coordinator_server_types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L36)* +*Defined in [utils/coordinator_server_types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L36)*
-> # Interface: CoordinatorServerResponse +# Interface: CoordinatorServerResponse -## Hierarchy +### Hierarchy * **CoordinatorServerResponse** -## Index ### Properties -* [body](#optional-body) -* [coordinatorOperator](#coordinatoroperator) -* [error](#optional-error) -* [isError](#iserror) -* [orders](#optional-orders) -* [request](#request) -* [status](#status) +## `Optional` body -## Properties +• **body**? : *[CoordinatorServerCancellationResponse](_utils_coordinator_server_types_.coordinatorservercancellationresponse.md) | [CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse)* -### `Optional` body - -• **body**? : *[CoordinatorServerCancellationResponse](#class-coordinatorserverapprovalrawresponse)* - -*Defined in [utils/coordinator_server_types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L27)* +*Defined in [utils/coordinator_server_types.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L27)* ___ -### coordinatorOperator +## coordinatorOperator • **coordinatorOperator**: *string* -*Defined in [utils/coordinator_server_types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L30)* +*Defined in [utils/coordinator_server_types.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L30)* ___ -### `Optional` error +## `Optional` error • **error**? : *any* -*Defined in [utils/coordinator_server_types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L28)* +*Defined in [utils/coordinator_server_types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L28)* ___ -### isError +## isError • **isError**: *boolean* -*Defined in [utils/coordinator_server_types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L25)* +*Defined in [utils/coordinator_server_types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L25)* ___ -### `Optional` orders +## `Optional` orders • **orders**? : *`Array`* -*Defined in [utils/coordinator_server_types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L31)* +*Defined in [utils/coordinator_server_types.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L31)* ___ -### request +## request • **request**: *[CoordinatorServerRequest](#class-coordinatorserverrequest)* -*Defined in [utils/coordinator_server_types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L29)* +*Defined in [utils/coordinator_server_types.ts:29](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L29)* ___ -### status +## status • **status**: *number* -*Defined in [utils/coordinator_server_types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [abstract/abstract_balance_and_proxy_allowance_lazy_store](modules/_abstract_abstract_balance_and_proxy_allowance_lazy_store_.md) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [contract_wrappers](modules/_contract_wrappers_.md) - * [contract_wrappers.ContractWrappers](#class-contractwrappers) - * [contract_wrappers/coordinator_wrapper](modules/_contract_wrappers_coordinator_wrapper_.md) - * [contract_wrappers/coordinator_wrapper.CoordinatorWrapper](#class-coordinatorwrapper) - * [contract_wrappers/dutch_auction_wrapper](modules/_contract_wrappers_dutch_auction_wrapper_.md) - * [contract_wrappers/dutch_auction_wrapper.DutchAuctionWrapper](#class-dutchauctionwrapper) - * [contract_wrappers/erc20_proxy_wrapper](modules/_contract_wrappers_erc20_proxy_wrapper_.md) - * [contract_wrappers/erc20_proxy_wrapper.ERC20ProxyWrapper](#class-erc20proxywrapper) - * [contract_wrappers/erc20_token_wrapper](modules/_contract_wrappers_erc20_token_wrapper_.md) - * [contract_wrappers/erc20_token_wrapper.ERC20TokenWrapper](#class-erc20tokenwrapper) - * [contract_wrappers/erc721_proxy_wrapper](modules/_contract_wrappers_erc721_proxy_wrapper_.md) - * [contract_wrappers/erc721_proxy_wrapper.ERC721ProxyWrapper](#class-erc721proxywrapper) - * [contract_wrappers/erc721_token_wrapper](modules/_contract_wrappers_erc721_token_wrapper_.md) - * [contract_wrappers/erc721_token_wrapper.ERC721TokenWrapper](#class-erc721tokenwrapper) - * [contract_wrappers/ether_token_wrapper](modules/_contract_wrappers_ether_token_wrapper_.md) - * [contract_wrappers/ether_token_wrapper.EtherTokenWrapper](#class-ethertokenwrapper) - * [contract_wrappers/exchange_wrapper](modules/_contract_wrappers_exchange_wrapper_.md) - * [contract_wrappers/exchange_wrapper.ExchangeWrapper](#class-exchangewrapper) - * [contract_wrappers/forwarder_wrapper](modules/_contract_wrappers_forwarder_wrapper_.md) - * [contract_wrappers/forwarder_wrapper.ForwarderWrapper](#class-forwarderwrapper) - * [contract_wrappers/order_validator_wrapper](modules/_contract_wrappers_order_validator_wrapper_.md) - * [contract_wrappers/order_validator_wrapper.OrderValidatorWrapper](#class-ordervalidatorwrapper) - * [fetchers/asset_balance_and_proxy_allowance_fetcher](modules/_fetchers_asset_balance_and_proxy_allowance_fetcher_.md) - * [fetchers/asset_balance_and_proxy_allowance_fetcher.AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher) - * [fetchers/order_filled_cancelled_fetcher](modules/_fetchers_order_filled_cancelled_fetcher_.md) - * [fetchers/order_filled_cancelled_fetcher.OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher) - * [index](modules/_index_.md) - * [schemas/contract_wrappers_config_schema](modules/_schemas_contract_wrappers_config_schema_.md) - * [schemas/method_opts_schema](modules/_schemas_method_opts_schema_.md) - * [schemas/order_tx_opts_schema](modules/_schemas_order_tx_opts_schema_.md) - * [schemas/tx_opts_schema](modules/_schemas_tx_opts_schema_.md) - * [schemas/validate_order_fillable_opts_schema](modules/_schemas_validate_order_fillable_opts_schema_.md) - * [types](modules/_types_.md) - * [types.ContractWrappersError](#class-contractwrapperserror) - * [types.DutchAuctionWrapperError](#class-dutchauctionwrappererror) - * [types.ExchangeWrapperError](#class-exchangewrappererror) - * [types.ForwarderWrapperError](#class-forwarderwrappererror) - * [types.InternalContractWrappersError](#class-internalcontractwrapperserror) - * [types.OrderStatus](#class-orderstatus) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.BalanceAndAllowance](#class-balanceandallowance) - * [types.BlockRange](#class-blockrange) - * [types.ContractEvent](#class-contractevent) - * [types.ContractWrappersConfig](#class-contractwrappersconfig) - * [types.CoordinatorTransaction](#class-coordinatortransaction) - * [types.DecodedLogEvent](#class-decodedlogevent) - * [types.IndexedFilterValues](#class-indexedfiltervalues) - * [types.MethodOpts](#class-methodopts) - * [types.OrderAndTraderInfo](#class-orderandtraderinfo) - * [types.OrderFillRequest](#class-orderfillrequest) - * [types.OrderInfo](#class-orderinfo) - * [types.OrderTransactionOpts](#class-ordertransactionopts) - * [types.Token](#class-token) - * [types.TokenAddressBySymbol](#class-tokenaddressbysymbol) - * [types.TraderInfo](#class-traderinfo) - * [types.TransactionOpts](#class-transactionopts) - * [types.TxOpts](#class-txopts) - * [types.ValidateOrderFillableOpts](#class-validateorderfillableopts) - * [utils/assert](modules/_utils_assert_.md) - * [utils/calldata_optimization_utils](modules/_utils_calldata_optimization_utils_.md) - * [utils/constants](modules/_utils_constants_.md) - * [utils/contract_addresses](modules/_utils_contract_addresses_.md) - * [utils/coordinator_server_types](modules/_utils_coordinator_server_types_.md) - * [utils/coordinator_server_types.CoordinatorServerErrorMsg](#class-coordinatorservererrormsg) - * [utils/coordinator_server_types.CoordinatorServerError](#class-coordinatorservererror) - * [utils/coordinator_server_types.CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures) - * [utils/coordinator_server_types.CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse) - * [utils/coordinator_server_types.CoordinatorServerApprovalResponse](#class-coordinatorserverapprovalresponse) - * [utils/coordinator_server_types.CoordinatorServerCancellationResponse](#class-coordinatorservercancellationresponse) - * [utils/coordinator_server_types.CoordinatorServerRequest](#class-coordinatorserverrequest) - * [utils/coordinator_server_types.CoordinatorServerResponse](#class-coordinatorserverresponse) - * [utils/decorators](modules/_utils_decorators_.md) - * [utils/filter_utils](modules/_utils_filter_utils_.md) - * [utils/transaction_encoder](modules/_utils_transaction_encoder_.md) - * [utils/transaction_encoder.TransactionEncoder](#class-transactionencoder) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [contract_wrappers.ContractWrappers](#class-contractwrappers) - * [contract_wrappers/coordinator_wrapper.CoordinatorWrapper](#class-coordinatorwrapper) - * [contract_wrappers/dutch_auction_wrapper.DutchAuctionWrapper](#class-dutchauctionwrapper) - * [contract_wrappers/erc20_proxy_wrapper.ERC20ProxyWrapper](#class-erc20proxywrapper) - * [contract_wrappers/erc20_token_wrapper.ERC20TokenWrapper](#class-erc20tokenwrapper) - * [contract_wrappers/erc721_proxy_wrapper.ERC721ProxyWrapper](#class-erc721proxywrapper) - * [contract_wrappers/erc721_token_wrapper.ERC721TokenWrapper](#class-erc721tokenwrapper) - * [contract_wrappers/ether_token_wrapper.EtherTokenWrapper](#class-ethertokenwrapper) - * [contract_wrappers/exchange_wrapper.ExchangeWrapper](#class-exchangewrapper) - * [contract_wrappers/forwarder_wrapper.ForwarderWrapper](#class-forwarderwrapper) - * [contract_wrappers/order_validator_wrapper.OrderValidatorWrapper](#class-ordervalidatorwrapper) - * [fetchers/asset_balance_and_proxy_allowance_fetcher.AssetBalanceAndProxyAllowanceFetcher](#class-assetbalanceandproxyallowancefetcher) - * [fetchers/order_filled_cancelled_fetcher.OrderFilledCancelledFetcher](#class-orderfilledcancelledfetcher) - * [utils/coordinator_server_types.CoordinatorServerError](#class-coordinatorservererror) - * [utils/transaction_encoder.TransactionEncoder](#class-transactionencoder) -* [Enums]() - * [types.ContractWrappersError](#class-contractwrapperserror) - * [types.DutchAuctionWrapperError](#class-dutchauctionwrappererror) - * [types.ExchangeWrapperError](#class-exchangewrappererror) - * [types.ForwarderWrapperError](#class-forwarderwrappererror) - * [types.InternalContractWrappersError](#class-internalcontractwrapperserror) - * [types.OrderStatus](#class-orderstatus) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [utils/coordinator_server_types.CoordinatorServerErrorMsg](#class-coordinatorservererrormsg) -* [Interfaces]() - * [types.BalanceAndAllowance](#class-balanceandallowance) - * [types.BlockRange](#class-blockrange) - * [types.ContractEvent](#class-contractevent) - * [types.ContractWrappersConfig](#class-contractwrappersconfig) - * [types.CoordinatorTransaction](#class-coordinatortransaction) - * [types.DecodedLogEvent](#class-decodedlogevent) - * [types.IndexedFilterValues](#class-indexedfiltervalues) - * [types.MethodOpts](#class-methodopts) - * [types.OrderAndTraderInfo](#class-orderandtraderinfo) - * [types.OrderFillRequest](#class-orderfillrequest) - * [types.OrderInfo](#class-orderinfo) - * [types.OrderTransactionOpts](#class-ordertransactionopts) - * [types.Token](#class-token) - * [types.TokenAddressBySymbol](#class-tokenaddressbysymbol) - * [types.TraderInfo](#class-traderinfo) - * [types.TransactionOpts](#class-transactionopts) - * [types.TxOpts](#class-txopts) - * [types.ValidateOrderFillableOpts](#class-validateorderfillableopts) - * [utils/coordinator_server_types.CoordinatorOutstandingFillSignatures](#class-coordinatoroutstandingfillsignatures) - * [utils/coordinator_server_types.CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse) - * [utils/coordinator_server_types.CoordinatorServerApprovalResponse](#class-coordinatorserverapprovalresponse) - * [utils/coordinator_server_types.CoordinatorServerCancellationResponse](#class-coordinatorservercancellationresponse) - * [utils/coordinator_server_types.CoordinatorServerRequest](#class-coordinatorserverrequest) - * [utils/coordinator_server_types.CoordinatorServerResponse](#class-coordinatorserverresponse) +*Defined in [utils/coordinator_server_types.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)*
diff --git a/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/README.md b/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/README.md deleted file mode 100644 index ae3c143077..0000000000 --- a/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/README.md +++ /dev/null @@ -1,83 +0,0 @@ -## @0x/json-schemas - -Contains 0x-related json schemas - -### Read the [Documentation](https://0xproject.com/docs/json-schemas). - -## Installation - -```bash -yarn add @0x/json-schemas -``` - -**Import** - -```typescript -import { SchemaValidator, ValidatorResult, schemas } from '@0x/json-schemas'; -``` - -or - -```javascript -var schemas = require('@0x/json-schemas').schemas; -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/json-schemas yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/json-schemas yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/reference.mdx b/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/reference.mdx deleted file mode 100644 index 43caa6134c..0000000000 --- a/packages/website/mdx/tools/@0x/json-schemas/v3.1.12/reference.mdx +++ /dev/null @@ -1,107 +0,0 @@ -> # Class: SchemaValidator - -A validator for [JSON-schemas](http://json-schema.org/) - -## Hierarchy - -* **SchemaValidator** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [addSchema](#addschema) -* [isValid](#isvalid) -* [validate](#validate) - -## Constructors - -### constructor - -\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)* - -*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L15)* - -Instantiates a SchemaValidator instance - -**Returns:** *[SchemaValidator](#class-schemavalidator)* - -## Methods - -### addSchema - -▸ **addSchema**(`schema`: `Schema`): *void* - -*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L32)* - -Add a schema to the validator. All schemas and sub-schemas must be added to -the validator before the `validate` and `isValid` methods can be called with -instances of that schema. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`schema` | `Schema` | The schema to add | - -**Returns:** *void* - -___ - -### isValid - -▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean* - -*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L57)* - -Check whether an instance properly adheres to a JSON schema - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`instance` | any | JS object in question | -`schema` | `Schema` | Schema to check against | - -**Returns:** *boolean* - -Whether or not the instance adheres to the schema - -___ - -### validate - -▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`* - -*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L46)* - -Validate the JS object conforms to a specific JSON schema - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`instance` | any | JS object in question | -`schema` | `Schema` | Schema to check against | - -**Returns:** *`ValidatorResult`* - -The results of the validation - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [schema_validator](modules/_schema_validator_.md) - * [schema_validator.SchemaValidator](#class-schemavalidator) - * [schemas](modules/_schemas_.md) -* [Classes]() - * [schema_validator.SchemaValidator](#class-schemavalidator) - -
- diff --git a/packages/website/mdx/tools/@0x/json-schemas/v3.1.13/reference.mdx b/packages/website/mdx/tools/@0x/json-schemas/v3.1.13/reference.mdx index 43caa6134c..cc15668985 100644 --- a/packages/website/mdx/tools/@0x/json-schemas/v3.1.13/reference.mdx +++ b/packages/website/mdx/tools/@0x/json-schemas/v3.1.13/reference.mdx @@ -1,42 +1,31 @@ -> # Class: SchemaValidator +# Class: SchemaValidator A validator for [JSON-schemas](http://json-schema.org/) -## Hierarchy +### Hierarchy * **SchemaValidator** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [addSchema](#addschema) -* [isValid](#isvalid) -* [validate](#validate) - -## Constructors - -### constructor +## constructer \+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)* -*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L15)* +*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/json-schemas/src/schema_validator.ts#L15)* Instantiates a SchemaValidator instance **Returns:** *[SchemaValidator](#class-schemavalidator)* -## Methods +### Methods -### addSchema +## addSchema ▸ **addSchema**(`schema`: `Schema`): *void* -*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L32)* +*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/json-schemas/src/schema_validator.ts#L32)* Add a schema to the validator. All schemas and sub-schemas must be added to the validator before the `validate` and `isValid` methods can be called with @@ -52,11 +41,11 @@ Name | Type | Description | ___ -### isValid +## isValid ▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean* -*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L57)* +*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/json-schemas/src/schema_validator.ts#L57)* Check whether an instance properly adheres to a JSON schema @@ -73,11 +62,11 @@ Whether or not the instance adheres to the schema ___ -### validate +## validate ▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`* -*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L46)* +*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/json-schemas/src/schema_validator.ts#L46)* Validate the JS object conforms to a specific JSON schema @@ -94,14 +83,3 @@ The results of the validation
-* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [schema_validator](modules/_schema_validator_.md) - * [schema_validator.SchemaValidator](#class-schemavalidator) - * [schemas](modules/_schemas_.md) -* [Classes]() - * [schema_validator.SchemaValidator](#class-schemavalidator) - -
- diff --git a/packages/website/mdx/tools/@0x/migrations/v4.1.11/README.md b/packages/website/mdx/tools/@0x/migrations/v4.1.11/README.md deleted file mode 100644 index 106c6b0323..0000000000 --- a/packages/website/mdx/tools/@0x/migrations/v4.1.11/README.md +++ /dev/null @@ -1,104 +0,0 @@ -## Migrations - -Migrate the 0x system of smart contracts on the network of your choice using these migrations. - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/migrations yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/migrations yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Migrate - -#### V2 smart contracts - -In order to migrate the V2 0x smart contracts to TestRPC/Ganache running at `http://localhost:8545`, run: - -```bash -yarn migrate:v2 -``` - -### Publish - -#### 0x Ganache Snapshot - -The 0x Ganache snapshot can be generated and published in this package. In order to build the snapshot for this version of migrations run: - -```bash -yarn build:snapshot -``` - -This will run the migrations in Ganache and output a zip file to be uploaded to the s3 bucket. For example, after running this command you will have created `0x_ganache_snapshot-2.2.2.zip`. To publish the zip file to the s3 bucket run: - -```bash -yarn publish:snapshot -``` - -This snapshot will now be publicly available at http://ganache-snapshots.0x.org.s3.amazonaws.com/0x_ganache_snapshot-latest.zip and also versioned with the package.json version. - -#### 0x Ganache Docker Image - -We also publish a simple docker image which downloads the latest snapshot, extracts and runs Ganache. This is not required to be built when migrations change as it always downloads and runs the latest zip file. If you have made changes to the Dockerfile then a publish of the image is required. To do this run: - -```bash -yarn build:snapshot:docker -yarn publish:snapshot:docker -``` - -The result is a published docker image to the 0xorg docker registry. To start the docker image run: - -```bash -docker run -p 8545:8545 -ti 0xorg/ganache-cli:latest -``` - -This will pull the latest zip in the s3 bucket, extract and start Ganache with the snapshot. - -In the event you need a specific version of the published Ganache snapshot run the following specifying the VERSION environment variable: - -```bash -docker run -e VERSION=2.2.2 -p 8545:8545 -ti 0xorg/ganache-cli:latest -``` - -#### Production - -If deploying contract changes to mainnet, `@0x/contract-artifacts` should also be updated and published. The artifacts must be copied from each `contracts/{package-name}/generated-artifacts/{contract}.json`. \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/migrations/v4.1.11/reference.mdx b/packages/website/mdx/tools/@0x/migrations/v4.1.11/reference.mdx deleted file mode 100644 index 7cfe6fbd74..0000000000 --- a/packages/website/mdx/tools/@0x/migrations/v4.1.11/reference.mdx +++ /dev/null @@ -1,228 +0,0 @@ -> # Enumeration: ContractName - -## Index - -### Enumeration members - -* [AccountLevels](#accountlevels) -* [Arbitrage](#arbitrage) -* [DummyToken](#dummytoken) -* [EtherDelta](#etherdelta) -* [Exchange](#exchange) -* [MultiSigWalletWithTimeLock](#multisigwalletwithtimelock) -* [MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress](#multisigwalletwithtimelockexceptremoveauthorizedaddress) -* [TokenRegistry](#tokenregistry) -* [TokenTransferProxy](#tokentransferproxy) -* [WETH9](#weth9) -* [ZRXToken](#zrxtoken) - -## Enumeration members - -### AccountLevels - -• **AccountLevels**: = "AccountLevels" - -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L26)* - -___ - -### Arbitrage - -• **Arbitrage**: = "Arbitrage" - -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L28)* - -___ - -### DummyToken - -• **DummyToken**: = "DummyToken" - -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L23)* - -___ - -### EtherDelta - -• **EtherDelta**: = "EtherDelta" - -*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L27)* - -___ - -### Exchange - -• **Exchange**: = "Exchange" - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L21)* - -___ - -### MultiSigWalletWithTimeLock - -• **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock" - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L20)* - -___ - -### MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress - -• **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress" - -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L25)* - -___ - -### TokenRegistry - -• **TokenRegistry**: = "TokenRegistry" - -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L19)* - -___ - -### TokenTransferProxy - -• **TokenTransferProxy**: = "TokenTransferProxy" - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L18)* - -___ - -### WETH9 - -• **WETH9**: = "WETH9" - -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L24)* - -___ - -### ZRXToken - -• **ZRXToken**: = "ZRXToken" - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L22)* - -
- -> # Interface: ERC20Token - -## Hierarchy - -* **ERC20Token** - -## Index - -### Properties - -* [address](#optional-address) -* [decimals](#decimals) -* [ipfsHash](#ipfshash) -* [name](#name) -* [swarmHash](#swarmhash) -* [symbol](#symbol) - -## Properties - -### `Optional` address - -• **address**? : *undefined | string* - -*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L4)* - -___ - -### decimals - -• **decimals**: *`BigNumber`* - -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L7)* - -___ - -### ipfsHash - -• **ipfsHash**: *string* - -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L8)* - -___ - -### name - -• **name**: *string* - -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L5)* - -___ - -### swarmHash - -• **swarmHash**: *string* - -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L9)* - -___ - -### symbol - -• **symbol**: *string* - -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L6)* - -
- -> # Interface: ERC721Token - -## Hierarchy - -* **ERC721Token** - -## Index - -### Properties - -* [name](#name) -* [symbol](#symbol) - -## Properties - -### name - -• **name**: *string* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L13)* - -___ - -### symbol - -• **symbol**: *string* - -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L14)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [cli](modules/_cli_.md) - * [index](modules/_index_.md) - * [migrate](modules/_migrate_.md) - * [migrate_snapshot](modules/_migrate_snapshot_.md) - * [migration](modules/_migration_.md) - * [types](modules/_types_.md) - * [types.ContractName](#class-contractname) - * [types.ERC20Token](#class-erc20token) - * [types.ERC721Token](#class-erc721token) - * [utils/constants](modules/_utils_constants_.md) - * [utils/provider_factory](modules/_utils_provider_factory_.md) - * [utils/token_info](modules/_utils_token_info_.md) -* [Enums]() - * [types.ContractName](#class-contractname) -* [Interfaces]() - * [types.ERC20Token](#class-erc20token) - * [types.ERC721Token](#class-erc721token) - -
- diff --git a/packages/website/mdx/tools/@0x/migrations/v4.2.0/reference.mdx b/packages/website/mdx/tools/@0x/migrations/v4.2.0/reference.mdx index 7cfe6fbd74..5bf9b246d1 100644 --- a/packages/website/mdx/tools/@0x/migrations/v4.2.0/reference.mdx +++ b/packages/website/mdx/tools/@0x/migrations/v4.2.0/reference.mdx @@ -1,228 +1,175 @@ -> # Enumeration: ContractName +# Enumeration: ContractName -## Index ### Enumeration members -* [AccountLevels](#accountlevels) -* [Arbitrage](#arbitrage) -* [DummyToken](#dummytoken) -* [EtherDelta](#etherdelta) -* [Exchange](#exchange) -* [MultiSigWalletWithTimeLock](#multisigwalletwithtimelock) -* [MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress](#multisigwalletwithtimelockexceptremoveauthorizedaddress) -* [TokenRegistry](#tokenregistry) -* [TokenTransferProxy](#tokentransferproxy) -* [WETH9](#weth9) -* [ZRXToken](#zrxtoken) - -## Enumeration members - -### AccountLevels +## AccountLevels • **AccountLevels**: = "AccountLevels" -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L26)* ___ -### Arbitrage +## Arbitrage • **Arbitrage**: = "Arbitrage" -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L28)* ___ -### DummyToken +## DummyToken • **DummyToken**: = "DummyToken" -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L23)* ___ -### EtherDelta +## EtherDelta • **EtherDelta**: = "EtherDelta" -*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L27)* ___ -### Exchange +## Exchange • **Exchange**: = "Exchange" -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L21)* ___ -### MultiSigWalletWithTimeLock +## MultiSigWalletWithTimeLock • **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock" -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L20)* ___ -### MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress +## MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress • **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress" -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L25)* ___ -### TokenRegistry +## TokenRegistry • **TokenRegistry**: = "TokenRegistry" -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L19)* ___ -### TokenTransferProxy +## TokenTransferProxy • **TokenTransferProxy**: = "TokenTransferProxy" -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L18)* ___ -### WETH9 +## WETH9 • **WETH9**: = "WETH9" -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L24)* ___ -### ZRXToken +## ZRXToken • **ZRXToken**: = "ZRXToken" -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L22)*
-> # Interface: ERC20Token +# Interface: ERC20Token -## Hierarchy +### Hierarchy * **ERC20Token** -## Index ### Properties -* [address](#optional-address) -* [decimals](#decimals) -* [ipfsHash](#ipfshash) -* [name](#name) -* [swarmHash](#swarmhash) -* [symbol](#symbol) - -## Properties - -### `Optional` address +## `Optional` address • **address**? : *undefined | string* -*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L4)* +*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L4)* ___ -### decimals +## decimals • **decimals**: *`BigNumber`* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L7)* ___ -### ipfsHash +## ipfsHash • **ipfsHash**: *string* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L8)* ___ -### name +## name • **name**: *string* -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L5)* ___ -### swarmHash +## swarmHash • **swarmHash**: *string* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L9)* ___ -### symbol +## symbol • **symbol**: *string* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L6)*
-> # Interface: ERC721Token +# Interface: ERC721Token -## Hierarchy +### Hierarchy * **ERC721Token** -## Index ### Properties -* [name](#name) -* [symbol](#symbol) - -## Properties - -### name +## name • **name**: *string* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L13)* ___ -### symbol +## symbol • **symbol**: *string* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L14)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [cli](modules/_cli_.md) - * [index](modules/_index_.md) - * [migrate](modules/_migrate_.md) - * [migrate_snapshot](modules/_migrate_snapshot_.md) - * [migration](modules/_migration_.md) - * [types](modules/_types_.md) - * [types.ContractName](#class-contractname) - * [types.ERC20Token](#class-erc20token) - * [types.ERC721Token](#class-erc721token) - * [utils/constants](modules/_utils_constants_.md) - * [utils/provider_factory](modules/_utils_provider_factory_.md) - * [utils/token_info](modules/_utils_token_info_.md) -* [Enums]() - * [types.ContractName](#class-contractname) -* [Interfaces]() - * [types.ERC20Token](#class-erc20token) - * [types.ERC721Token](#class-erc721token) +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/migrations/src/types.ts#L14)*
diff --git a/packages/website/mdx/tools/@0x/order-utils/v8.2.4/README.md b/packages/website/mdx/tools/@0x/order-utils/v8.2.4/README.md deleted file mode 100644 index a84433a4ae..0000000000 --- a/packages/website/mdx/tools/@0x/order-utils/v8.2.4/README.md +++ /dev/null @@ -1,65 +0,0 @@ -## @0x/order-utils - -0x order-related utilities for those developing on top of 0x protocol. - -### Read the [Documentation](https://0xproject.com/docs/order-utils). - -## Installation - -```bash -yarn add @0x/order-utils -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/order-utils yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/order-utils yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/order-utils/v8.2.4/reference.mdx b/packages/website/mdx/tools/@0x/order-utils/v8.2.4/reference.mdx deleted file mode 100644 index 06540c0e8a..0000000000 --- a/packages/website/mdx/tools/@0x/order-utils/v8.2.4/reference.mdx +++ /dev/null @@ -1,1688 +0,0 @@ -> # Class: AbstractBalanceAndProxyAllowanceFetcher - -An abstract class to be implemented in order to use OrderStateUtils. The class that -implements this interface must be capable of fetching the balance and proxyAllowance -for an Ethereum address and assetData - -## Hierarchy - -* **AbstractBalanceAndProxyAllowanceFetcher** - -## Index - -### Methods - -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) - -## Methods - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)* - -Get balance of assetData for userAddress - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData for which to fetch the balance | -`userAddress` | string | Ethereum address for which to fetch the balance | - -**Returns:** *`Promise`* - -Balance amount in base units - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)* - -Get the 0x asset proxy allowance of assetData for userAddress - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData for which to fetch the allowance | -`userAddress` | string | Ethereum address for which to fetch the allowance | - -**Returns:** *`Promise`* - -Allowance amount in base units - -
- -> # Class: AbstractBalanceAndProxyAllowanceLazyStore - -## Hierarchy - -* **AbstractBalanceAndProxyAllowanceLazyStore** - -## Implemented by - -* [BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - -## Index - -### Methods - -* [deleteAll](#abstract-deleteall) -* [deleteBalance](#abstract-deletebalance) -* [deleteProxyAllowance](#abstract-deleteproxyallowance) -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) -* [setBalance](#abstract-setbalance) -* [setProxyAllowance](#abstract-setproxyallowance) - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* - -**Returns:** *void* - -___ - -### `Abstract` deleteBalance - -▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteProxyAllowance - -▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` setBalance - -▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setProxyAllowance - -▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | -`proxyAllowance` | `BigNumber` | - -**Returns:** *void* - -
- -> # Class: AbstractOrderFilledCancelledFetcher - -An abstract class to be implemented in order to use OrderStateUtils. The class that -implements this interface must be capable of fetching the amount filled of an order -and whether it's been cancelled. - -## Hierarchy - -* **AbstractOrderFilledCancelledFetcher** - -## Index - -### Methods - -* [getFilledTakerAmountAsync](#abstract-getfilledtakeramountasync) -* [getZRXAssetData](#abstract-getzrxassetdata) -* [isOrderCancelledAsync](#abstract-isordercancelledasync) - -## Methods - -### `Abstract` getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* - -Get the amount of the order's takerToken amount already filled - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash of order we are interested in | - -**Returns:** *`Promise`* - -FilledTakerAmount - -___ - -### `Abstract` getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)* - -**Returns:** *string* - -___ - -### `Abstract` isOrderCancelledAsync - -▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* - -Whether an order is cancelled - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -Whether or not the order is cancelled - -
- -> # Class: AbstractOrderFilledCancelledLazyStore - -## Hierarchy - -* **AbstractOrderFilledCancelledLazyStore** - -## Implemented by - -* [OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) - -## Index - -### Methods - -* [deleteAll](#abstract-deleteall) -* [deleteFilledTakerAmount](#abstract-deletefilledtakeramount) -* [deleteIsCancelled](#abstract-deleteiscancelled) -* [getFilledTakerAmountAsync](#abstract-getfilledtakeramountasync) -* [getIsCancelledAsync](#abstract-getiscancelledasync) -* [getZRXAssetData](#abstract-getzrxassetdata) -* [setFilledTakerAmount](#abstract-setfilledtakeramount) -* [setIsCancelled](#abstract-setiscancelled) - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* - -**Returns:** *void* - -___ - -### `Abstract` deleteFilledTakerAmount - -▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteIsCancelled - -▸ **deleteIsCancelled**(`orderHash`: string): *void* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *void* - -___ - -### `Abstract` getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getIsCancelledAsync - -▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)* - -**Returns:** *string* - -___ - -### `Abstract` setFilledTakerAmount - -▸ **setFilledTakerAmount**(`orderHash`: string, `balance`: `BigNumber`): *void* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setIsCancelled - -▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* - -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | -`isCancelled` | boolean | - -**Returns:** *void* - -
- -> # Class: ExchangeTransferSimulator - -An exchange transfer simulator which simulates asset transfers exactly how the -0x exchange contract would do them. - -## Hierarchy - -* **ExchangeTransferSimulator** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [transferFromAsync](#transferfromasync) - -## Constructors - -### constructor - -\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](#class-exchangetransfersimulator)* - -*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* - -Instantiate a ExchangeTransferSimulator - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`store` | [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) | A class that implements AbstractBalanceAndProxyAllowanceLazyStore | - -**Returns:** *[ExchangeTransferSimulator](#class-exchangetransfersimulator)* - -an instance of ExchangeTransferSimulator - -## Methods - -### transferFromAsync - -▸ **transferFromAsync**(`assetData`: string, `from`: string, `to`: string, `amountInBaseUnits`: `BigNumber`, `tradeSide`: [TradeSide](#enumeration-tradeside), `transferType`: [TransferType](#enumeration-transfertype)): *`Promise`* - -*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* - -Simulates transferFrom call performed by a proxy - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Data of the asset being transferred. Includes it's identifying information and assetType, e.g address for ERC20, address & tokenId for ERC721 | -`from` | string | Owner of the transferred tokens | -`to` | string | Recipient of the transferred tokens | -`amountInBaseUnits` | `BigNumber` | The amount of tokens being transferred | -`tradeSide` | [TradeSide](#enumeration-tradeside) | Is Maker/Taker transferring | -`transferType` | [TransferType](#enumeration-transfertype) | Is it a fee payment or a value transfer | - -**Returns:** *`Promise`* - -
- -> # Class: OrderStateUtils - -## Hierarchy - -* **OrderStateUtils** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [getMaxFillableTakerAssetAmountAsync](#getmaxfillabletakerassetamountasync) -* [getOpenOrderRelevantStateAsync](#getopenorderrelevantstateasync) -* [getOpenOrderStateAsync](#getopenorderstateasync) - -## Constructors - -### constructor - -\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-orderstateutils)* - -*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L98)* - -Instantiate OrderStateUtils - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | A class that is capable of fetching balances and proxyAllowances for Ethereum addresses. It must implement AbstractBalanceAndProxyAllowanceFetcher | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A class that is capable of fetching whether an order is cancelled and how much of it has been filled. It must implement AbstractOrderFilledCancelledFetcher | - -**Returns:** *[OrderStateUtils](#class-orderstateutils)* - -Instance of OrderStateUtils - -## Methods - -### getMaxFillableTakerAssetAmountAsync - -▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L192)* - -Get the max amount of the supplied order's takerAmount that could still be filled - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | Order of interest | -`takerAddress` | string | Hypothetical taker of the order | - -**Returns:** *`Promise`* - -fillableTakerAssetAmount - -___ - -### getOpenOrderRelevantStateAsync - -▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L162)* - -Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc... - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | Order of interest | - -**Returns:** *`Promise`* - -An instance of OrderRelevantState - -___ - -### getOpenOrderStateAsync - -▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise`* - -*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L122)* - -Get the orderState for an "open" order (i.e where takerAddress=NULL_ADDRESS) -This method will only check the maker's balance/allowance to calculate the -OrderState. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | The order of interest | -`transactionHash?` | undefined \| string | - | - -**Returns:** *`Promise`* - -State relevant to the signedOrder, as well as whether the signedOrder is "valid". -Validity is defined as a non-zero amount of the order can still be filled. - -
- -> # Class: OrderValidationUtils - -A utility class for validating orders - -## Hierarchy - -* **OrderValidationUtils** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [validateFillOrderThrowIfInvalidAsync](#validatefillorderthrowifinvalidasync) -* [validateOrderFillableOrThrowAsync](#validateorderfillableorthrowasync) -* [isRoundingErrorFloor](#static-isroundingerrorfloor) -* [validateFillOrderBalancesAllowancesThrowIfInvalidAsync](#static-validatefillorderbalancesallowancesthrowifinvalidasync) -* [validateMakerTransferThrowIfInvalidAsync](#static-validatemakertransferthrowifinvalidasync) - -## Constructors - -### constructor - -\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-ordervalidationutils)* - -*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L159)* - -Instantiate OrderValidationUtils - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A module that implements the AbstractOrderFilledCancelledFetcher | -`supportedProvider` | `SupportedProvider` | Web3 provider to use for JSON RPC calls | - -**Returns:** *[OrderValidationUtils](#class-ordervalidationutils)* - -An instance of OrderValidationUtils - -## Methods - -### validateFillOrderThrowIfInvalidAsync - -▸ **validateFillOrderThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string, `zrxAssetData`: string): *`Promise`* - -*Defined in [order_validation_utils.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L236)* - -Validate a call to FillOrder and throw if it wouldn't succeed - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use | -`supportedProvider` | `SupportedProvider` | Web3 provider to use for JSON RPC requests | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`fillTakerAssetAmount` | `BigNumber` | Amount we'd like to fill the order for | -`takerAddress` | string | The taker of the order | -`zrxAssetData` | string | ZRX asset data | - -**Returns:** *`Promise`* - -___ - -### validateOrderFillableOrThrowAsync - -▸ **validateOrderFillableOrThrowAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `zrxAssetData`: string, `expectedFillTakerTokenAmount?`: `BigNumber`): *`Promise`* - -*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L185)* - -Validate if the supplied order is fillable, and throw if it isn't - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator instance | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`zrxAssetData` | string | ZRX assetData | -`expectedFillTakerTokenAmount?` | `BigNumber` | If supplied, this call will make sure this amount is fillable. If it isn't supplied, we check if the order is fillable for a non-zero amount | - -**Returns:** *`Promise`* - -___ - -### `Static` isRoundingErrorFloor - -▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean* - -*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L34)* - -A Typescript implementation mirroring the implementation of isRoundingError in the -Exchange smart contract - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`numerator` | `BigNumber` | Numerator value. When used to check an order, pass in `takerAssetFilledAmount` | -`denominator` | `BigNumber` | Denominator value. When used to check an order, pass in `order.takerAssetAmount` | -`target` | `BigNumber` | Target value. When used to check an order, pass in `order.makerAssetAmount` | - -**Returns:** *boolean* - -___ - -### `Static` validateFillOrderBalancesAllowancesThrowIfInvalidAsync - -▸ **validateFillOrderBalancesAllowancesThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `senderAddress`: string, `zrxAssetData`: string): *`Promise`* - -*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L61)* - -Validate that the maker & taker have sufficient balances/allowances -to fill the supplied order to the fillTakerAssetAmount amount - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use | -`signedOrder` | `SignedOrder` | SignedOrder to test | -`fillTakerAssetAmount` | `BigNumber` | Amount of takerAsset to fill the signedOrder | -`senderAddress` | string | Sender of the fillOrder tx | -`zrxAssetData` | string | AssetData for the ZRX token | - -**Returns:** *`Promise`* - -___ - -### `Static` validateMakerTransferThrowIfInvalidAsync - -▸ **validateMakerTransferThrowIfInvalidAsync**(`networkId`: `NetworkId`, `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise`* - -*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L127)* - -Validate the transfer from the maker to the taker. This is simulated on-chain -via an eth_call. If this call fails, the asset is currently nontransferable. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`networkId` | `NetworkId` | - | -`supportedProvider` | `SupportedProvider` | - | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`makerAssetAmount` | `BigNumber` | Amount to transfer from the maker | -`takerAddress?` | undefined \| string | The address to transfer to, defaults to signedOrder.takerAddress | - -**Returns:** *`Promise`* - -
- -> # Class: RemainingFillableCalculator - -## Hierarchy - -* **RemainingFillableCalculator** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [computeRemainingFillable](#computeremainingfillable) - -## Constructors - -### constructor - -\+ **new RemainingFillableCalculator**(`orderFee`: `BigNumber`, `orderAssetAmount`: `BigNumber`, `isTraderAssetZRX`: boolean, `transferrableAssetAmount`: `BigNumber`, `transferrableFeeAmount`: `BigNumber`, `remainingOrderAssetAmount`: `BigNumber`): *[RemainingFillableCalculator](#class-remainingfillablecalculator)* - -*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L11)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderFee` | `BigNumber` | -`orderAssetAmount` | `BigNumber` | -`isTraderAssetZRX` | boolean | -`transferrableAssetAmount` | `BigNumber` | -`transferrableFeeAmount` | `BigNumber` | -`remainingOrderAssetAmount` | `BigNumber` | - -**Returns:** *[RemainingFillableCalculator](#class-remainingfillablecalculator)* - -## Methods - -### computeRemainingFillable - -▸ **computeRemainingFillable**(): *`BigNumber`* - -*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L30)* - -**Returns:** *`BigNumber`* - -
- -> # Class: BalanceAndProxyAllowanceLazyStore - -Copy on read store for balances/proxyAllowances of tokens/accounts - -## Hierarchy - -* **BalanceAndProxyAllowanceLazyStore** - -## Implements - -* [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [deleteAll](#deleteall) -* [deleteAllERC721ProxyAllowance](#deleteallerc721proxyallowance) -* [deleteBalance](#deletebalance) -* [deleteProxyAllowance](#deleteproxyallowance) -* [getBalanceAsync](#getbalanceasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) -* [setBalance](#setbalance) -* [setProxyAllowance](#setproxyallowance) - -## Constructors - -### constructor - -\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-balanceandproxyallowancelazystore)* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)* - -Instantiates a BalanceAndProxyAllowanceLazyStore - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | Class the implements the AbstractBalanceAndProxyAllowanceFetcher | - -**Returns:** *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)* - -Instance of BalanceAndProxyAllowanceLazyStore - -## Methods - -### deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)* - -Delete all balances & allowances - -**Returns:** *void* - -___ - -### deleteAllERC721ProxyAllowance - -▸ **deleteAllERC721ProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)* - -Clear all ERC721 0x proxy allowances a user has on all items of a specific ERC721 contract - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`tokenAddress` | string | ERc721 token address | -`userAddress` | string | Owner Ethereum address | - -**Returns:** *void* - -___ - -### deleteBalance - -▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)* - -Clear the balance of an asset for a user - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *void* - -___ - -### deleteProxyAllowance - -▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)* - -Clear the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *void* - -___ - -### getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)* - -Get a users balance of an asset - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *`Promise`* - -___ - -### getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)* - -Get the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *`Promise`* - -___ - -### setBalance - -▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)* - -Set the balance of an asset for a user - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | -`balance` | `BigNumber` | - | - -**Returns:** *void* - -___ - -### setProxyAllowance - -▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)* - -Set the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | -`proxyAllowance` | `BigNumber` | - | - -**Returns:** *void* - -
- -> # Class: OrderFilledCancelledLazyStore - -Copy on read store for balances/proxyAllowances of tokens/accounts - -## Hierarchy - -* **OrderFilledCancelledLazyStore** - -## Implements - -* [AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [deleteAll](#deleteall) -* [deleteAllFilled](#deleteallfilled) -* [deleteAllIsCancelled](#deletealliscancelled) -* [deleteFilledTakerAmount](#deletefilledtakeramount) -* [deleteIsCancelled](#deleteiscancelled) -* [getFilledTakerAmountAsync](#getfilledtakeramountasync) -* [getIsCancelledAsync](#getiscancelledasync) -* [getZRXAssetData](#getzrxassetdata) -* [setFilledTakerAmount](#setfilledtakeramount) -* [setIsCancelled](#setiscancelled) - -## Constructors - -### constructor - -\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-orderfilledcancelledlazystore)* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* - -Instantiate a OrderFilledCancelledLazyStore - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | Class instance that implements the AbstractOrderFilledCancelledFetcher | - -**Returns:** *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)* - -An instance of OrderFilledCancelledLazyStore - -## Methods - -### deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* - -Clear all filled/cancelled state - -**Returns:** *void* - -___ - -### deleteAllFilled - -▸ **deleteAllFilled**(): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* - -Clear all filled state - -**Returns:** *void* - -___ - -### deleteAllIsCancelled - -▸ **deleteAllIsCancelled**(): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* - -Clear all cancelled state - -**Returns:** *void* - -___ - -### deleteFilledTakerAmount - -▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* - -Clear the filledTakerAssetAmount of an order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *void* - -___ - -### deleteIsCancelled - -▸ **deleteIsCancelled**(`orderHash`: string): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* - -Clear whether the order has been cancelled if already set - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *void* - -___ - -### getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* - -Get the filledTakerAssetAmount of an order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *`Promise`* - -filledTakerAssetAmount - -___ - -### getIsCancelledAsync - -▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* - -Check if an order has been cancelled - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -Whether the order has been cancelled - -___ - -### getZRXAssetData - -▸ **getZRXAssetData**(): *string* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)* - -Get the ZRX assetData - -**Returns:** *string* - -___ - -### setFilledTakerAmount - -▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* - -Set the filledTakerAssetAmount of an order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | -`filledTakerAmount` | `BigNumber` | Desired filledTakerAssetAmount | - -**Returns:** *void* - -___ - -### setIsCancelled - -▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* - -Set whether an order has been cancelled or not - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | -`isCancelled` | boolean | Whether this order should be cancelled or not | - -**Returns:** *void* - -
- -> # Enumeration: TradeSide - -## Index - -### Enumeration members - -* [Maker](#maker) -* [Taker](#taker) - -## Enumeration members - -### Maker - -• **Maker**: = "maker" - -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L9)* - -___ - -### Taker - -• **Taker**: = "taker" - -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L10)* - -
- -> # Enumeration: TransferType - -## Index - -### Enumeration members - -* [Fee](#fee) -* [Trade](#trade) - -## Enumeration members - -### Fee - -• **Fee**: = "fee" - -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L15)* - -___ - -### Trade - -• **Trade**: = "trade" - -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L14)* - -
- -> # Enumeration: TypedDataError - -## Index - -### Enumeration members - -* [InvalidMetamaskSigner](#invalidmetamasksigner) -* [InvalidSignature](#invalidsignature) - -## Enumeration members - -### InvalidMetamaskSigner - -• **InvalidMetamaskSigner**: = "MetaMask provider must be wrapped in a MetamaskSubprovider (from the '@0x/subproviders' package) in order to work with this method." - -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L5)* - -___ - -### InvalidSignature - -• **InvalidSignature**: = "INVALID_SIGNATURE" - -*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L4)* - -
- -> # Interface: CreateOrderOpts - -## Hierarchy - -* **CreateOrderOpts** - -## Index - -### Properties - -* [expirationTimeSeconds](#optional-expirationtimeseconds) -* [feeRecipientAddress](#optional-feerecipientaddress) -* [makerFee](#optional-makerfee) -* [salt](#optional-salt) -* [senderAddress](#optional-senderaddress) -* [takerAddress](#optional-takeraddress) -* [takerFee](#optional-takerfee) - -## Properties - -### `Optional` expirationTimeSeconds - -• **expirationTimeSeconds**? : *`BigNumber`* - -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L25)* - -___ - -### `Optional` feeRecipientAddress - -• **feeRecipientAddress**? : *undefined | string* - -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L23)* - -___ - -### `Optional` makerFee - -• **makerFee**? : *`BigNumber`* - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L21)* - -___ - -### `Optional` salt - -• **salt**? : *`BigNumber`* - -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L24)* - -___ - -### `Optional` senderAddress - -• **senderAddress**? : *undefined | string* - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L20)* - -___ - -### `Optional` takerAddress - -• **takerAddress**? : *undefined | string* - -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L19)* - -___ - -### `Optional` takerFee - -• **takerFee**? : *`BigNumber`* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L22)* - -
- -> # Interface: FeeOrdersAndRemainingFeeAmount <**T**> - -## Type parameters - -▪ **T** - -## Hierarchy - -* **FeeOrdersAndRemainingFeeAmount** - -## Index - -### Properties - -* [feeOrdersRemainingFillableMakerAssetAmounts](#feeordersremainingfillablemakerassetamounts) -* [remainingFeeAmount](#remainingfeeamount) -* [resultFeeOrders](#resultfeeorders) - -## Properties - -### feeOrdersRemainingFillableMakerAssetAmounts - -• **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* - -*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L70)* - -___ - -### remainingFeeAmount - -• **remainingFeeAmount**: *`BigNumber`* - -*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L71)* - -___ - -### resultFeeOrders - -• **resultFeeOrders**: *`T`[]* - -*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L69)* - -
- -> # Interface: FindFeeOrdersThatCoverFeesForTargetOrdersOpts - -remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. -You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. -Defaults to `makerAssetAmount` values from the orders param. -remainingFillableFeeAmounts: An array of BigNumbers corresponding to the feeOrders parameter. -You can use OrderStateUtils @0x/order-utils to perform blockchain lookups for these values. -Defaults to `makerAssetAmount` values from the feeOrders param. -slippageBufferAmount: An additional amount of fee to be covered by the result in case of trade collisions or partial fills. -Defaults to 0 - -## Hierarchy - -* **FindFeeOrdersThatCoverFeesForTargetOrdersOpts** - -## Index - -### Properties - -* [remainingFillableFeeAmounts](#optional-remainingfillablefeeamounts) -* [remainingFillableMakerAssetAmounts](#optional-remainingfillablemakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableFeeAmounts - -• **remainingFillableFeeAmounts**? : *`BigNumber`[]* - -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L64)* - -___ - -### `Optional` remainingFillableMakerAssetAmounts - -• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* - -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L63)* - -___ - -### `Optional` slippageBufferAmount - -• **slippageBufferAmount**? : *`BigNumber`* - -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L65)* - -
- -> # Interface: FindOrdersThatCoverMakerAssetFillAmountOpts - -remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. -You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. -Defaults to `makerAssetAmount` values from the orders param. -slippageBufferAmount: An additional amount of makerAsset to be covered by the result in case of trade collisions or partial fills. -Defaults to 0 - -## Hierarchy - -* **FindOrdersThatCoverMakerAssetFillAmountOpts** - -## Index - -### Properties - -* [remainingFillableMakerAssetAmounts](#optional-remainingfillablemakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableMakerAssetAmounts - -• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* - -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L36)* - -___ - -### `Optional` slippageBufferAmount - -• **slippageBufferAmount**? : *`BigNumber`* - -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L37)* - -
- -> # Interface: FindOrdersThatCoverTakerAssetFillAmountOpts - -remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. -You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. -Defaults to `makerAssetAmount` values from the orders param. -slippageBufferAmount: An additional amount of makerAsset to be covered by the result in case of trade collisions or partial fills. -Defaults to 0 - -## Hierarchy - -* **FindOrdersThatCoverTakerAssetFillAmountOpts** - -## Index - -### Properties - -* [remainingFillableTakerAssetAmounts](#optional-remainingfillabletakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableTakerAssetAmounts - -• **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]* - -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L48)* - -___ - -### `Optional` slippageBufferAmount - -• **slippageBufferAmount**? : *`BigNumber`* - -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L49)* - -
- -> # Interface: OrdersAndRemainingMakerFillAmount <**T**> - -## Type parameters - -▪ **T** - -## Hierarchy - -* **OrdersAndRemainingMakerFillAmount** - -## Index - -### Properties - -* [ordersRemainingFillableMakerAssetAmounts](#ordersremainingfillablemakerassetamounts) -* [remainingFillAmount](#remainingfillamount) -* [resultOrders](#resultorders) - -## Properties - -### ordersRemainingFillableMakerAssetAmounts - -• **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L76)* - -___ - -### remainingFillAmount - -• **remainingFillAmount**: *`BigNumber`* - -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L77)* - -___ - -### resultOrders - -• **resultOrders**: *`T`[]* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L75)* - -
- -> # Interface: OrdersAndRemainingTakerFillAmount <**T**> - -## Type parameters - -▪ **T** - -## Hierarchy - -* **OrdersAndRemainingTakerFillAmount** - -## Index - -### Properties - -* [ordersRemainingFillableTakerAssetAmounts](#ordersremainingfillabletakerassetamounts) -* [remainingFillAmount](#remainingfillamount) -* [resultOrders](#resultorders) - -## Properties - -### ordersRemainingFillableTakerAssetAmounts - -• **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]* - -*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L82)* - -___ - -### remainingFillAmount - -• **remainingFillAmount**: *`BigNumber`* - -*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L83)* - -___ - -### resultOrders - -• **resultOrders**: *`T`[]* - -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L81)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [abstract/abstract_balance_and_proxy_allowance_fetcher](modules/_abstract_abstract_balance_and_proxy_allowance_fetcher_.md) - * [abstract/abstract_balance_and_proxy_allowance_fetcher.AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store](modules/_abstract_abstract_balance_and_proxy_allowance_lazy_store_.md) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [abstract/abstract_order_filled_cancelled_fetcher](modules/_abstract_abstract_order_filled_cancelled_fetcher_.md) - * [abstract/abstract_order_filled_cancelled_fetcher.AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) - * [abstract/abstract_order_filled_cancelled_lazy_store](modules/_abstract_abstract_order_filled_cancelled_lazy_store_.md) - * [abstract/abstract_order_filled_cancelled_lazy_store.AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - * [assert](modules/_assert_.md) - * [asset_data_utils](modules/_asset_data_utils_.md) - * [constants](modules/_constants_.md) - * [crypto](modules/_crypto_.md) - * [eip712_utils](modules/_eip712_utils_.md) - * [exchange_transfer_simulator](modules/_exchange_transfer_simulator_.md) - * [exchange_transfer_simulator.ExchangeTransferSimulator](#class-exchangetransfersimulator) - * [index](modules/_index_.md) - * [market_utils](modules/_market_utils_.md) - * [order_calculation_utils](modules/_order_calculation_utils_.md) - * [order_factory](modules/_order_factory_.md) - * [order_hash](modules/_order_hash_.md) - * [order_state_utils](modules/_order_state_utils_.md) - * [order_state_utils.OrderStateUtils](#class-orderstateutils) - * [order_validation_utils](modules/_order_validation_utils_.md) - * [order_validation_utils.OrderValidationUtils](#class-ordervalidationutils) - * [parsing_utils](modules/_parsing_utils_.md) - * [rate_utils](modules/_rate_utils_.md) - * [remaining_fillable_calculator](modules/_remaining_fillable_calculator_.md) - * [remaining_fillable_calculator.RemainingFillableCalculator](#class-remainingfillablecalculator) - * [salt](modules/_salt_.md) - * [signature_utils](modules/_signature_utils_.md) - * [sorting_utils](modules/_sorting_utils_.md) - * [store/balance_and_proxy_allowance_lazy_store](modules/_store_balance_and_proxy_allowance_lazy_store_.md) - * [store/balance_and_proxy_allowance_lazy_store.BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - * [store/order_filled_cancelled_lazy_store](modules/_store_order_filled_cancelled_lazy_store_.md) - * [store/order_filled_cancelled_lazy_store.OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) - * [transaction_hash](modules/_transaction_hash_.md) - * [types](modules/_types_.md) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.TypedDataError](#class-typeddataerror) - * [types.CreateOrderOpts](#class-createorderopts) - * [types.FeeOrdersAndRemainingFeeAmount](#class-feeordersandremainingfeeamount) - * [types.FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#class-findfeeordersthatcoverfeesfortargetordersopts) - * [types.FindOrdersThatCoverMakerAssetFillAmountOpts](#class-findordersthatcovermakerassetfillamountopts) - * [types.FindOrdersThatCoverTakerAssetFillAmountOpts](#class-findordersthatcovertakerassetfillamountopts) - * [types.OrdersAndRemainingMakerFillAmount](#class-ordersandremainingmakerfillamount) - * [types.OrdersAndRemainingTakerFillAmount](#class-ordersandremainingtakerfillamount) - * [utils](modules/_utils_.md) -* [Classes]() - * [abstract/abstract_balance_and_proxy_allowance_fetcher.AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [abstract/abstract_order_filled_cancelled_fetcher.AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) - * [abstract/abstract_order_filled_cancelled_lazy_store.AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - * [exchange_transfer_simulator.ExchangeTransferSimulator](#class-exchangetransfersimulator) - * [order_state_utils.OrderStateUtils](#class-orderstateutils) - * [order_validation_utils.OrderValidationUtils](#class-ordervalidationutils) - * [remaining_fillable_calculator.RemainingFillableCalculator](#class-remainingfillablecalculator) - * [store/balance_and_proxy_allowance_lazy_store.BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - * [store/order_filled_cancelled_lazy_store.OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) -* [Enums]() - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.TypedDataError](#class-typeddataerror) -* [Interfaces]() - * [types.CreateOrderOpts](#class-createorderopts) - * [types.FeeOrdersAndRemainingFeeAmount](#class-feeordersandremainingfeeamount) - * [types.FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#class-findfeeordersthatcoverfeesfortargetordersopts) - * [types.FindOrdersThatCoverMakerAssetFillAmountOpts](#class-findordersthatcovermakerassetfillamountopts) - * [types.FindOrdersThatCoverTakerAssetFillAmountOpts](#class-findordersthatcovertakerassetfillamountopts) - * [types.OrdersAndRemainingMakerFillAmount](#class-ordersandremainingmakerfillamount) - * [types.OrdersAndRemainingTakerFillAmount](#class-ordersandremainingtakerfillamount) - -
- diff --git a/packages/website/mdx/tools/@0x/order-utils/v8.2.5/reference.mdx b/packages/website/mdx/tools/@0x/order-utils/v8.2.5/reference.mdx index 06540c0e8a..bafc39c178 100644 --- a/packages/website/mdx/tools/@0x/order-utils/v8.2.5/reference.mdx +++ b/packages/website/mdx/tools/@0x/order-utils/v8.2.5/reference.mdx @@ -1,27 +1,21 @@ -> # Class: AbstractBalanceAndProxyAllowanceFetcher +# Class: AbstractBalanceAndProxyAllowanceFetcher An abstract class to be implemented in order to use OrderStateUtils. The class that implements this interface must be capable of fetching the balance and proxyAllowance for an Ethereum address and assetData -## Hierarchy +### Hierarchy * **AbstractBalanceAndProxyAllowanceFetcher** -## Index ### Methods -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) - -## Methods - -### `Abstract` getBalanceAsync +## `Abstract` getBalanceAsync ▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)* Get balance of assetData for userAddress @@ -38,11 +32,11 @@ Balance amount in base units ___ -### `Abstract` getProxyAllowanceAsync +## `Abstract` getProxyAllowanceAsync ▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)* Get the 0x asset proxy allowance of assetData for userAddress @@ -59,45 +53,34 @@ Allowance amount in base units
-> # Class: AbstractBalanceAndProxyAllowanceLazyStore +# Class: AbstractBalanceAndProxyAllowanceLazyStore -## Hierarchy +### Hierarchy * **AbstractBalanceAndProxyAllowanceLazyStore** -## Implemented by +### Implemented by * [BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) -## Index ### Methods -* [deleteAll](#abstract-deleteall) -* [deleteBalance](#abstract-deletebalance) -* [deleteProxyAllowance](#abstract-deleteproxyallowance) -* [getBalanceAsync](#abstract-getbalanceasync) -* [getProxyAllowanceAsync](#abstract-getproxyallowanceasync) -* [setBalance](#abstract-setbalance) -* [setProxyAllowance](#abstract-setproxyallowance) - -## Methods - -### `Abstract` deleteAll +## `Abstract` deleteAll ▸ **deleteAll**(): *void* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* **Returns:** *void* ___ -### `Abstract` deleteBalance +## `Abstract` deleteBalance ▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* **Parameters:** @@ -110,11 +93,11 @@ Name | Type | ___ -### `Abstract` deleteProxyAllowance +## `Abstract` deleteProxyAllowance ▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* **Parameters:** @@ -127,11 +110,11 @@ Name | Type | ___ -### `Abstract` getBalanceAsync +## `Abstract` getBalanceAsync ▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* **Parameters:** @@ -144,11 +127,11 @@ Name | Type | ___ -### `Abstract` getProxyAllowanceAsync +## `Abstract` getProxyAllowanceAsync ▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* **Parameters:** @@ -161,11 +144,11 @@ Name | Type | ___ -### `Abstract` setBalance +## `Abstract` setBalance ▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* **Parameters:** @@ -179,11 +162,11 @@ Name | Type | ___ -### `Abstract` setProxyAllowance +## `Abstract` setProxyAllowance ▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* -*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* +*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* **Parameters:** @@ -197,31 +180,24 @@ Name | Type |
-> # Class: AbstractOrderFilledCancelledFetcher +# Class: AbstractOrderFilledCancelledFetcher An abstract class to be implemented in order to use OrderStateUtils. The class that implements this interface must be capable of fetching the amount filled of an order and whether it's been cancelled. -## Hierarchy +### Hierarchy * **AbstractOrderFilledCancelledFetcher** -## Index ### Methods -* [getFilledTakerAmountAsync](#abstract-getfilledtakeramountasync) -* [getZRXAssetData](#abstract-getzrxassetdata) -* [isOrderCancelledAsync](#abstract-isordercancelledasync) - -## Methods - -### `Abstract` getFilledTakerAmountAsync +## `Abstract` getFilledTakerAmountAsync ▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* +*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* Get the amount of the order's takerToken amount already filled @@ -237,21 +213,21 @@ FilledTakerAmount ___ -### `Abstract` getZRXAssetData +## `Abstract` getZRXAssetData ▸ **getZRXAssetData**(): *string* -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)* +*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)* **Returns:** *string* ___ -### `Abstract` isOrderCancelledAsync +## `Abstract` isOrderCancelledAsync ▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* +*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* Whether an order is cancelled @@ -267,46 +243,34 @@ Whether or not the order is cancelled
-> # Class: AbstractOrderFilledCancelledLazyStore +# Class: AbstractOrderFilledCancelledLazyStore -## Hierarchy +### Hierarchy * **AbstractOrderFilledCancelledLazyStore** -## Implemented by +### Implemented by * [OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) -## Index ### Methods -* [deleteAll](#abstract-deleteall) -* [deleteFilledTakerAmount](#abstract-deletefilledtakeramount) -* [deleteIsCancelled](#abstract-deleteiscancelled) -* [getFilledTakerAmountAsync](#abstract-getfilledtakeramountasync) -* [getIsCancelledAsync](#abstract-getiscancelledasync) -* [getZRXAssetData](#abstract-getzrxassetdata) -* [setFilledTakerAmount](#abstract-setfilledtakeramount) -* [setIsCancelled](#abstract-setiscancelled) - -## Methods - -### `Abstract` deleteAll +## `Abstract` deleteAll ▸ **deleteAll**(): *void* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* **Returns:** *void* ___ -### `Abstract` deleteFilledTakerAmount +## `Abstract` deleteFilledTakerAmount ▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* **Parameters:** @@ -318,11 +282,11 @@ Name | Type | ___ -### `Abstract` deleteIsCancelled +## `Abstract` deleteIsCancelled ▸ **deleteIsCancelled**(`orderHash`: string): *void* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* **Parameters:** @@ -334,11 +298,11 @@ Name | Type | ___ -### `Abstract` getFilledTakerAmountAsync +## `Abstract` getFilledTakerAmountAsync ▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* **Parameters:** @@ -350,11 +314,11 @@ Name | Type | ___ -### `Abstract` getIsCancelledAsync +## `Abstract` getIsCancelledAsync ▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* **Parameters:** @@ -366,21 +330,21 @@ Name | Type | ___ -### `Abstract` getZRXAssetData +## `Abstract` getZRXAssetData ▸ **getZRXAssetData**(): *string* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)* **Returns:** *string* ___ -### `Abstract` setFilledTakerAmount +## `Abstract` setFilledTakerAmount ▸ **setFilledTakerAmount**(`orderHash`: string, `balance`: `BigNumber`): *void* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* **Parameters:** @@ -393,11 +357,11 @@ Name | Type | ___ -### `Abstract` setIsCancelled +## `Abstract` setIsCancelled ▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* -*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* +*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* **Parameters:** @@ -410,32 +374,23 @@ Name | Type |
-> # Class: ExchangeTransferSimulator +# Class: ExchangeTransferSimulator An exchange transfer simulator which simulates asset transfers exactly how the 0x exchange contract would do them. -## Hierarchy +### Hierarchy * **ExchangeTransferSimulator** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](_abstract_abstract_balance_and_proxy_allowance_lazy_store_.abstractbalanceandproxyallowancelazystore.md)): *[ExchangeTransferSimulator](#class-exchangetransfersimulator)* -* [transferFromAsync](#transferfromasync) - -## Constructors - -### constructor - -\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](#class-exchangetransfersimulator)* - -*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* +*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* Instantiate a ExchangeTransferSimulator @@ -449,13 +404,13 @@ Name | Type | Description | an instance of ExchangeTransferSimulator -## Methods +### Methods -### transferFromAsync +## transferFromAsync ▸ **transferFromAsync**(`assetData`: string, `from`: string, `to`: string, `amountInBaseUnits`: `BigNumber`, `tradeSide`: [TradeSide](#enumeration-tradeside), `transferType`: [TransferType](#enumeration-transfertype)): *`Promise`* -*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* +*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* Simulates transferFrom call performed by a proxy @@ -474,31 +429,20 @@ Name | Type | Description |
-> # Class: OrderStateUtils +# Class: OrderStateUtils -## Hierarchy +### Hierarchy * **OrderStateUtils** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md), `orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderStateUtils](#class-orderstateutils)* -* [getMaxFillableTakerAssetAmountAsync](#getmaxfillabletakerassetamountasync) -* [getOpenOrderRelevantStateAsync](#getopenorderrelevantstateasync) -* [getOpenOrderStateAsync](#getopenorderstateasync) - -## Constructors - -### constructor - -\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-orderstateutils)* - -*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L98)* +*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_state_utils.ts#L98)* Instantiate OrderStateUtils @@ -513,13 +457,13 @@ Name | Type | Description | Instance of OrderStateUtils -## Methods +### Methods -### getMaxFillableTakerAssetAmountAsync +## getMaxFillableTakerAssetAmountAsync ▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise`* -*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L192)* +*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_state_utils.ts#L192)* Get the max amount of the supplied order's takerAmount that could still be filled @@ -536,11 +480,11 @@ fillableTakerAssetAmount ___ -### getOpenOrderRelevantStateAsync +## getOpenOrderRelevantStateAsync ▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L162)* +*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_state_utils.ts#L162)* Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc... @@ -556,11 +500,11 @@ An instance of OrderRelevantState ___ -### getOpenOrderStateAsync +## getOpenOrderStateAsync ▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise`* -*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L122)* +*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_state_utils.ts#L122)* Get the orderState for an "open" order (i.e where takerAddress=NULL_ADDRESS) This method will only check the maker's balance/allowance to calculate the @@ -580,35 +524,22 @@ Validity is defined as a non-zero amount of the order can still be filled.
-> # Class: OrderValidationUtils +# Class: OrderValidationUtils A utility class for validating orders -## Hierarchy +### Hierarchy * **OrderValidationUtils** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md), `supportedProvider`: `SupportedProvider`): *[OrderValidationUtils](#class-ordervalidationutils)* -* [validateFillOrderThrowIfInvalidAsync](#validatefillorderthrowifinvalidasync) -* [validateOrderFillableOrThrowAsync](#validateorderfillableorthrowasync) -* [isRoundingErrorFloor](#static-isroundingerrorfloor) -* [validateFillOrderBalancesAllowancesThrowIfInvalidAsync](#static-validatefillorderbalancesallowancesthrowifinvalidasync) -* [validateMakerTransferThrowIfInvalidAsync](#static-validatemakertransferthrowifinvalidasync) - -## Constructors - -### constructor - -\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-ordervalidationutils)* - -*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L159)* +*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L159)* Instantiate OrderValidationUtils @@ -623,13 +554,13 @@ Name | Type | Description | An instance of OrderValidationUtils -## Methods +### Methods -### validateFillOrderThrowIfInvalidAsync +## validateFillOrderThrowIfInvalidAsync ▸ **validateFillOrderThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string, `zrxAssetData`: string): *`Promise`* -*Defined in [order_validation_utils.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L236)* +*Defined in [order_validation_utils.ts:236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L236)* Validate a call to FillOrder and throw if it wouldn't succeed @@ -648,11 +579,11 @@ Name | Type | Description | ___ -### validateOrderFillableOrThrowAsync +## validateOrderFillableOrThrowAsync ▸ **validateOrderFillableOrThrowAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `zrxAssetData`: string, `expectedFillTakerTokenAmount?`: `BigNumber`): *`Promise`* -*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L185)* +*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L185)* Validate if the supplied order is fillable, and throw if it isn't @@ -669,11 +600,11 @@ Name | Type | Description | ___ -### `Static` isRoundingErrorFloor +## `Static` isRoundingErrorFloor ▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean* -*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L34)* +*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L34)* A Typescript implementation mirroring the implementation of isRoundingError in the Exchange smart contract @@ -690,11 +621,11 @@ Name | Type | Description | ___ -### `Static` validateFillOrderBalancesAllowancesThrowIfInvalidAsync +## `Static` validateFillOrderBalancesAllowancesThrowIfInvalidAsync ▸ **validateFillOrderBalancesAllowancesThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `senderAddress`: string, `zrxAssetData`: string): *`Promise`* -*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L61)* +*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L61)* Validate that the maker & taker have sufficient balances/allowances to fill the supplied order to the fillTakerAssetAmount amount @@ -713,11 +644,11 @@ Name | Type | Description | ___ -### `Static` validateMakerTransferThrowIfInvalidAsync +## `Static` validateMakerTransferThrowIfInvalidAsync ▸ **validateMakerTransferThrowIfInvalidAsync**(`networkId`: `NetworkId`, `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise`* -*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L127)* +*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/order_validation_utils.ts#L127)* Validate the transfer from the maker to the taker. This is simulated on-chain via an eth_call. If this call fails, the asset is currently nontransferable. @@ -736,29 +667,20 @@ Name | Type | Description |
-> # Class: RemainingFillableCalculator +# Class: RemainingFillableCalculator -## Hierarchy +### Hierarchy * **RemainingFillableCalculator** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [computeRemainingFillable](#computeremainingfillable) - -## Constructors - -### constructor +## constructer \+ **new RemainingFillableCalculator**(`orderFee`: `BigNumber`, `orderAssetAmount`: `BigNumber`, `isTraderAssetZRX`: boolean, `transferrableAssetAmount`: `BigNumber`, `transferrableFeeAmount`: `BigNumber`, `remainingOrderAssetAmount`: `BigNumber`): *[RemainingFillableCalculator](#class-remainingfillablecalculator)* -*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L11)* +*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/remaining_fillable_calculator.ts#L11)* **Parameters:** @@ -773,54 +695,38 @@ Name | Type | **Returns:** *[RemainingFillableCalculator](#class-remainingfillablecalculator)* -## Methods +### Methods -### computeRemainingFillable +## computeRemainingFillable ▸ **computeRemainingFillable**(): *`BigNumber`* -*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L30)* +*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/remaining_fillable_calculator.ts#L30)* **Returns:** *`BigNumber`*
-> # Class: BalanceAndProxyAllowanceLazyStore +# Class: BalanceAndProxyAllowanceLazyStore Copy on read store for balances/proxyAllowances of tokens/accounts -## Hierarchy +### Hierarchy * **BalanceAndProxyAllowanceLazyStore** -## Implements +### Implements * [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md)): *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)* -* [deleteAll](#deleteall) -* [deleteAllERC721ProxyAllowance](#deleteallerc721proxyallowance) -* [deleteBalance](#deletebalance) -* [deleteProxyAllowance](#deleteproxyallowance) -* [getBalanceAsync](#getbalanceasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) -* [setBalance](#setbalance) -* [setProxyAllowance](#setproxyallowance) - -## Constructors - -### constructor - -\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-balanceandproxyallowancelazystore)* - -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)* Instantiates a BalanceAndProxyAllowanceLazyStore @@ -834,13 +740,13 @@ Name | Type | Description | Instance of BalanceAndProxyAllowanceLazyStore -## Methods +### Methods -### deleteAll +## deleteAll ▸ **deleteAll**(): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)* Delete all balances & allowances @@ -848,11 +754,11 @@ Delete all balances & allowances ___ -### deleteAllERC721ProxyAllowance +## deleteAllERC721ProxyAllowance ▸ **deleteAllERC721ProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)* Clear all ERC721 0x proxy allowances a user has on all items of a specific ERC721 contract @@ -867,11 +773,11 @@ Name | Type | Description | ___ -### deleteBalance +## deleteBalance ▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)* Clear the balance of an asset for a user @@ -886,11 +792,11 @@ Name | Type | Description | ___ -### deleteProxyAllowance +## deleteProxyAllowance ▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)* Clear the 0x asset proxy allowance @@ -905,11 +811,11 @@ Name | Type | Description | ___ -### getBalanceAsync +## getBalanceAsync ▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)* Get a users balance of an asset @@ -924,11 +830,11 @@ Name | Type | Description | ___ -### getProxyAllowanceAsync +## getProxyAllowanceAsync ▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)* Get the 0x asset proxy allowance @@ -943,11 +849,11 @@ Name | Type | Description | ___ -### setBalance +## setBalance ▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)* Set the balance of an asset for a user @@ -963,11 +869,11 @@ Name | Type | Description | ___ -### setProxyAllowance +## setProxyAllowance ▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)* +*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)* Set the 0x asset proxy allowance @@ -983,44 +889,26 @@ Name | Type | Description |
-> # Class: OrderFilledCancelledLazyStore +# Class: OrderFilledCancelledLazyStore Copy on read store for balances/proxyAllowances of tokens/accounts -## Hierarchy +### Hierarchy * **OrderFilledCancelledLazyStore** -## Implements +### Implements * [AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)* -* [deleteAll](#deleteall) -* [deleteAllFilled](#deleteallfilled) -* [deleteAllIsCancelled](#deletealliscancelled) -* [deleteFilledTakerAmount](#deletefilledtakeramount) -* [deleteIsCancelled](#deleteiscancelled) -* [getFilledTakerAmountAsync](#getfilledtakeramountasync) -* [getIsCancelledAsync](#getiscancelledasync) -* [getZRXAssetData](#getzrxassetdata) -* [setFilledTakerAmount](#setfilledtakeramount) -* [setIsCancelled](#setiscancelled) - -## Constructors - -### constructor - -\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-orderfilledcancelledlazystore)* - -*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* Instantiate a OrderFilledCancelledLazyStore @@ -1034,13 +922,13 @@ Name | Type | Description | An instance of OrderFilledCancelledLazyStore -## Methods +### Methods -### deleteAll +## deleteAll ▸ **deleteAll**(): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* Clear all filled/cancelled state @@ -1048,11 +936,11 @@ Clear all filled/cancelled state ___ -### deleteAllFilled +## deleteAllFilled ▸ **deleteAllFilled**(): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* Clear all filled state @@ -1060,11 +948,11 @@ Clear all filled state ___ -### deleteAllIsCancelled +## deleteAllIsCancelled ▸ **deleteAllIsCancelled**(): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* Clear all cancelled state @@ -1072,11 +960,11 @@ Clear all cancelled state ___ -### deleteFilledTakerAmount +## deleteFilledTakerAmount ▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* Clear the filledTakerAssetAmount of an order @@ -1090,11 +978,11 @@ Name | Type | Description | ___ -### deleteIsCancelled +## deleteIsCancelled ▸ **deleteIsCancelled**(`orderHash`: string): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* Clear whether the order has been cancelled if already set @@ -1108,11 +996,11 @@ Name | Type | Description | ___ -### getFilledTakerAmountAsync +## getFilledTakerAmountAsync ▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* -*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* Get the filledTakerAssetAmount of an order @@ -1128,11 +1016,11 @@ filledTakerAssetAmount ___ -### getIsCancelledAsync +## getIsCancelledAsync ▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* -*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* Check if an order has been cancelled @@ -1148,11 +1036,11 @@ Whether the order has been cancelled ___ -### getZRXAssetData +## getZRXAssetData ▸ **getZRXAssetData**(): *string* -*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)* Get the ZRX assetData @@ -1160,11 +1048,11 @@ Get the ZRX assetData ___ -### setFilledTakerAmount +## setFilledTakerAmount ▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* Set the filledTakerAssetAmount of an order @@ -1179,11 +1067,11 @@ Name | Type | Description | ___ -### setIsCancelled +## setIsCancelled ▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* -*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* +*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* Set whether an order has been cancelled or not @@ -1198,208 +1086,172 @@ Name | Type | Description |
-> # Enumeration: TradeSide +# Enumeration: TradeSide -## Index ### Enumeration members -* [Maker](#maker) -* [Taker](#taker) - -## Enumeration members - -### Maker +## Maker • **Maker**: = "maker" -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L9)* ___ -### Taker +## Taker • **Taker**: = "taker" -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L10)*
-> # Enumeration: TransferType +# Enumeration: TransferType -## Index ### Enumeration members -* [Fee](#fee) -* [Trade](#trade) - -## Enumeration members - -### Fee +## Fee • **Fee**: = "fee" -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L15)* ___ -### Trade +## Trade • **Trade**: = "trade" -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L14)*
-> # Enumeration: TypedDataError +# Enumeration: TypedDataError -## Index ### Enumeration members -* [InvalidMetamaskSigner](#invalidmetamasksigner) -* [InvalidSignature](#invalidsignature) - -## Enumeration members - -### InvalidMetamaskSigner +## InvalidMetamaskSigner • **InvalidMetamaskSigner**: = "MetaMask provider must be wrapped in a MetamaskSubprovider (from the '@0x/subproviders' package) in order to work with this method." -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L5)* ___ -### InvalidSignature +## InvalidSignature • **InvalidSignature**: = "INVALID_SIGNATURE" -*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L4)* +*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L4)*
-> # Interface: CreateOrderOpts +# Interface: CreateOrderOpts -## Hierarchy +### Hierarchy * **CreateOrderOpts** -## Index ### Properties -* [expirationTimeSeconds](#optional-expirationtimeseconds) -* [feeRecipientAddress](#optional-feerecipientaddress) -* [makerFee](#optional-makerfee) -* [salt](#optional-salt) -* [senderAddress](#optional-senderaddress) -* [takerAddress](#optional-takeraddress) -* [takerFee](#optional-takerfee) - -## Properties - -### `Optional` expirationTimeSeconds +## `Optional` expirationTimeSeconds • **expirationTimeSeconds**? : *`BigNumber`* -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L25)* ___ -### `Optional` feeRecipientAddress +## `Optional` feeRecipientAddress • **feeRecipientAddress**? : *undefined | string* -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L23)* ___ -### `Optional` makerFee +## `Optional` makerFee • **makerFee**? : *`BigNumber`* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L21)* ___ -### `Optional` salt +## `Optional` salt • **salt**? : *`BigNumber`* -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L24)* ___ -### `Optional` senderAddress +## `Optional` senderAddress • **senderAddress**? : *undefined | string* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L20)* ___ -### `Optional` takerAddress +## `Optional` takerAddress • **takerAddress**? : *undefined | string* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L19)* ___ -### `Optional` takerFee +## `Optional` takerFee • **takerFee**? : *`BigNumber`* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L22)*
-> # Interface: FeeOrdersAndRemainingFeeAmount <**T**> +# Interface: FeeOrdersAndRemainingFeeAmount <**T**> -## Type parameters +### Type parameters ▪ **T** -## Hierarchy +### Hierarchy * **FeeOrdersAndRemainingFeeAmount** -## Index ### Properties -* [feeOrdersRemainingFillableMakerAssetAmounts](#feeordersremainingfillablemakerassetamounts) -* [remainingFeeAmount](#remainingfeeamount) -* [resultFeeOrders](#resultfeeorders) - -## Properties - -### feeOrdersRemainingFillableMakerAssetAmounts +## feeOrdersRemainingFillableMakerAssetAmounts • **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L70)* ___ -### remainingFeeAmount +## remainingFeeAmount • **remainingFeeAmount**: *`BigNumber`* -*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L71)* ___ -### resultFeeOrders +## resultFeeOrders • **resultFeeOrders**: *`T`[]* -*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L69)*
-> # Interface: FindFeeOrdersThatCoverFeesForTargetOrdersOpts +# Interface: FindFeeOrdersThatCoverFeesForTargetOrdersOpts remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. @@ -1410,45 +1262,38 @@ Defaults to `makerAssetAmount` values from the feeOrders param. slippageBufferAmount: An additional amount of fee to be covered by the result in case of trade collisions or partial fills. Defaults to 0 -## Hierarchy +### Hierarchy * **FindFeeOrdersThatCoverFeesForTargetOrdersOpts** -## Index ### Properties -* [remainingFillableFeeAmounts](#optional-remainingfillablefeeamounts) -* [remainingFillableMakerAssetAmounts](#optional-remainingfillablemakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableFeeAmounts +## `Optional` remainingFillableFeeAmounts • **remainingFillableFeeAmounts**? : *`BigNumber`[]* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L64)* ___ -### `Optional` remainingFillableMakerAssetAmounts +## `Optional` remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L63)* ___ -### `Optional` slippageBufferAmount +## `Optional` slippageBufferAmount • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L65)*
-> # Interface: FindOrdersThatCoverMakerAssetFillAmountOpts +# Interface: FindOrdersThatCoverMakerAssetFillAmountOpts remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. @@ -1456,36 +1301,30 @@ Defaults to `makerAssetAmount` values from the orders param. slippageBufferAmount: An additional amount of makerAsset to be covered by the result in case of trade collisions or partial fills. Defaults to 0 -## Hierarchy +### Hierarchy * **FindOrdersThatCoverMakerAssetFillAmountOpts** -## Index ### Properties -* [remainingFillableMakerAssetAmounts](#optional-remainingfillablemakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableMakerAssetAmounts +## `Optional` remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L36)* ___ -### `Optional` slippageBufferAmount +## `Optional` slippageBufferAmount • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L37)*
-> # Interface: FindOrdersThatCoverTakerAssetFillAmountOpts +# Interface: FindOrdersThatCoverTakerAssetFillAmountOpts remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter. You can use `OrderStateUtils` `@0x/order-utils` to perform blockchain lookups for these values. @@ -1493,196 +1332,100 @@ Defaults to `makerAssetAmount` values from the orders param. slippageBufferAmount: An additional amount of makerAsset to be covered by the result in case of trade collisions or partial fills. Defaults to 0 -## Hierarchy +### Hierarchy * **FindOrdersThatCoverTakerAssetFillAmountOpts** -## Index ### Properties -* [remainingFillableTakerAssetAmounts](#optional-remainingfillabletakerassetamounts) -* [slippageBufferAmount](#optional-slippagebufferamount) - -## Properties - -### `Optional` remainingFillableTakerAssetAmounts +## `Optional` remainingFillableTakerAssetAmounts • **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L48)* ___ -### `Optional` slippageBufferAmount +## `Optional` slippageBufferAmount • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L49)*
-> # Interface: OrdersAndRemainingMakerFillAmount <**T**> +# Interface: OrdersAndRemainingMakerFillAmount <**T**> -## Type parameters +### Type parameters ▪ **T** -## Hierarchy +### Hierarchy * **OrdersAndRemainingMakerFillAmount** -## Index ### Properties -* [ordersRemainingFillableMakerAssetAmounts](#ordersremainingfillablemakerassetamounts) -* [remainingFillAmount](#remainingfillamount) -* [resultOrders](#resultorders) - -## Properties - -### ordersRemainingFillableMakerAssetAmounts +## ordersRemainingFillableMakerAssetAmounts • **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L76)* ___ -### remainingFillAmount +## remainingFillAmount • **remainingFillAmount**: *`BigNumber`* -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L77)* ___ -### resultOrders +## resultOrders • **resultOrders**: *`T`[]* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L75)*
-> # Interface: OrdersAndRemainingTakerFillAmount <**T**> +# Interface: OrdersAndRemainingTakerFillAmount <**T**> -## Type parameters +### Type parameters ▪ **T** -## Hierarchy +### Hierarchy * **OrdersAndRemainingTakerFillAmount** -## Index ### Properties -* [ordersRemainingFillableTakerAssetAmounts](#ordersremainingfillabletakerassetamounts) -* [remainingFillAmount](#remainingfillamount) -* [resultOrders](#resultorders) - -## Properties - -### ordersRemainingFillableTakerAssetAmounts +## ordersRemainingFillableTakerAssetAmounts • **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L82)* +*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L82)* ___ -### remainingFillAmount +## remainingFillAmount • **remainingFillAmount**: *`BigNumber`* -*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L83)* +*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L83)* ___ -### resultOrders +## resultOrders • **resultOrders**: *`T`[]* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L81)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [abstract/abstract_balance_and_proxy_allowance_fetcher](modules/_abstract_abstract_balance_and_proxy_allowance_fetcher_.md) - * [abstract/abstract_balance_and_proxy_allowance_fetcher.AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store](modules/_abstract_abstract_balance_and_proxy_allowance_lazy_store_.md) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [abstract/abstract_order_filled_cancelled_fetcher](modules/_abstract_abstract_order_filled_cancelled_fetcher_.md) - * [abstract/abstract_order_filled_cancelled_fetcher.AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) - * [abstract/abstract_order_filled_cancelled_lazy_store](modules/_abstract_abstract_order_filled_cancelled_lazy_store_.md) - * [abstract/abstract_order_filled_cancelled_lazy_store.AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - * [assert](modules/_assert_.md) - * [asset_data_utils](modules/_asset_data_utils_.md) - * [constants](modules/_constants_.md) - * [crypto](modules/_crypto_.md) - * [eip712_utils](modules/_eip712_utils_.md) - * [exchange_transfer_simulator](modules/_exchange_transfer_simulator_.md) - * [exchange_transfer_simulator.ExchangeTransferSimulator](#class-exchangetransfersimulator) - * [index](modules/_index_.md) - * [market_utils](modules/_market_utils_.md) - * [order_calculation_utils](modules/_order_calculation_utils_.md) - * [order_factory](modules/_order_factory_.md) - * [order_hash](modules/_order_hash_.md) - * [order_state_utils](modules/_order_state_utils_.md) - * [order_state_utils.OrderStateUtils](#class-orderstateutils) - * [order_validation_utils](modules/_order_validation_utils_.md) - * [order_validation_utils.OrderValidationUtils](#class-ordervalidationutils) - * [parsing_utils](modules/_parsing_utils_.md) - * [rate_utils](modules/_rate_utils_.md) - * [remaining_fillable_calculator](modules/_remaining_fillable_calculator_.md) - * [remaining_fillable_calculator.RemainingFillableCalculator](#class-remainingfillablecalculator) - * [salt](modules/_salt_.md) - * [signature_utils](modules/_signature_utils_.md) - * [sorting_utils](modules/_sorting_utils_.md) - * [store/balance_and_proxy_allowance_lazy_store](modules/_store_balance_and_proxy_allowance_lazy_store_.md) - * [store/balance_and_proxy_allowance_lazy_store.BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - * [store/order_filled_cancelled_lazy_store](modules/_store_order_filled_cancelled_lazy_store_.md) - * [store/order_filled_cancelled_lazy_store.OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) - * [transaction_hash](modules/_transaction_hash_.md) - * [types](modules/_types_.md) - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.TypedDataError](#class-typeddataerror) - * [types.CreateOrderOpts](#class-createorderopts) - * [types.FeeOrdersAndRemainingFeeAmount](#class-feeordersandremainingfeeamount) - * [types.FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#class-findfeeordersthatcoverfeesfortargetordersopts) - * [types.FindOrdersThatCoverMakerAssetFillAmountOpts](#class-findordersthatcovermakerassetfillamountopts) - * [types.FindOrdersThatCoverTakerAssetFillAmountOpts](#class-findordersthatcovertakerassetfillamountopts) - * [types.OrdersAndRemainingMakerFillAmount](#class-ordersandremainingmakerfillamount) - * [types.OrdersAndRemainingTakerFillAmount](#class-ordersandremainingtakerfillamount) - * [utils](modules/_utils_.md) -* [Classes]() - * [abstract/abstract_balance_and_proxy_allowance_fetcher.AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) - * [abstract/abstract_balance_and_proxy_allowance_lazy_store.AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - * [abstract/abstract_order_filled_cancelled_fetcher.AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) - * [abstract/abstract_order_filled_cancelled_lazy_store.AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - * [exchange_transfer_simulator.ExchangeTransferSimulator](#class-exchangetransfersimulator) - * [order_state_utils.OrderStateUtils](#class-orderstateutils) - * [order_validation_utils.OrderValidationUtils](#class-ordervalidationutils) - * [remaining_fillable_calculator.RemainingFillableCalculator](#class-remainingfillablecalculator) - * [store/balance_and_proxy_allowance_lazy_store.BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - * [store/order_filled_cancelled_lazy_store.OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) -* [Enums]() - * [types.TradeSide](#class-tradeside) - * [types.TransferType](#class-transfertype) - * [types.TypedDataError](#class-typeddataerror) -* [Interfaces]() - * [types.CreateOrderOpts](#class-createorderopts) - * [types.FeeOrdersAndRemainingFeeAmount](#class-feeordersandremainingfeeamount) - * [types.FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#class-findfeeordersthatcoverfeesfortargetordersopts) - * [types.FindOrdersThatCoverMakerAssetFillAmountOpts](#class-findordersthatcovermakerassetfillamountopts) - * [types.FindOrdersThatCoverTakerAssetFillAmountOpts](#class-findordersthatcovertakerassetfillamountopts) - * [types.OrdersAndRemainingMakerFillAmount](#class-ordersandremainingmakerfillamount) - * [types.OrdersAndRemainingTakerFillAmount](#class-ordersandremainingtakerfillamount) +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/order-utils/src/types.ts#L81)*
diff --git a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/README.md b/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/README.md deleted file mode 100644 index a754b23ebe..0000000000 --- a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/README.md +++ /dev/null @@ -1,97 +0,0 @@ -## @0x/sol-compiler - -Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds: - -- Smart re-compilation: Only recompiles when smart contracts have changed -- Ability to compile an entire project instead of only individual `.sol` files -- Compilation using the Solidity version specified at the top of each individual `.sol` file -- Proper parsing of Solidity version ranges -- Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content). - -### Read the [Documentation](https://0xproject.com/docs/sol-compiler). - -## Installation - -#### CLI Installation - -```bash -yarn global add @0x/sol-compiler -``` - -#### API Installation - -```bash -yarn add @0x/sol-compiler -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -**Import** - -```typescript -import { Compiler } from '@0x/sol-compiler'; -``` - -or - -```javascript -var Compiler = require('@0x/sol-compiler').Compiler; -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/sol-compiler yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/sol-compiler yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/reference.mdx b/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/reference.mdx deleted file mode 100644 index caca9c942d..0000000000 --- a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.11/reference.mdx +++ /dev/null @@ -1,401 +0,0 @@ -> # Class: Compiler - -The Compiler facilitates compiling Solidity smart contracts and saves the results -to artifact files. - -## Hierarchy - -* **Compiler** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [compileAsync](#compileasync) -* [getCompilerOutputsAsync](#getcompileroutputsasync) -* [watchAsync](#watchasync) - -## Constructors - -### constructor - -\+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)* - -*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L94)* - -Instantiates a new instance of the Compiler class. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts?` | `CompilerOptions` | Optional compiler options | - -**Returns:** *[Compiler](#class-compiler)* - -An instance of the Compiler class. - -## Methods - -### compileAsync - -▸ **compileAsync**(): *`Promise`* - -*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L132)* - -Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`. - -**Returns:** *`Promise`* - -___ - -### getCompilerOutputsAsync - -▸ **getCompilerOutputsAsync**(): *`Promise`* - -*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L145)* - -Compiles Solidity files specified during instantiation, and returns the -compiler output given by solc. Return value is an array of outputs: -Solidity modules are batched together by version required, and each -element of the returned array corresponds to a compiler version, and -each element contains the output for all of the modules compiled with -that version. - -**Returns:** *`Promise`* - -___ - -### watchAsync - -▸ **watchAsync**(): *`Promise`* - -*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L149)* - -**Returns:** *`Promise`* - -
- -> # Class: CompilationError - -## Hierarchy - -* `Error` - - * **CompilationError** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [errorsCount](#errorscount) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [typeName](#typename) -* [Error](#static-error) - -## Constructors - -### constructor - -\+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)* - -*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)* - -**Parameters:** - -Name | Type | ------- | ------ | -`errorsCount` | number | - -**Returns:** *[CompilationError](#class-compilationerror)* - -## Properties - -### errorsCount - -• **errorsCount**: *number* - -*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L38)* - -___ - -### message - -• **message**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 - -___ - -### name - -• **name**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 - -___ - -### typeName - -• **typeName**: *string* = "CompilationError" - -*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)* - -___ - -### `Static` Error - -▪ **Error**: *`ErrorConstructor`* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 - -
- -> # Enumeration: AbiType - -## Index - -### Enumeration members - -* [Constructor](#constructor) -* [Event](#event) -* [Fallback](#fallback) -* [Function](#function) - -## Enumeration members - -### Constructor - -• **Constructor**: = "constructor" - -*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L3)* - -___ - -### Event - -• **Event**: = "event" - -*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L4)* - -___ - -### Fallback - -• **Fallback**: = "fallback" - -*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L5)* - -___ - -### Function - -• **Function**: = "function" - -*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L2)* - -
- -> # Interface: BinaryPaths - -## Hierarchy - -* **BinaryPaths** - -## Indexable - -● \[▪ **key**: *string*\]: string - -
- -> # Interface: ContractSourceData - -## Hierarchy - -* **ContractSourceData** - -## Indexable - -● \[▪ **contractName**: *string*\]: [ContractSpecificSourceData](#class-contractspecificsourcedata) - -
- -> # Interface: ContractSpecificSourceData - -## Hierarchy - -* **ContractSpecificSourceData** - -## Index - -### Properties - -* [solcVersionRange](#solcversionrange) -* [sourceHash](#sourcehash) -* [sourceTreeHash](#sourcetreehash) - -## Properties - -### solcVersionRange - -• **solcVersionRange**: *string* - -*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L21)* - -___ - -### sourceHash - -• **sourceHash**: *`Buffer`* - -*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L22)* - -___ - -### sourceTreeHash - -• **sourceTreeHash**: *`Buffer`* - -*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L23)* - -
- -> # Interface: SolcErrors - -## Hierarchy - -* **SolcErrors** - -## Indexable - -● \[▪ **key**: *string*\]: boolean - -
- -> # Interface: Token - -## Hierarchy - -* **Token** - -## Index - -### Properties - -* [address](#optional-address) -* [decimals](#decimals) -* [ipfsHash](#ipfshash) -* [name](#name) -* [swarmHash](#swarmhash) -* [symbol](#symbol) - -## Properties - -### `Optional` address - -• **address**? : *undefined | string* - -*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L27)* - -___ - -### decimals - -• **decimals**: *number* - -*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L30)* - -___ - -### ipfsHash - -• **ipfsHash**: *string* - -*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L31)* - -___ - -### name - -• **name**: *string* - -*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L28)* - -___ - -### swarmHash - -• **swarmHash**: *string* - -*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L32)* - -___ - -### symbol - -• **symbol**: *string* - -*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L29)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [cli](modules/_cli_.md) - * [compiler](modules/_compiler_.md) - * [compiler.Compiler](#class-compiler) - * [index](modules/_index_.md) - * [schemas/compiler_options_schema](modules/_schemas_compiler_options_schema_.md) - * [utils/compiler](modules/_utils_compiler_.md) - * [utils/constants](modules/_utils_constants_.md) - * [utils/encoder](modules/_utils_encoder_.md) - * [utils/fs_wrapper](modules/_utils_fs_wrapper_.md) - * [utils/types](modules/_utils_types_.md) - * [utils/types.AbiType](#class-abitype) - * [utils/types.CompilationError](#class-compilationerror) - * [utils/types.BinaryPaths](#class-binarypaths) - * [utils/types.ContractSourceData](#class-contractsourcedata) - * [utils/types.ContractSpecificSourceData](#class-contractspecificsourcedata) - * [utils/types.SolcErrors](#class-solcerrors) - * [utils/types.Token](#class-token) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [compiler.Compiler](#class-compiler) - * [utils/types.CompilationError](#class-compilationerror) -* [Enums]() - * [utils/types.AbiType](#class-abitype) -* [Interfaces]() - * [utils/types.BinaryPaths](#class-binarypaths) - * [utils/types.ContractSourceData](#class-contractsourcedata) - * [utils/types.ContractSpecificSourceData](#class-contractspecificsourcedata) - * [utils/types.SolcErrors](#class-solcerrors) - * [utils/types.Token](#class-token) - -
- diff --git a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.12/reference.mdx b/packages/website/mdx/tools/@0x/sol-compiler/v3.1.12/reference.mdx index caca9c942d..ab10fc5b8e 100644 --- a/packages/website/mdx/tools/@0x/sol-compiler/v3.1.12/reference.mdx +++ b/packages/website/mdx/tools/@0x/sol-compiler/v3.1.12/reference.mdx @@ -1,31 +1,20 @@ -> # Class: Compiler +# Class: Compiler The Compiler facilitates compiling Solidity smart contracts and saves the results to artifact files. -## Hierarchy +### Hierarchy * **Compiler** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [compileAsync](#compileasync) -* [getCompilerOutputsAsync](#getcompileroutputsasync) -* [watchAsync](#watchasync) - -## Constructors - -### constructor +## constructer \+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)* -*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L94)* +*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/compiler.ts#L94)* Instantiates a new instance of the Compiler class. @@ -39,13 +28,13 @@ Name | Type | Description | An instance of the Compiler class. -## Methods +### Methods -### compileAsync +## compileAsync ▸ **compileAsync**(): *`Promise`* -*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L132)* +*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/compiler.ts#L132)* Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`. @@ -53,11 +42,11 @@ Compiles selected Solidity files found in `contractsDir` and writes JSON artifac ___ -### getCompilerOutputsAsync +## getCompilerOutputsAsync ▸ **getCompilerOutputsAsync**(): *`Promise`* -*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L145)* +*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/compiler.ts#L145)* Compiles Solidity files specified during instantiation, and returns the compiler output given by solc. Return value is an array of outputs: @@ -70,46 +59,32 @@ that version. ___ -### watchAsync +## watchAsync ▸ **watchAsync**(): *`Promise`* -*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L149)* +*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/compiler.ts#L149)* **Returns:** *`Promise`*
-> # Class: CompilationError +# Class: CompilationError -## Hierarchy +### Hierarchy * `Error` * **CompilationError** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [errorsCount](#errorscount) -* [message](#message) -* [name](#name) -* [stack](#optional-stack) -* [typeName](#typename) -* [Error](#static-error) - -## Constructors - -### constructor +## constructer \+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)* -*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)* +*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L39)* **Parameters:** @@ -119,283 +94,203 @@ Name | Type | **Returns:** *[CompilationError](#class-compilationerror)* -## Properties +### Properties -### errorsCount +## errorsCount • **errorsCount**: *number* -*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L38)* +*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L38)* ___ -### message +## message • **message**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974 + + ___ -### name +## name • **name**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:973 + + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:975 + ___ -### typeName +## typeName • **typeName**: *string* = "CompilationError" -*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)* +*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L39)* ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:984 +
-> # Enumeration: AbiType +# Enumeration: AbiType -## Index ### Enumeration members -* [Constructor](#constructor) -* [Event](#event) -* [Fallback](#fallback) -* [Function](#function) - -## Enumeration members - -### Constructor +## Constructor • **Constructor**: = "constructor" -*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L3)* +*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L3)* ___ -### Event +## Event • **Event**: = "event" -*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L4)* +*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L4)* ___ -### Fallback +## Fallback • **Fallback**: = "fallback" -*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L5)* +*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L5)* ___ -### Function +## Function • **Function**: = "function" -*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L2)* +*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L2)*
-> # Interface: BinaryPaths +# Interface: BinaryPaths -## Hierarchy +### Hierarchy * **BinaryPaths** -## Indexable -● \[▪ **key**: *string*\]: string - -
- -> # Interface: ContractSourceData - -## Hierarchy +### Hierarchy * **ContractSourceData** -## Indexable -● \[▪ **contractName**: *string*\]: [ContractSpecificSourceData](#class-contractspecificsourcedata) - -
- -> # Interface: ContractSpecificSourceData - -## Hierarchy +### Hierarchy * **ContractSpecificSourceData** -## Index ### Properties -* [solcVersionRange](#solcversionrange) -* [sourceHash](#sourcehash) -* [sourceTreeHash](#sourcetreehash) - -## Properties - -### solcVersionRange +## solcVersionRange • **solcVersionRange**: *string* -*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L21)* +*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L21)* ___ -### sourceHash +## sourceHash • **sourceHash**: *`Buffer`* -*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L22)* +*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L22)* ___ -### sourceTreeHash +## sourceTreeHash • **sourceTreeHash**: *`Buffer`* -*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L23)* +*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L23)*
-> # Interface: SolcErrors +# Interface: SolcErrors -## Hierarchy +### Hierarchy * **SolcErrors** -## Indexable -● \[▪ **key**: *string*\]: boolean - -
- -> # Interface: Token - -## Hierarchy +### Hierarchy * **Token** -## Index ### Properties -* [address](#optional-address) -* [decimals](#decimals) -* [ipfsHash](#ipfshash) -* [name](#name) -* [swarmHash](#swarmhash) -* [symbol](#symbol) - -## Properties - -### `Optional` address +## `Optional` address • **address**? : *undefined | string* -*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L27)* +*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L27)* ___ -### decimals +## decimals • **decimals**: *number* -*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L30)* +*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L30)* ___ -### ipfsHash +## ipfsHash • **ipfsHash**: *string* -*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L31)* +*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L31)* ___ -### name +## name • **name**: *string* -*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L28)* +*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L28)* ___ -### swarmHash +## swarmHash • **swarmHash**: *string* -*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L32)* +*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L32)* ___ -### symbol +## symbol • **symbol**: *string* -*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L29)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [cli](modules/_cli_.md) - * [compiler](modules/_compiler_.md) - * [compiler.Compiler](#class-compiler) - * [index](modules/_index_.md) - * [schemas/compiler_options_schema](modules/_schemas_compiler_options_schema_.md) - * [utils/compiler](modules/_utils_compiler_.md) - * [utils/constants](modules/_utils_constants_.md) - * [utils/encoder](modules/_utils_encoder_.md) - * [utils/fs_wrapper](modules/_utils_fs_wrapper_.md) - * [utils/types](modules/_utils_types_.md) - * [utils/types.AbiType](#class-abitype) - * [utils/types.CompilationError](#class-compilationerror) - * [utils/types.BinaryPaths](#class-binarypaths) - * [utils/types.ContractSourceData](#class-contractsourcedata) - * [utils/types.ContractSpecificSourceData](#class-contractspecificsourcedata) - * [utils/types.SolcErrors](#class-solcerrors) - * [utils/types.Token](#class-token) - * [utils/utils](modules/_utils_utils_.md) -* [Classes]() - * [compiler.Compiler](#class-compiler) - * [utils/types.CompilationError](#class-compilationerror) -* [Enums]() - * [utils/types.AbiType](#class-abitype) -* [Interfaces]() - * [utils/types.BinaryPaths](#class-binarypaths) - * [utils/types.ContractSourceData](#class-contractsourcedata) - * [utils/types.ContractSpecificSourceData](#class-contractspecificsourcedata) - * [utils/types.SolcErrors](#class-solcerrors) - * [utils/types.Token](#class-token) +*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-compiler/src/utils/types.ts#L29)*
diff --git a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/README.md b/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/README.md deleted file mode 100644 index fc99361fde..0000000000 --- a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/README.md +++ /dev/null @@ -1,75 +0,0 @@ -## @0x/sol-coverage - -A Solidity code coverage tool. - -### Read the [Documentation](https://0xproject.com/docs/sol-coverage). - -## Installation - -```bash -yarn add @0x/sol-coverage -``` - -**Import** - -```javascript -import { CoverageSubprovider } from '@0x/sol-coverage'; -``` - -or - -```javascript -var CoverageSubprovider = require('@0x/sol-coverage').CoverageSubprovider; -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/sol-coverage yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/sol-coverage yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/reference.mdx b/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/reference.mdx deleted file mode 100644 index 2bd7034d74..0000000000 --- a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.8/reference.mdx +++ /dev/null @@ -1,212 +0,0 @@ -> # Class: CoverageSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It's used to compute your code coverage while running solidity tests. - -## Hierarchy - -* `TraceInfoSubprovider` - - * **CoverageSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) -* [writeCoverageAsync](#writecoverageasync) - -## Constructors - -### constructor - -\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#class-coveragesubprovider)* - -*Overrides void* - -*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L44)* - -Instantiates a CoverageSubprovider instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`partialConfig` | [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig) | {} | Partial configuration object | - -**Returns:** *[CoverageSubprovider](#class-coveragesubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request | -`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ - -### stop - -▸ **stop**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 - -Stops trace collection - -**Returns:** *void* - -___ - -### writeCoverageAsync - -▸ **writeCoverageAsync**(): *`Promise`* - -*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L78)* - -Write the test coverage results to a file in Istanbul format. - -**Returns:** *`Promise`* - -
- -> # Interface: CoverageSubproviderConfig - -This type defines the schema of the config object that could be passed to CoverageSubprovider -isVerbose: If true - will log any unknown transactions. Defaults to true. -ignoreFilesGlobs: The list of globs matching the file names of the files we want to ignore coverage for. Defaults to []. - -## Hierarchy - -* **CoverageSubproviderConfig** - -## Index - -### Properties - -* [ignoreFilesGlobs](#ignorefilesglobs) -* [isVerbose](#isverbose) - -## Properties - -### ignoreFilesGlobs - -• **ignoreFilesGlobs**: *string[]* - -*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L28)* - -___ - -### isVerbose - -• **isVerbose**: *boolean* - -*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L27)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [coverage_subprovider](modules/_coverage_subprovider_.md) - * [coverage_subprovider.CoverageSubprovider](#class-coveragesubprovider) - * [coverage_subprovider.CoverageSubproviderConfig](#class-coveragesubproviderconfig) - * [index](modules/_index_.md) -* [Classes]() - * [coverage_subprovider.CoverageSubprovider](#class-coveragesubprovider) -* [Interfaces]() - * [coverage_subprovider.CoverageSubproviderConfig](#class-coveragesubproviderconfig) - -
- diff --git a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.9/reference.mdx b/packages/website/mdx/tools/@0x/sol-coverage/v3.0.9/reference.mdx index 2bd7034d74..884f0793b9 100644 --- a/packages/website/mdx/tools/@0x/sol-coverage/v3.0.9/reference.mdx +++ b/packages/website/mdx/tools/@0x/sol-coverage/v3.0.9/reference.mdx @@ -1,38 +1,24 @@ -> # Class: CoverageSubprovider +# Class: CoverageSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It's used to compute your code coverage while running solidity tests. -## Hierarchy +### Hierarchy * `TraceInfoSubprovider` * **CoverageSubprovider** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) -* [writeCoverageAsync](#writecoverageasync) - -## Constructors - -### constructor - -\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#class-coveragesubprovider)* +\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)* *Overrides void* -*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L44)* +*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-coverage/src/coverage_subprovider.ts#L44)* Instantiates a CoverageSubprovider instance @@ -46,15 +32,15 @@ Name | Type | Default | Description | **Returns:** *[CoverageSubprovider](#class-coveragesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 + + Emits a JSON RPC payload that will then be handled by the ProviderEngine instance this subprovider is a part of. The payload will cascade down the subprovider middleware @@ -72,15 +58,15 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 + This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -98,15 +84,15 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 + Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call @@ -122,13 +108,13 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 + + Starts trace collection @@ -136,13 +122,13 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 + + Stops trace collection @@ -150,11 +136,11 @@ Stops trace collection ___ -### writeCoverageAsync +## writeCoverageAsync ▸ **writeCoverageAsync**(): *`Promise`* -*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L78)* +*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-coverage/src/coverage_subprovider.ts#L78)* Write the test coverage results to a file in Istanbul format. @@ -162,51 +148,32 @@ Write the test coverage results to a file in Istanbul format.
-> # Interface: CoverageSubproviderConfig +# Interface: CoverageSubproviderConfig This type defines the schema of the config object that could be passed to CoverageSubprovider isVerbose: If true - will log any unknown transactions. Defaults to true. ignoreFilesGlobs: The list of globs matching the file names of the files we want to ignore coverage for. Defaults to []. -## Hierarchy +### Hierarchy * **CoverageSubproviderConfig** -## Index ### Properties -* [ignoreFilesGlobs](#ignorefilesglobs) -* [isVerbose](#isverbose) - -## Properties - -### ignoreFilesGlobs +## ignoreFilesGlobs • **ignoreFilesGlobs**: *string[]* -*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L28)* +*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-coverage/src/coverage_subprovider.ts#L28)* ___ -### isVerbose +## isVerbose • **isVerbose**: *boolean* -*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L27)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [coverage_subprovider](modules/_coverage_subprovider_.md) - * [coverage_subprovider.CoverageSubprovider](#class-coveragesubprovider) - * [coverage_subprovider.CoverageSubproviderConfig](#class-coveragesubproviderconfig) - * [index](modules/_index_.md) -* [Classes]() - * [coverage_subprovider.CoverageSubprovider](#class-coveragesubprovider) -* [Interfaces]() - * [coverage_subprovider.CoverageSubproviderConfig](#class-coveragesubproviderconfig) +*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
diff --git a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/README.md b/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/README.md deleted file mode 100644 index fd6fab7d42..0000000000 --- a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/README.md +++ /dev/null @@ -1,75 +0,0 @@ -## @0x/sol-profiler - -Solidity line-by-line gas profiler. - -### Read the [Documentation](https://0xproject.com/docs/sol-profiler). - -## Installation - -```bash -yarn add @0x/sol-profiler -``` - -**Import** - -```javascript -import { ProfilerSubprovider } from '@0x/sol-profiler'; -``` - -or - -```javascript -var ProfilerSubprovider = require('@0x/sol-profiler').ProfilerSubprovider; -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/sol-profiler yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/sol-profiler yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/reference.mdx b/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/reference.mdx deleted file mode 100644 index 8cefb99a8f..0000000000 --- a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.10/reference.mdx +++ /dev/null @@ -1,175 +0,0 @@ -> # Class: ProfilerSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -ProfilerSubprovider is used to profile Solidity code while running tests. - -## Hierarchy - -* `TraceInfoSubprovider` - - * **ProfilerSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) -* [writeProfilerOutputAsync](#writeprofileroutputasync) - -## Constructors - -### constructor - -\+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)* - -*Overrides void* - -*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L30)* - -Instantiates a ProfilerSubprovider instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | - -**Returns:** *[ProfilerSubprovider](#class-profilersubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request | -`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ - -### stop - -▸ **stop**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 - -Stops trace collection - -**Returns:** *void* - -___ - -### writeProfilerOutputAsync - -▸ **writeProfilerOutputAsync**(): *`Promise`* - -*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L104)* - -Write the test profiler results to a file in Istanbul format. - -**Returns:** *`Promise`* - -
- -* [Globals](globals.md) -* [External Modules]() - * [cost_utils](modules/_cost_utils_.md) - * [index](modules/_index_.md) - * [profiler_subprovider](modules/_profiler_subprovider_.md) - * [profiler_subprovider.ProfilerSubprovider](#class-profilersubprovider) -* [Classes]() - * [profiler_subprovider.ProfilerSubprovider](#class-profilersubprovider) - -
- diff --git a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.11/reference.mdx b/packages/website/mdx/tools/@0x/sol-profiler/v3.1.11/reference.mdx index 8cefb99a8f..c846fb7ced 100644 --- a/packages/website/mdx/tools/@0x/sol-profiler/v3.1.11/reference.mdx +++ b/packages/website/mdx/tools/@0x/sol-profiler/v3.1.11/reference.mdx @@ -1,38 +1,24 @@ -> # Class: ProfilerSubprovider +# Class: ProfilerSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. ProfilerSubprovider is used to profile Solidity code while running tests. -## Hierarchy +### Hierarchy * `TraceInfoSubprovider` * **ProfilerSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) -* [writeProfilerOutputAsync](#writeprofileroutputasync) - -## Constructors - -### constructor +## constructer \+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)* *Overrides void* -*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L30)* +*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-profiler/src/profiler_subprovider.ts#L30)* Instantiates a ProfilerSubprovider instance @@ -46,15 +32,15 @@ Name | Type | Default | Description | **Returns:** *[ProfilerSubprovider](#class-profilersubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 + + Emits a JSON RPC payload that will then be handled by the ProviderEngine instance this subprovider is a part of. The payload will cascade down the subprovider middleware @@ -72,15 +58,15 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 + This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -98,15 +84,15 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 + Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call @@ -122,13 +108,13 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 + + Starts trace collection @@ -136,13 +122,13 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 + + Stops trace collection @@ -150,11 +136,11 @@ Stops trace collection ___ -### writeProfilerOutputAsync +## writeProfilerOutputAsync ▸ **writeProfilerOutputAsync**(): *`Promise`* -*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L104)* +*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-profiler/src/profiler_subprovider.ts#L104)* Write the test profiler results to a file in Istanbul format. @@ -162,14 +148,3 @@ Write the test profiler results to a file in Istanbul format.
-* [Globals](globals.md) -* [External Modules]() - * [cost_utils](modules/_cost_utils_.md) - * [index](modules/_index_.md) - * [profiler_subprovider](modules/_profiler_subprovider_.md) - * [profiler_subprovider.ProfilerSubprovider](#class-profilersubprovider) -* [Classes]() - * [profiler_subprovider.ProfilerSubprovider](#class-profilersubprovider) - -
- diff --git a/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/README.md b/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/README.md deleted file mode 100644 index d06b1b671c..0000000000 --- a/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/README.md +++ /dev/null @@ -1,75 +0,0 @@ -## @0x/sol-trace - -Prints a stack trace when a revert is encountered. - -### Read the [Documentation](https://0xproject.com/docs/sol-trace). - -## Installation - -```bash -yarn add @0x/sol-trace -``` - -**Import** - -```javascript -import { RevertTraceSubprovider } from '@0x/sol-trace'; -``` - -or - -```javascript -var RevertTraceSubprovider = require('@0x/sol-trace').RevertTraceSubprovider; -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/sol-trace yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/sol-trace yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/reference.mdx b/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/reference.mdx deleted file mode 100644 index 2ec16a4af8..0000000000 --- a/packages/website/mdx/tools/@0x/sol-trace/v2.0.16/reference.mdx +++ /dev/null @@ -1,161 +0,0 @@ -> # Class: RevertTraceSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It is used to report call stack traces whenever a revert occurs. - -## Hierarchy - -* `TraceCollectionSubprovider` - - * **RevertTraceSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) - -## Constructors - -### constructor - -\+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)* - -*Overrides void* - -*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* - -Instantiates a RevertTraceSubprovider instance - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | - -**Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | `NextCallback` | Callback to call if this subprovider decides not to handle the request | -`_end` | `ErrorCallback` | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from void* - -*Overrides void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ - -### stop - -▸ **stop**(): *void* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 - -Stops trace collection - -**Returns:** *void* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [revert_trace_subprovider](modules/_revert_trace_subprovider_.md) - * [revert_trace_subprovider.RevertTraceSubprovider](#class-reverttracesubprovider) -* [Classes]() - * [revert_trace_subprovider.RevertTraceSubprovider](#class-reverttracesubprovider) - -
- diff --git a/packages/website/mdx/tools/@0x/sol-trace/v2.0.17/reference.mdx b/packages/website/mdx/tools/@0x/sol-trace/v2.0.17/reference.mdx index 2ec16a4af8..3bcfcb06d8 100644 --- a/packages/website/mdx/tools/@0x/sol-trace/v2.0.17/reference.mdx +++ b/packages/website/mdx/tools/@0x/sol-trace/v2.0.17/reference.mdx @@ -1,37 +1,24 @@ -> # Class: RevertTraceSubprovider +# Class: RevertTraceSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It is used to report call stack traces whenever a revert occurs. -## Hierarchy +### Hierarchy * `TraceCollectionSubprovider` * **RevertTraceSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) - -## Constructors - -### constructor +## constructer \+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)* *Overrides void* -*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* +*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* Instantiates a RevertTraceSubprovider instance @@ -45,15 +32,15 @@ Name | Type | Default | Description | **Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/subproviders/lib/src/subproviders/subprovider.d.ts:25 + + Emits a JSON RPC payload that will then be handled by the ProviderEngine instance this subprovider is a part of. The payload will cascade down the subprovider middleware @@ -71,15 +58,15 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 + This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -97,15 +84,15 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 + Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call @@ -121,13 +108,13 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 + + Starts trace collection @@ -135,13 +122,13 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 + + Stops trace collection @@ -149,13 +136,3 @@ Stops trace collection
-* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [revert_trace_subprovider](modules/_revert_trace_subprovider_.md) - * [revert_trace_subprovider.RevertTraceSubprovider](#class-reverttracesubprovider) -* [Classes]() - * [revert_trace_subprovider.RevertTraceSubprovider](#class-reverttracesubprovider) - -
- diff --git a/packages/website/mdx/tools/@0x/subproviders/v5.0.0/README.md b/packages/website/mdx/tools/@0x/subproviders/v5.0.0/README.md deleted file mode 100644 index 4cf55838e2..0000000000 --- a/packages/website/mdx/tools/@0x/subproviders/v5.0.0/README.md +++ /dev/null @@ -1,100 +0,0 @@ -## @0x/subproviders - -A few useful web3 subproviders including a LedgerSubprovider useful for adding Ledger Nano S support. - -We have written up a [Wiki](https://0xproject.com/wiki#Web3-Provider-Examples) article detailing some use cases of this subprovider package. - -### Read the [Documentation](https://0xproject.com/docs/subproviders). - -## Installation - -``` -yarn add @0x/subproviders -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/subproviders yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/subproviders yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run tests - -#### Unit tests - -```bash -yarn run test:unit -``` - -#### Integration tests - -In order to run the integration tests, make sure you have a Ledger Nano S available. - -- Setup your Ledger with the development mnemonic seed: `concert load couple harbor equip island argue ramp clarify fence smart topic` -- Plug it into your computer -- Unlock the device -- Open the on-device Ethereum app -- Make sure "browser support" and "contract data" are disabled -- Start [TestRPC](https://github.com/trufflesuite/ganache-cli) locally at port `8545` - -Then run: - -``` -yarn test:integration -``` - -**Note:** We assume a derivation path of `m/44'/60'/0'/0` which is already configured in the tests. With this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. - -#### All tests - -```bash -yarn run test:all -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/subproviders/v5.0.0/reference.mdx b/packages/website/mdx/tools/@0x/subproviders/v5.0.0/reference.mdx deleted file mode 100644 index d3c40e92c6..0000000000 --- a/packages/website/mdx/tools/@0x/subproviders/v5.0.0/reference.mdx +++ /dev/null @@ -1,3232 +0,0 @@ -> # Class: BaseWalletSubprovider - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **BaseWalletSubprovider** - - * [LedgerSubprovider](#class-ledgersubprovider) - - * [PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider) - - * [MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider) - - * [TrezorSubprovider](#class-trezorsubprovider) - -## Index - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#abstract-getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#abstract-signpersonalmessageasync) -* [signTransactionAsync](#abstract-signtransactionasync) -* [signTypedDataAsync](#abstract-signtypeddataasync) - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### `Abstract` getAccountsAsync - -▸ **getAccountsAsync**(): *`Promise`* - -*Defined in [subproviders/base_wallet_subprovider.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L23)* - -**Returns:** *`Promise`* - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### `Abstract` signPersonalMessageAsync - -▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* - -*Defined in [subproviders/base_wallet_subprovider.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L25)* - -**Parameters:** - -Name | Type | ------- | ------ | -`data` | string | -`address` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` signTransactionAsync - -▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* - -*Defined in [subproviders/base_wallet_subprovider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L24)* - -**Parameters:** - -Name | Type | ------- | ------ | -`txParams` | [PartialTxParams](#interface-partialtxparams) | - -**Returns:** *`Promise`* - -___ - -### `Abstract` signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* - -*Defined in [subproviders/base_wallet_subprovider.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L26)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`typedData` | any | - -**Returns:** *`Promise`* - -
- -> # Class: EmptyWalletSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It intercepts the `eth_accounts` JSON RPC requests and never returns any addresses when queried. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **EmptyWalletSubprovider** - -## Index - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: FakeGasEstimateSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It intercepts the `eth_estimateGas` JSON RPC call and always returns a constant gas amount when queried. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **FakeGasEstimateSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new FakeGasEstimateSubprovider**(`constantGasAmount`: number): *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* - -*Defined in [subproviders/fake_gas_estimate_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* - -Instantiates an instance of the FakeGasEstimateSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`constantGasAmount` | number | The constant gas amount you want returned | - -**Returns:** *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: GanacheSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It intercepts all JSON RPC requests and relays them to an in-process ganache instance. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **GanacheSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new GanacheSubprovider**(`opts`: `GanacheOpts`): *[GanacheSubprovider](#class-ganachesubprovider)* - -*Defined in [subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ganache.ts#L13)* - -Instantiates a GanacheSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts` | `GanacheOpts` | The desired opts with which to instantiate the Ganache provider | - -**Returns:** *[GanacheSubprovider](#class-ganachesubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ganache.ts#L31)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`_next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: LedgerSubprovider - -Subprovider for interfacing with a user's [Ledger Nano S](https://www.ledgerwallet.com/products/ledger-nano-s). -This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and -re-routes them to a Ledger device plugged into the users computer. - -## Hierarchy - - * [BaseWalletSubprovider](#class-basewalletsubprovider) - - * **LedgerSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new LedgerSubprovider**(`config`: [LedgerSubproviderConfigs](#class-ledgersubprovider)* - -*Defined in [subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L41)* - -Instantiates a LedgerSubprovider. Defaults to derivationPath set to `44'/60'/0'`. -TestRPC/Ganache defaults to `m/44'/60'/0'/0`, so set this in the configs if desired. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`config` | [LedgerSubproviderConfigs](#interface-ledgersubproviderconfigs) | Several available configurations | - -**Returns:** *[LedgerSubprovider](#class-ledgersubprovider)* - -LedgerSubprovider instance - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### getAccountsAsync - -▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* - -*Defined in [subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L87)* - -Retrieve a users Ledger accounts. The accounts are derived from the derivationPath, -master public key and chain code. Because of this, you can request as many accounts -as you wish and it only requires a single request to the Ledger device. This method -is automatically called when issuing a `eth_accounts` JSON RPC request via your providerEngine -instance. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`numberOfAccounts` | number | DEFAULT_NUM_ADDRESSES_TO_FETCH | Number of accounts to retrieve (default: 10) | - -**Returns:** *`Promise`* - -An array of accounts - -___ - -### getPath - -▸ **getPath**(): *string* - -*Defined in [subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L68)* - -Retrieve the set derivation path - -**Returns:** *string* - -derivation path - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Inherited from [BaseWalletSubprovider](#handlerequest)* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### setPath - -▸ **setPath**(`basDerivationPath`: string): *void* - -*Defined in [subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L75)* - -Set a desired derivation path when computing the available user addresses - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`basDerivationPath` | string | The desired derivation path (e.g `44'/60'/0'`) | - -**Returns:** *void* - -___ - -### signPersonalMessageAsync - -▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* - -*Defined in [subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L158)* - -Sign a personal Ethereum signed message. The signing account will be the account -associated with the provided address. -The Ledger adds the Ethereum signed message prefix on-device. If you've added -the LedgerSubprovider to your app's provider, you can simply send an `eth_sign` -or `personal_sign` JSON RPC request, and this method will be called auto-magically. -If you are not using this via a ProviderEngine instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Hex string message to sign | -`address` | string | Address of the account to sign with | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -___ - -### signTransactionAsync - -▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* - -*Defined in [subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L101)* - -Signs a transaction on the Ledger with the account specificed by the `from` field in txParams. -If you've added the LedgerSubprovider to your app's provider, you can simply send an `eth_sendTransaction` -JSON RPC request, and this method will be called auto-magically. If you are not using this via a ProviderEngine -instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txParams` | [PartialTxParams](#interface-partialtxparams) | Parameters of the transaction to sign | - -**Returns:** *`Promise`* - -Signed transaction hex string - -___ - -### signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* - -*Defined in [subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L196)* - -eth_signTypedData is currently not supported on Ledger devices. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of the account to sign with | -`typedData` | any | - | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -
- -> # Class: MetamaskSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) -subprovider interface and the provider sendAsync interface. -It handles inconsistencies with Metamask implementations of various JSON RPC methods. -It forwards JSON RPC requests involving the domain of a signer (getAccounts, -sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests -are passed onwards for subsequent subproviders to handle. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **MetamaskSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [sendAsync](#sendasync) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new MetamaskSubprovider**(`supportedProvider`: `SupportedProvider`): *[MetamaskSubprovider](#class-metamasksubprovider)* - -*Defined in [subproviders/metamask_subprovider.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L20)* - -Instantiates a new MetamaskSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | `SupportedProvider` | Web3 provider that should handle all user account related requests | - -**Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/metamask_subprovider.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L40)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### sendAsync - -▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* - -*Defined in [subproviders/metamask_subprovider.ts:114](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L114)* - -This method conforms to the provider sendAsync interface. -Allowing the MetamaskSubprovider to be used as a generic provider (outside of Web3ProviderEngine) with the -addition of wrapping the inconsistent Metamask behaviour - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`callback` | [ErrorCallback](#errorcallback) | - | - -**Returns:** *void* - -The contents nested under the result key of the response body - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: MnemonicWalletSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and handles -all requests with accounts derived from the supplied mnemonic. - -## Hierarchy - - * [BaseWalletSubprovider](#class-basewalletsubprovider) - - * **MnemonicWalletSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new MnemonicWalletSubprovider**(`config`: [MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubprovider)* - -*Defined in [subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* - -Instantiates a MnemonicWalletSubprovider. Defaults to baseDerivationPath set to `44'/60'/0'/0`. -This is the default in TestRPC/Ganache, it can be overridden if desired. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`config` | [MnemonicWalletSubproviderConfigs](#interface-mnemonicwalletsubproviderconfigs) | Configuration for the mnemonic wallet, must contain the mnemonic | - -**Returns:** *[MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider)* - -MnemonicWalletSubprovider instance - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### getAccountsAsync - -▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* - -*Defined in [subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* - -Retrieve the accounts associated with the mnemonic. -This method is implicitly called when issuing a `eth_accounts` JSON RPC request -via your providerEngine instance. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`numberOfAccounts` | number | DEFAULT_NUM_ADDRESSES_TO_FETCH | Number of accounts to retrieve (default: 10) | - -**Returns:** *`Promise`* - -An array of accounts - -___ - -### getPath - -▸ **getPath**(): *string* - -*Defined in [subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* - -Retrieve the set derivation path - -**Returns:** *string* - -derivation path - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Inherited from [BaseWalletSubprovider](#handlerequest)* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### setPath - -▸ **setPath**(`baseDerivationPath`: string): *void* - -*Defined in [subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* - -Set a desired derivation path when computing the available user addresses - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`baseDerivationPath` | string | The desired derivation path (e.g `44'/60'/0'`) | - -**Returns:** *void* - -___ - -### signPersonalMessageAsync - -▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* - -*Defined in [subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* - -Sign a personal Ethereum signed message. The signing account will be the account -associated with the provided address. If you've added the MnemonicWalletSubprovider to -your app's provider, you can simply send an `eth_sign` or `personal_sign` JSON RPC request, -and this method will be called auto-magically. If you are not using this via a ProviderEngine -instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Hex string message to sign | -`address` | string | Address of the account to sign with | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -___ - -### signTransactionAsync - -▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* - -*Defined in [subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* - -Signs a transaction with the account specificed by the `from` field in txParams. -If you've added this Subprovider to your app's provider, you can simply send -an `eth_sendTransaction` JSON RPC request, and this method will be called auto-magically. -If you are not using this via a ProviderEngine instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txParams` | [PartialTxParams](#interface-partialtxparams) | Parameters of the transaction to sign | - -**Returns:** *`Promise`* - -Signed transaction hex string - -___ - -### signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: `EIP712TypedData`): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* - -*Defined in [subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* - -Sign an EIP712 Typed Data message. The signing account will be the account -associated with the provided address. If you've added this MnemonicWalletSubprovider to -your app's provider, you can simply send an `eth_signTypedData` JSON RPC request, and -this method will be called auto-magically. If you are not using this via a ProviderEngine - instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of the account to sign with | -`typedData` | `EIP712TypedData` | - | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -
- -> # Class: NonceTrackerSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It is heavily inspired by the [NonceSubprovider](https://github.com/MetaMask/provider-engine/blob/master/subproviders/nonce-tracker.js). -We added the additional feature of clearing the cached nonce value when a `nonce value too low` error occurs. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **NonceTrackerSubprovider** - -## Index - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [NextCallback](#nextcallback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: PrivateKeyWalletSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and handles -all requests with the supplied Ethereum private key. - -## Hierarchy - - * [BaseWalletSubprovider](#class-basewalletsubprovider) - - * **PrivateKeyWalletSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new PrivateKeyWalletSubprovider**(`privateKey`: string): *[PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider)* - -*Defined in [subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* - -Instantiates a PrivateKeyWalletSubprovider. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`privateKey` | string | The corresponding private key to an Ethereum address | - -**Returns:** *[PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider)* - -PrivateKeyWalletSubprovider instance - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### getAccountsAsync - -▸ **getAccountsAsync**(): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* - -*Defined in [subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* - -Retrieve the account associated with the supplied private key. -This method is implicitly called when issuing a `eth_accounts` JSON RPC request -via your providerEngine instance. - -**Returns:** *`Promise`* - -An array of accounts - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Inherited from [BaseWalletSubprovider](#handlerequest)* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### signPersonalMessageAsync - -▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* - -*Defined in [subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* - -Sign a personal Ethereum signed message. The signing address will be calculated from the private key. -The address must be provided it must match the address calculated from the private key. -If you've added this Subprovider to your app's provider, you can simply send an `eth_sign` -or `personal_sign` JSON RPC request, and this method will be called auto-magically. -If you are not using this via a ProviderEngine instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Hex string message to sign | -`address` | string | Address of the account to sign with | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -___ - -### signTransactionAsync - -▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* - -*Defined in [subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* - -Sign a transaction with the private key. If you've added this Subprovider to your -app's provider, you can simply send an `eth_sendTransaction` JSON RPC request, and -this method will be called auto-magically. If you are not using this via a ProviderEngine -instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txParams` | [PartialTxParams](#interface-partialtxparams) | Parameters of the transaction to sign | - -**Returns:** *`Promise`* - -Signed transaction hex string - -___ - -### signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: `EIP712TypedData`): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* - -*Defined in [subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* - -Sign an EIP712 Typed Data message. The signing address will be calculated from the private key. -The address must be provided it must match the address calculated from the private key. -If you've added this Subprovider to your app's provider, you can simply send an `eth_signTypedData` -JSON RPC request, and this method will be called auto-magically. -If you are not using this via a ProviderEngine instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of the account to sign with | -`typedData` | `EIP712TypedData` | - | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -
- -> # Class: RedundantSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It attempts to handle each JSON RPC request by sequentially attempting to receive a valid response from one of a -set of JSON RPC endpoints. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **RedundantSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new RedundantSubprovider**(`subproviders`: [Subprovider](#class-redundantsubprovider)* - -*Defined in [subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* - -Instantiates a new RedundantSubprovider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subproviders` | [Subprovider](#class-subprovider)[] | Subproviders to attempt the request with | - -**Returns:** *[RedundantSubprovider](#class-redundantsubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: function): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -▪ **payload**: *`JSONRPCRequestPayload`* - -JSON RPC payload - -▪ **next**: *[Callback](#callback)* - -Callback to call if this subprovider decides not to handle the request - -▪ **end**: *function* - -Callback to call if subprovider handled the request and wants to pass back the request. - -▸ (`err`: `Error` | null, `data?`: any): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`data?` | any | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: RPCSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **RPCSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* - -*Defined in [subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`rpcUrl` | string | - | URL to the backing Ethereum node to which JSON RPC requests should be sent | -`requestTimeoutMs` | number | 20000 | Amount of miliseconds to wait before timing out the JSON RPC request | - -**Returns:** *[RPCSubprovider](#class-rpcsubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`_next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: SignerSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) -subprovider interface. It forwards JSON RPC requests involving the domain of a signer (getAccounts, -sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests -are passed onwards for subsequent subproviders to handle. - -## Hierarchy - -* [Subprovider](#class-subprovider) - - * **SignerSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new SignerSubprovider**(`supportedProvider`: `SupportedProvider`): *[SignerSubprovider](#class-signersubprovider)* - -*Defined in [subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/signer.ts#L15)* - -Instantiates a new SignerSubprovider. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | `SupportedProvider` | Web3 provider that should handle all user account related requests | - -**Returns:** *[SignerSubprovider](#class-signersubprovider)* - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/signer.ts#L33)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: Subprovider - -A altered version of the base class Subprovider found in [web3-provider-engine](https://github.com/MetaMask/provider-engine). -This one has an async/await `emitPayloadAsync` and also defined types. - -## Hierarchy - -* **Subprovider** - - * [EmptyWalletSubprovider](#class-emptywalletsubprovider) - - * [FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider) - - * [SignerSubprovider](#class-signersubprovider) - - * [RedundantSubprovider](#class-redundantsubprovider) - - * [BaseWalletSubprovider](#class-basewalletsubprovider) - - * [RPCSubprovider](#class-rpcsubprovider) - - * [GanacheSubprovider](#class-ganachesubprovider) - - * [NonceTrackerSubprovider](#class-noncetrackersubprovider) - - * [MetamaskSubprovider](#class-metamasksubprovider) - -## Index - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#abstract-handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### `Abstract` handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Defined in [subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L42)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC request payload | -`next` | [Callback](#callback) | A callback to pass the request to the next subprovider in the stack | -`end` | [ErrorCallback](#errorcallback) | A callback called once the subprovider is done handling the request | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -
- -> # Class: TrezorSubprovider - -## Hierarchy - - * [BaseWalletSubprovider](#class-basewalletsubprovider) - - * **TrezorSubprovider** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new TrezorSubprovider**(`config`: [TrezorSubproviderConfig](#class-trezorsubprovider)* - -*Defined in [subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L32)* - -Instantiates a TrezorSubprovider. Defaults to private key path set to `44'/60'/0'/0/`. -Must be initialized with trezor-connect API module https://github.com/trezor/connect. - -**Parameters:** - -Name | Type | ------- | ------ | -`config` | [TrezorSubproviderConfig](#interface-trezorsubproviderconfig) | - -**Returns:** *[TrezorSubprovider](#class-trezorsubprovider)* - -TrezorSubprovider instance - -## Methods - -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* - -*Inherited from [Subprovider](#emitpayloadasync)* - -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* - -Emits a JSON RPC payload that will then be handled by the ProviderEngine instance -this subprovider is a part of. The payload will cascade down the subprovider middleware -stack until finding the responsible entity for handling the request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### getAccountsAsync - -▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* - -*Defined in [subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L56)* - -Retrieve a users Trezor account. This method is automatically called -when issuing a `eth_accounts` JSON RPC request via your providerEngine -instance. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`numberOfAccounts` | number | DEFAULT_NUM_ADDRESSES_TO_FETCH | - -**Returns:** *`Promise`* - -An array of accounts - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* - -*Inherited from [BaseWalletSubprovider](#handlerequest)* - -*Overrides [Subprovider](#abstract-handlerequest)* - -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* - -This method conforms to the web3-provider-engine interface. -It is called internally by the ProviderEngine when it is this subproviders -turn to handle a JSON RPC request. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | -`end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | - -**Returns:** *`Promise`* - -___ - -### setEngine - -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* - -*Inherited from [Subprovider](#setengine)* - -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* - -Set's the subprovider's engine to the ProviderEngine it is added to. -This is only called within the ProviderEngine source code, do not call -directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### signPersonalMessageAsync - -▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* - -*Defined in [subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L129)* - -Sign a personal Ethereum signed message. The signing account will be the account -associated with the provided address. If you've added the TrezorSubprovider to -your app's provider, you can simply send an `eth_sign` or `personal_sign` JSON RPC -request, and this method will be called auto-magically. -If you are not using this via a ProviderEngine instance, you can call it directly. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Hex string message to sign | -`address` | string | Address of the account to sign with | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -___ - -### signTransactionAsync - -▸ **signTransactionAsync**(`txData`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* - -*Defined in [subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L70)* - -Signs a transaction on the Trezor with the account specificed by the `from` field in txParams. -If you've added the TrezorSubprovider to your app's provider, you can simply send an `eth_sendTransaction` -JSON RPC request, and this method will be called auto-magically. If you are not using this via a ProviderEngine -instance, you can call it directly. - -**Parameters:** - -Name | Type | ------- | ------ | -`txData` | [PartialTxParams](#interface-partialtxparams) | - -**Returns:** *`Promise`* - -Signed transaction hex string - -___ - -### signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* - -*Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* - -*Defined in [subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L161)* - -TODO:: eth_signTypedData is currently not supported on Trezor devices. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of the account to sign with | -`typedData` | any | - | - -**Returns:** *`Promise`* - -Signature hex string (order: rsv) - -
- -> # Enumeration: LedgerSubproviderErrors - -## Index - -### Enumeration members - -* [MultipleOpenConnectionsDisallowed](#multipleopenconnectionsdisallowed) -* [TooOldLedgerFirmware](#toooldledgerfirmware) - -## Enumeration members - -### MultipleOpenConnectionsDisallowed - -• **MultipleOpenConnectionsDisallowed**: = "MULTIPLE_OPEN_CONNECTIONS_DISALLOWED" - -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L116)* - -___ - -### TooOldLedgerFirmware - -• **TooOldLedgerFirmware**: = "TOO_OLD_LEDGER_FIRMWARE" - -*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L115)* - -
- -> # Enumeration: NonceSubproviderErrors - -## Index - -### Enumeration members - -* [CannotDetermineAddressFromPayload](#cannotdetermineaddressfrompayload) -* [EmptyParametersFound](#emptyparametersfound) - -## Enumeration members - -### CannotDetermineAddressFromPayload - -• **CannotDetermineAddressFromPayload**: = "CANNOT_DETERMINE_ADDRESS_FROM_PAYLOAD" - -*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L121)* - -___ - -### EmptyParametersFound - -• **EmptyParametersFound**: = "EMPTY_PARAMETERS_FOUND" - -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L120)* - -
- -> # Enumeration: WalletSubproviderErrors - -## Index - -### Enumeration members - -* [AddressNotFound](#addressnotfound) -* [DataMissingForSignPersonalMessage](#datamissingforsignpersonalmessage) -* [DataMissingForSignTypedData](#datamissingforsigntypeddata) -* [FromAddressMissingOrInvalid](#fromaddressmissingorinvalid) -* [MethodNotSupported](#methodnotsupported) -* [SenderInvalidOrNotSupplied](#senderinvalidornotsupplied) - -## Enumeration members - -### AddressNotFound - -• **AddressNotFound**: = "ADDRESS_NOT_FOUND" - -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L107)* - -___ - -### DataMissingForSignPersonalMessage - -• **DataMissingForSignPersonalMessage**: = "DATA_MISSING_FOR_SIGN_PERSONAL_MESSAGE" - -*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L108)* - -___ - -### DataMissingForSignTypedData - -• **DataMissingForSignTypedData**: = "DATA_MISSING_FOR_SIGN_TYPED_DATA" - -*Defined in [types.ts:109](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L109)* - -___ - -### FromAddressMissingOrInvalid - -• **FromAddressMissingOrInvalid**: = "FROM_ADDRESS_MISSING_OR_INVALID" - -*Defined in [types.ts:111](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L111)* - -___ - -### MethodNotSupported - -• **MethodNotSupported**: = "METHOD_NOT_SUPPORTED" - -*Defined in [types.ts:112](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L112)* - -___ - -### SenderInvalidOrNotSupplied - -• **SenderInvalidOrNotSupplied**: = "SENDER_INVALID_OR_NOT_SUPPLIED" - -*Defined in [types.ts:110](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L110)* - -
- -> # Interface: AccountFetchingConfigs - -addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 -numAddressesToReturn: Number of addresses to return from 'eth_accounts' call -shouldAskForOnDeviceConfirmation: Whether you wish to prompt the user on their Ledger - before fetching their addresses - -## Hierarchy - -* **AccountFetchingConfigs** - -## Index - -### Properties - -* [addressSearchLimit](#optional-addresssearchlimit) -* [numAddressesToReturn](#optional-numaddressestoreturn) -* [shouldAskForOnDeviceConfirmation](#optional-shouldaskforondeviceconfirmation) - -## Properties - -### `Optional` addressSearchLimit - -• **addressSearchLimit**? : *undefined | number* - -*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L55)* - -___ - -### `Optional` numAddressesToReturn - -• **numAddressesToReturn**? : *undefined | number* - -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L56)* - -___ - -### `Optional` shouldAskForOnDeviceConfirmation - -• **shouldAskForOnDeviceConfirmation**? : *undefined | false | true* - -*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L57)* - -
- -> # Interface: DerivedHDKeyInfo - -## Hierarchy - -* **DerivedHDKeyInfo** - -## Index - -### Properties - -* [address](#address) -* [baseDerivationPath](#basederivationpath) -* [derivationPath](#derivationpath) -* [hdKey](#hdkey) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L124)* - -___ - -### baseDerivationPath - -• **baseDerivationPath**: *string* - -*Defined in [types.ts:125](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L125)* - -___ - -### derivationPath - -• **derivationPath**: *string* - -*Defined in [types.ts:126](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L126)* - -___ - -### hdKey - -• **hdKey**: *`HDNode`* - -*Defined in [types.ts:127](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L127)* - -
- -> # Interface: ECSignatureString - -## Hierarchy - -* **ECSignatureString** - -## Index - -### Properties - -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### r - -• **r**: *string* - -*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L29)* - -___ - -### s - -• **s**: *string* - -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L30)* - -___ - -### v - -• **v**: *string* - -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L28)* - -
- -> # Interface: JSONRPCRequestPayloadWithMethod - -## Hierarchy - -* `JSONRPCRequestPayload` - - * **JSONRPCRequestPayloadWithMethod** - -## Index - -### Properties - -* [id](#id) -* [jsonrpc](#jsonrpc) -* [method](#method) -* [params](#params) - -## Properties - -### id - -• **id**: *number* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:262 - -___ - -### jsonrpc - -• **jsonrpc**: *string* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:263 - -___ - -### method - -• **method**: *string* - -*Overrides void* - -*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L136)* - -___ - -### params - -• **params**: *any[]* - -*Inherited from void* - -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:260 - -
- -> # Interface: LedgerCommunication - -## Hierarchy - -* **LedgerCommunication** - -## Index - -### Properties - -* [close_async](#close_async) - -## Properties - -### close_async - -• **close_async**: *function* - -*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L98)* - -#### Type declaration: - -▸ (): *`Promise`* - -
- -> # Interface: LedgerCommunicationClient - -## Hierarchy - -* **LedgerCommunicationClient** - -## Index - -### Properties - -* [close](#close) - -## Properties - -### close - -• **close**: *function* - -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L5)* - -#### Type declaration: - -▸ (): *`Promise`* - -
- -> # Interface: LedgerEthereumClient - -Elliptic Curve signature -The LedgerEthereumClient sends Ethereum-specific requests to the Ledger Nano S -It uses an internal LedgerCommunicationClient to relay these requests. Currently -NodeJs and Browser communication are supported. - -## Hierarchy - -* **LedgerEthereumClient** - -## Index - -### Properties - -* [getAddress](#getaddress) -* [signPersonalMessage](#signpersonalmessage) -* [signTransaction](#signtransaction) -* [transport](#transport) - -## Properties - -### getAddress - -• **getAddress**: *function* - -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L17)* - -#### Type declaration: - -▸ (`derivationPath`: string, `askForDeviceConfirmation`: boolean, `shouldGetChainCode`: true): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`derivationPath` | string | -`askForDeviceConfirmation` | boolean | -`shouldGetChainCode` | true | - -___ - -### signPersonalMessage - -• **signPersonalMessage**: *function* - -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L23)* - -#### Type declaration: - -▸ (`derivationPath`: string, `messageHex`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`derivationPath` | string | -`messageHex` | string | - -___ - -### signTransaction - -• **signTransaction**: *function* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L22)* - -#### Type declaration: - -▸ (`derivationPath`: string, `rawTxHex`: string): *`Promise`* - -**Parameters:** - -Name | Type | ------- | ------ | -`derivationPath` | string | -`rawTxHex` | string | - -___ - -### transport - -• **transport**: *[LedgerCommunicationClient](#interface-ledgercommunicationclient)* - -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L24)* - -
- -> # Interface: LedgerGetAddressResult - -## Hierarchy - -* **LedgerGetAddressResult** - -## Index - -### Properties - -* [address](#address) -* [chainCode](#chaincode) -* [publicKey](#publickey) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L79)* - -___ - -### chainCode - -• **chainCode**: *string* - -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L81)* - -___ - -### publicKey - -• **publicKey**: *string* - -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L80)* - -
- -> # Interface: LedgerSubproviderConfigs - -networkId: The ethereum networkId to set as the chainId from EIP155 -ledgerConnectionType: Environment in which you wish to connect to Ledger (nodejs or browser) -derivationPath: Initial derivation path to use e.g 44'/60'/0' -accountFetchingConfigs: configs related to fetching accounts from a Ledger - -## Hierarchy - -* **LedgerSubproviderConfigs** - -## Index - -### Properties - -* [accountFetchingConfigs](#optional-accountfetchingconfigs) -* [baseDerivationPath](#optional-basederivationpath) -* [ledgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync) -* [networkId](#networkid) - -## Properties - -### `Optional` accountFetchingConfigs - -• **accountFetchingConfigs**? : *[AccountFetchingConfigs](#interface-accountfetchingconfigs)* - -*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L45)* - -___ - -### `Optional` baseDerivationPath - -• **baseDerivationPath**? : *undefined | string* - -*Defined in [types.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L44)* - -___ - -### ledgerEthereumClientFactoryAsync - -• **ledgerEthereumClientFactoryAsync**: *[LedgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync)* - -*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L43)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L42)* - -
- -> # Interface: MnemonicWalletSubproviderConfigs - -mnemonic: The string mnemonic seed -addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 -baseDerivationPath: The base derivation path (e.g 44'/60'/0'/0) - -## Hierarchy - -* **MnemonicWalletSubproviderConfigs** - -## Index - -### Properties - -* [addressSearchLimit](#optional-addresssearchlimit) -* [baseDerivationPath](#optional-basederivationpath) -* [mnemonic](#mnemonic) - -## Properties - -### `Optional` addressSearchLimit - -• **addressSearchLimit**? : *undefined | number* - -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L67)* - -___ - -### `Optional` baseDerivationPath - -• **baseDerivationPath**? : *undefined | string* - -*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L68)* - -___ - -### mnemonic - -• **mnemonic**: *string* - -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L66)* - -
- -> # Interface: PartialTxParams - -## Hierarchy - -* **PartialTxParams** - -## Index - -### Properties - -* [chainId](#chainid) -* [data](#optional-data) -* [from](#from) -* [gas](#gas) -* [gasPrice](#optional-gasprice) -* [nonce](#nonce) -* [to](#to) -* [value](#optional-value) - -## Properties - -### chainId - -• **chainId**: *number* - -*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L92)* - -___ - -### `Optional` data - -• **data**? : *undefined | string* - -*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L91)* - -___ - -### from - -• **from**: *string* - -*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L89)* - -___ - -### gas - -• **gas**: *string* - -*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L87)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *undefined | string* - -*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L86)* - -___ - -### nonce - -• **nonce**: *string* - -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L85)* - -___ - -### to - -• **to**: *string* - -*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L88)* - -___ - -### `Optional` value - -• **value**? : *undefined | string* - -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L90)* - -
- -> # Interface: ResponseWithTxParams - -## Hierarchy - -* **ResponseWithTxParams** - -## Index - -### Properties - -* [raw](#raw) -* [tx](#tx) - -## Properties - -### raw - -• **raw**: *string* - -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L102)* - -___ - -### tx - -• **tx**: *[PartialTxParams](#interface-partialtxparams)* - -*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L103)* - -
- -> # Interface: SignatureData - -## Hierarchy - -* **SignatureData** - -## Index - -### Properties - -* [hash](#hash) -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### hash - -• **hash**: *string* - -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L72)* - -___ - -### r - -• **r**: *string* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L73)* - -___ - -### s - -• **s**: *string* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L74)* - -___ - -### v - -• **v**: *number* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L75)* - -
- -> # Interface: TrezorConnectResponse - -## Hierarchy - -* **TrezorConnectResponse** - -## Index - -### Properties - -* [id](#id) -* [payload](#payload) -* [success](#success) - -## Properties - -### id - -• **id**: *number* - -*Defined in [types.ts:175](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L175)* - -___ - -### payload - -• **payload**: *any* - -*Defined in [types.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L174)* - -___ - -### success - -• **success**: *boolean* - -*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L176)* - -
- -> # Interface: TrezorGetPublicKeyResponsePayload - -## Hierarchy - -* **TrezorGetPublicKeyResponsePayload** - -## Index - -### Properties - -* [chainCode](#chaincode) -* [childNumb](#childnumb) -* [depth](#depth) -* [fingerprint](#fingerprint) -* [path](#path) -* [publicKey](#publickey) -* [serializedPath](#serializedpath) -* [xpub](#xpub) - -## Properties - -### chainCode - -• **chainCode**: *string* - -*Defined in [types.ts:152](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L152)* - -___ - -### childNumb - -• **childNumb**: *number* - -*Defined in [types.ts:150](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L150)* - -___ - -### depth - -• **depth**: *number* - -*Defined in [types.ts:155](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L155)* - -___ - -### fingerprint - -• **fingerprint**: *number* - -*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L154)* - -___ - -### path - -• **path**: *object* - -*Defined in [types.ts:146](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L146)* - -#### Type declaration: - -● \[▪ **index**: *number*\]: number - -___ - -### publicKey - -• **publicKey**: *string* - -*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L153)* - -___ - -### serializedPath - -• **serializedPath**: *string* - -*Defined in [types.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L149)* - -___ - -### xpub - -• **xpub**: *string* - -*Defined in [types.ts:151](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L151)* - -
- -> # Interface: TrezorResponseErrorPayload - -## Hierarchy - -* **TrezorResponseErrorPayload** - -## Index - -### Properties - -* [error](#error) - -## Properties - -### error - -• **error**: *string* - -*Defined in [types.ts:170](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L170)* - -
- -> # Interface: TrezorSignMsgResponsePayload - -## Hierarchy - -* **TrezorSignMsgResponsePayload** - -## Index - -### Properties - -* [address](#address) -* [signature](#signature) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L165)* - -___ - -### signature - -• **signature**: *string* - -*Defined in [types.ts:166](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L166)* - -
- -> # Interface: TrezorSignTxResponsePayload - -## Hierarchy - -* **TrezorSignTxResponsePayload** - -## Index - -### Properties - -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### r - -• **r**: *string* - -*Defined in [types.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L160)* - -___ - -### s - -• **s**: *string* - -*Defined in [types.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L161)* - -___ - -### v - -• **v**: *string* - -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L159)* - -
- -> # Interface: TrezorSubproviderConfig - -## Hierarchy - -* **TrezorSubproviderConfig** - -## Index - -### Properties - -* [accountFetchingConfigs](#accountfetchingconfigs) -* [networkId](#networkid) -* [trezorConnectClientApi](#trezorconnectclientapi) - -## Properties - -### accountFetchingConfigs - -• **accountFetchingConfigs**: *[AccountFetchingConfigs](#interface-accountfetchingconfigs)* - -*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L140)* - -___ - -### networkId - -• **networkId**: *number* - -*Defined in [types.ts:142](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L142)* - -___ - -### trezorConnectClientApi - -• **trezorConnectClientApi**: *any* - -*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L141)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [subproviders/base_wallet_subprovider](modules/_subproviders_base_wallet_subprovider_.md) - * [subproviders/base_wallet_subprovider.BaseWalletSubprovider](#class-basewalletsubprovider) - * [subproviders/empty_wallet_subprovider](modules/_subproviders_empty_wallet_subprovider_.md) - * [subproviders/empty_wallet_subprovider.EmptyWalletSubprovider](#class-emptywalletsubprovider) - * [subproviders/fake_gas_estimate_subprovider](modules/_subproviders_fake_gas_estimate_subprovider_.md) - * [subproviders/fake_gas_estimate_subprovider.FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider) - * [subproviders/ganache](modules/_subproviders_ganache_.md) - * [subproviders/ganache.GanacheSubprovider](#class-ganachesubprovider) - * [subproviders/ledger](modules/_subproviders_ledger_.md) - * [subproviders/ledger.LedgerSubprovider](#class-ledgersubprovider) - * [subproviders/metamask_subprovider](modules/_subproviders_metamask_subprovider_.md) - * [subproviders/metamask_subprovider.MetamaskSubprovider](#class-metamasksubprovider) - * [subproviders/mnemonic_wallet](modules/_subproviders_mnemonic_wallet_.md) - * [subproviders/mnemonic_wallet.MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider) - * [subproviders/nonce_tracker](modules/_subproviders_nonce_tracker_.md) - * [subproviders/nonce_tracker.NonceTrackerSubprovider](#class-noncetrackersubprovider) - * [subproviders/private_key_wallet](modules/_subproviders_private_key_wallet_.md) - * [subproviders/private_key_wallet.PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider) - * [subproviders/redundant_subprovider](modules/_subproviders_redundant_subprovider_.md) - * [subproviders/redundant_subprovider.RedundantSubprovider](#class-redundantsubprovider) - * [subproviders/rpc_subprovider](modules/_subproviders_rpc_subprovider_.md) - * [subproviders/rpc_subprovider.RPCSubprovider](#class-rpcsubprovider) - * [subproviders/signer](modules/_subproviders_signer_.md) - * [subproviders/signer.SignerSubprovider](#class-signersubprovider) - * [subproviders/subprovider](modules/_subproviders_subprovider_.md) - * [subproviders/subprovider.Subprovider](#class-subprovider) - * [subproviders/trezor](modules/_subproviders_trezor_.md) - * [subproviders/trezor.TrezorSubprovider](#class-trezorsubprovider) - * [types](modules/_types_.md) - * [types.LedgerSubproviderErrors](#class-ledgersubprovidererrors) - * [types.NonceSubproviderErrors](#class-noncesubprovidererrors) - * [types.WalletSubproviderErrors](#class-walletsubprovidererrors) - * [types.AccountFetchingConfigs](#class-accountfetchingconfigs) - * [types.DerivedHDKeyInfo](#class-derivedhdkeyinfo) - * [types.ECSignatureString](#class-ecsignaturestring) - * [types.JSONRPCRequestPayloadWithMethod](#class-jsonrpcrequestpayloadwithmethod) - * [types.LedgerCommunication](#class-ledgercommunication) - * [types.LedgerCommunicationClient](#class-ledgercommunicationclient) - * [types.LedgerEthereumClient](#class-ledgerethereumclient) - * [types.LedgerGetAddressResult](#class-ledgergetaddressresult) - * [types.LedgerSubproviderConfigs](#class-ledgersubproviderconfigs) - * [types.MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubproviderconfigs) - * [types.PartialTxParams](#class-partialtxparams) - * [types.ResponseWithTxParams](#class-responsewithtxparams) - * [types.SignatureData](#class-signaturedata) - * [types.TrezorConnectResponse](#class-trezorconnectresponse) - * [types.TrezorGetPublicKeyResponsePayload](#class-trezorgetpublickeyresponsepayload) - * [types.TrezorResponseErrorPayload](#class-trezorresponseerrorpayload) - * [types.TrezorSignMsgResponsePayload](#class-trezorsignmsgresponsepayload) - * [types.TrezorSignTxResponsePayload](#class-trezorsigntxresponsepayload) - * [types.TrezorSubproviderConfig](#class-trezorsubproviderconfig) - * [utils/subprovider_utils](modules/_utils_subprovider_utils_.md) - * [utils/wallet_utils](modules/_utils_wallet_utils_.md) -* [Classes]() - * [subproviders/base_wallet_subprovider.BaseWalletSubprovider](#class-basewalletsubprovider) - * [subproviders/empty_wallet_subprovider.EmptyWalletSubprovider](#class-emptywalletsubprovider) - * [subproviders/fake_gas_estimate_subprovider.FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider) - * [subproviders/ganache.GanacheSubprovider](#class-ganachesubprovider) - * [subproviders/ledger.LedgerSubprovider](#class-ledgersubprovider) - * [subproviders/metamask_subprovider.MetamaskSubprovider](#class-metamasksubprovider) - * [subproviders/mnemonic_wallet.MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider) - * [subproviders/nonce_tracker.NonceTrackerSubprovider](#class-noncetrackersubprovider) - * [subproviders/private_key_wallet.PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider) - * [subproviders/redundant_subprovider.RedundantSubprovider](#class-redundantsubprovider) - * [subproviders/rpc_subprovider.RPCSubprovider](#class-rpcsubprovider) - * [subproviders/signer.SignerSubprovider](#class-signersubprovider) - * [subproviders/subprovider.Subprovider](#class-subprovider) - * [subproviders/trezor.TrezorSubprovider](#class-trezorsubprovider) -* [Enums]() - * [types.LedgerSubproviderErrors](#class-ledgersubprovidererrors) - * [types.NonceSubproviderErrors](#class-noncesubprovidererrors) - * [types.WalletSubproviderErrors](#class-walletsubprovidererrors) -* [Interfaces]() - * [types.AccountFetchingConfigs](#class-accountfetchingconfigs) - * [types.DerivedHDKeyInfo](#class-derivedhdkeyinfo) - * [types.ECSignatureString](#class-ecsignaturestring) - * [types.JSONRPCRequestPayloadWithMethod](#class-jsonrpcrequestpayloadwithmethod) - * [types.LedgerCommunication](#class-ledgercommunication) - * [types.LedgerCommunicationClient](#class-ledgercommunicationclient) - * [types.LedgerEthereumClient](#class-ledgerethereumclient) - * [types.LedgerGetAddressResult](#class-ledgergetaddressresult) - * [types.LedgerSubproviderConfigs](#class-ledgersubproviderconfigs) - * [types.MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubproviderconfigs) - * [types.PartialTxParams](#class-partialtxparams) - * [types.ResponseWithTxParams](#class-responsewithtxparams) - * [types.SignatureData](#class-signaturedata) - * [types.TrezorConnectResponse](#class-trezorconnectresponse) - * [types.TrezorGetPublicKeyResponsePayload](#class-trezorgetpublickeyresponsepayload) - * [types.TrezorResponseErrorPayload](#class-trezorresponseerrorpayload) - * [types.TrezorSignMsgResponsePayload](#class-trezorsignmsgresponsepayload) - * [types.TrezorSignTxResponsePayload](#class-trezorsigntxresponsepayload) - * [types.TrezorSubproviderConfig](#class-trezorsubproviderconfig) - -
- diff --git a/packages/website/mdx/tools/@0x/subproviders/v5.0.1/reference.mdx b/packages/website/mdx/tools/@0x/subproviders/v5.0.1/reference.mdx index d3c40e92c6..3ac19200e5 100644 --- a/packages/website/mdx/tools/@0x/subproviders/v5.0.1/reference.mdx +++ b/packages/website/mdx/tools/@0x/subproviders/v5.0.1/reference.mdx @@ -1,6 +1,6 @@ -> # Class: BaseWalletSubprovider +# Class: BaseWalletSubprovider -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) @@ -14,27 +14,16 @@ * [TrezorSubprovider](#class-trezorsubprovider) -## Index ### Methods -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#abstract-getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#abstract-signpersonalmessageasync) -* [signTransactionAsync](#abstract-signtransactionasync) -* [signTypedDataAsync](#abstract-signtypeddataasync) - -## Methods - -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -52,23 +41,23 @@ JSON RPC response payload ___ -### `Abstract` getAccountsAsync +## `Abstract` getAccountsAsync ▸ **getAccountsAsync**(): *`Promise`* -*Defined in [subproviders/base_wallet_subprovider.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L23)* +*Defined in [subproviders/base_wallet_subprovider.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L23)* **Returns:** *`Promise`* ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -86,13 +75,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/subprovider.ts#L68)* Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call @@ -108,11 +97,11 @@ Name | Type | Description | ___ -### `Abstract` signPersonalMessageAsync +## `Abstract` signPersonalMessageAsync ▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* -*Defined in [subproviders/base_wallet_subprovider.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L25)* +*Defined in [subproviders/base_wallet_subprovider.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L25)* **Parameters:** @@ -125,11 +114,11 @@ Name | Type | ___ -### `Abstract` signTransactionAsync +## `Abstract` signTransactionAsync ▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* -*Defined in [subproviders/base_wallet_subprovider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L24)* +*Defined in [subproviders/base_wallet_subprovider.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L24)* **Parameters:** @@ -141,11 +130,11 @@ Name | Type | ___ -### `Abstract` signTypedDataAsync +## `Abstract` signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* -*Defined in [subproviders/base_wallet_subprovider.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L26)* +*Defined in [subproviders/base_wallet_subprovider.ts:26](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L26)* **Parameters:** @@ -158,34 +147,27 @@ Name | Type |
-> # Class: EmptyWalletSubprovider +# Class: EmptyWalletSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It intercepts the `eth_accounts` JSON RPC requests and never returns any addresses when queried. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **EmptyWalletSubprovider** -## Index ### Methods -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -203,13 +185,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* +*Defined in [subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -227,13 +209,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -249,36 +231,25 @@ Name | Type | Description |
-> # Class: FakeGasEstimateSubprovider +# Class: FakeGasEstimateSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It intercepts the `eth_estimateGas` JSON RPC call and always returns a constant gas amount when queried. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **FakeGasEstimateSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new FakeGasEstimateSubprovider**(`constantGasAmount`: number): *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* -*Defined in [subproviders/fake_gas_estimate_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* +*Defined in [subproviders/fake_gas_estimate_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* Instantiates an instance of the FakeGasEstimateSubprovider @@ -290,15 +261,15 @@ Name | Type | Description | **Returns:** *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -316,13 +287,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* +*Defined in [subproviders/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -340,13 +311,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -362,36 +333,25 @@ Name | Type | Description |
-> # Class: GanacheSubprovider +# Class: GanacheSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It intercepts all JSON RPC requests and relays them to an in-process ganache instance. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **GanacheSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new GanacheSubprovider**(`opts`: `GanacheOpts`): *[GanacheSubprovider](#class-ganachesubprovider)* -*Defined in [subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ganache.ts#L13)* +*Defined in [subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ganache.ts#L13)* Instantiates a GanacheSubprovider @@ -403,15 +363,15 @@ Name | Type | Description | **Returns:** *[GanacheSubprovider](#class-ganachesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -429,13 +389,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ganache.ts#L31)* +*Defined in [subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ganache.ts#L31)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -453,13 +413,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -475,43 +435,26 @@ Name | Type | Description |
-> # Class: LedgerSubprovider +# Class: LedgerSubprovider Subprovider for interfacing with a user's [Ledger Nano S](https://www.ledgerwallet.com/products/ledger-nano-s). This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and re-routes them to a Ledger device plugged into the users computer. -## Hierarchy +### Hierarchy * [BaseWalletSubprovider](#class-basewalletsubprovider) * **LedgerSubprovider** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new LedgerSubprovider**(`config`: [LedgerSubproviderConfigs](#interface-ledgersubproviderconfigs)): *[LedgerSubprovider](#class-ledgersubprovider)* -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new LedgerSubprovider**(`config`: [LedgerSubproviderConfigs](#class-ledgersubprovider)* - -*Defined in [subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L41)* +*Defined in [subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L41)* Instantiates a LedgerSubprovider. Defaults to derivationPath set to `44'/60'/0'`. TestRPC/Ganache defaults to `m/44'/60'/0'/0`, so set this in the configs if desired. @@ -526,15 +469,15 @@ Name | Type | Description | LedgerSubprovider instance -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -552,13 +495,13 @@ JSON RPC response payload ___ -### getAccountsAsync +## getAccountsAsync ▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* -*Defined in [subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L87)* +*Defined in [subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L87)* Retrieve a users Ledger accounts. The accounts are derived from the derivationPath, master public key and chain code. Because of this, you can request as many accounts @@ -578,11 +521,11 @@ An array of accounts ___ -### getPath +## getPath ▸ **getPath**(): *string* -*Defined in [subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L68)* +*Defined in [subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L68)* Retrieve the set derivation path @@ -592,7 +535,7 @@ derivation path ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* @@ -600,7 +543,7 @@ ___ *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -618,13 +561,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/subprovider.ts#L68)* Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call @@ -640,11 +583,11 @@ Name | Type | Description | ___ -### setPath +## setPath ▸ **setPath**(`basDerivationPath`: string): *void* -*Defined in [subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L75)* +*Defined in [subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L75)* Set a desired derivation path when computing the available user addresses @@ -658,13 +601,13 @@ Name | Type | Description | ___ -### signPersonalMessageAsync +## signPersonalMessageAsync ▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* -*Defined in [subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L158)* +*Defined in [subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L158)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. @@ -686,13 +629,13 @@ Signature hex string (order: rsv) ___ -### signTransactionAsync +## signTransactionAsync ▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* -*Defined in [subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L101)* +*Defined in [subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L101)* Signs a transaction on the Ledger with the account specificed by the `from` field in txParams. If you've added the LedgerSubprovider to your app's provider, you can simply send an `eth_sendTransaction` @@ -711,13 +654,13 @@ Signed transaction hex string ___ -### signTypedDataAsync +## signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* -*Defined in [subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/ledger.ts#L196)* +*Defined in [subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/ledger.ts#L196)* eth_signTypedData is currently not supported on Ledger devices. @@ -734,7 +677,7 @@ Signature hex string (order: rsv)
-> # Class: MetamaskSubprovider +# Class: MetamaskSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface and the provider sendAsync interface. @@ -743,32 +686,20 @@ It forwards JSON RPC requests involving the domain of a signer (getAccounts, sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests are passed onwards for subsequent subproviders to handle. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **MetamaskSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [sendAsync](#sendasync) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new MetamaskSubprovider**(`supportedProvider`: `SupportedProvider`): *[MetamaskSubprovider](#class-metamasksubprovider)* -*Defined in [subproviders/metamask_subprovider.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L20)* +*Defined in [subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* Instantiates a new MetamaskSubprovider @@ -780,15 +711,15 @@ Name | Type | Description | **Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -806,13 +737,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/metamask_subprovider.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L40)* +*Defined in [subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -830,11 +761,11 @@ Name | Type | Description | ___ -### sendAsync +## sendAsync ▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* -*Defined in [subproviders/metamask_subprovider.ts:114](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/metamask_subprovider.ts#L114)* +*Defined in [subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -853,13 +784,13 @@ The contents nested under the result key of the response body ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -875,43 +806,26 @@ Name | Type | Description |
-> # Class: MnemonicWalletSubprovider +# Class: MnemonicWalletSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and handles all requests with accounts derived from the supplied mnemonic. -## Hierarchy +### Hierarchy * [BaseWalletSubprovider](#class-basewalletsubprovider) * **MnemonicWalletSubprovider** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new MnemonicWalletSubprovider**(`config`: [MnemonicWalletSubproviderConfigs](#interface-mnemonicwalletsubproviderconfigs)): *[MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider)* -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new MnemonicWalletSubprovider**(`config`: [MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubprovider)* - -*Defined in [subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* +*Defined in [subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* Instantiates a MnemonicWalletSubprovider. Defaults to baseDerivationPath set to `44'/60'/0'/0`. This is the default in TestRPC/Ganache, it can be overridden if desired. @@ -926,15 +840,15 @@ Name | Type | Description | MnemonicWalletSubprovider instance -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -952,13 +866,13 @@ JSON RPC response payload ___ -### getAccountsAsync +## getAccountsAsync ▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* -*Defined in [subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* +*Defined in [subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* Retrieve the accounts associated with the mnemonic. This method is implicitly called when issuing a `eth_accounts` JSON RPC request @@ -976,11 +890,11 @@ An array of accounts ___ -### getPath +## getPath ▸ **getPath**(): *string* -*Defined in [subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* +*Defined in [subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* Retrieve the set derivation path @@ -990,7 +904,7 @@ derivation path ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* @@ -998,7 +912,7 @@ ___ *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1016,13 +930,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1038,11 +952,11 @@ Name | Type | Description | ___ -### setPath +## setPath ▸ **setPath**(`baseDerivationPath`: string): *void* -*Defined in [subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* +*Defined in [subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* Set a desired derivation path when computing the available user addresses @@ -1056,13 +970,13 @@ Name | Type | Description | ___ -### signPersonalMessageAsync +## signPersonalMessageAsync ▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* -*Defined in [subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* +*Defined in [subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. If you've added the MnemonicWalletSubprovider to @@ -1083,13 +997,13 @@ Signature hex string (order: rsv) ___ -### signTransactionAsync +## signTransactionAsync ▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* -*Defined in [subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* +*Defined in [subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* Signs a transaction with the account specificed by the `from` field in txParams. If you've added this Subprovider to your app's provider, you can simply send @@ -1108,13 +1022,13 @@ Signed transaction hex string ___ -### signTypedDataAsync +## signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: `EIP712TypedData`): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* -*Defined in [subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* +*Defined in [subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* Sign an EIP712 Typed Data message. The signing account will be the account associated with the provided address. If you've added this MnemonicWalletSubprovider to @@ -1135,35 +1049,28 @@ Signature hex string (order: rsv)
-> # Class: NonceTrackerSubprovider +# Class: NonceTrackerSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It is heavily inspired by the [NonceSubprovider](https://github.com/MetaMask/provider-engine/blob/master/subproviders/nonce-tracker.js). We added the additional feature of clearing the cached nonce value when a `nonce value too low` error occurs. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **NonceTrackerSubprovider** -## Index ### Methods -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1181,13 +1088,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* +*Defined in [subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1205,13 +1112,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1227,41 +1134,26 @@ Name | Type | Description |
-> # Class: PrivateKeyWalletSubprovider +# Class: PrivateKeyWalletSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. This subprovider intercepts all account related RPC requests (e.g message/transaction signing, etc...) and handles all requests with the supplied Ethereum private key. -## Hierarchy +### Hierarchy * [BaseWalletSubprovider](#class-basewalletsubprovider) * **PrivateKeyWalletSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor +## constructer \+ **new PrivateKeyWalletSubprovider**(`privateKey`: string): *[PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider)* -*Defined in [subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* +*Defined in [subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* Instantiates a PrivateKeyWalletSubprovider. @@ -1275,15 +1167,15 @@ Name | Type | Description | PrivateKeyWalletSubprovider instance -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1301,13 +1193,13 @@ JSON RPC response payload ___ -### getAccountsAsync +## getAccountsAsync ▸ **getAccountsAsync**(): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* -*Defined in [subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* +*Defined in [subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* Retrieve the account associated with the supplied private key. This method is implicitly called when issuing a `eth_accounts` JSON RPC request @@ -1319,7 +1211,7 @@ An array of accounts ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* @@ -1327,7 +1219,7 @@ ___ *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1345,13 +1237,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1367,13 +1259,13 @@ Name | Type | Description | ___ -### signPersonalMessageAsync +## signPersonalMessageAsync ▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* -*Defined in [subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* +*Defined in [subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* Sign a personal Ethereum signed message. The signing address will be calculated from the private key. The address must be provided it must match the address calculated from the private key. @@ -1394,13 +1286,13 @@ Signature hex string (order: rsv) ___ -### signTransactionAsync +## signTransactionAsync ▸ **signTransactionAsync**(`txParams`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* -*Defined in [subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* +*Defined in [subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* Sign a transaction with the private key. If you've added this Subprovider to your app's provider, you can simply send an `eth_sendTransaction` JSON RPC request, and @@ -1419,13 +1311,13 @@ Signed transaction hex string ___ -### signTypedDataAsync +## signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: `EIP712TypedData`): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* -*Defined in [subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* +*Defined in [subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* Sign an EIP712 Typed Data message. The signing address will be calculated from the private key. The address must be provided it must match the address calculated from the private key. @@ -1446,37 +1338,26 @@ Signature hex string (order: rsv)
-> # Class: RedundantSubprovider +# Class: RedundantSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It attempts to handle each JSON RPC request by sequentially attempting to receive a valid response from one of a set of JSON RPC endpoints. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **RedundantSubprovider** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new RedundantSubprovider**(`subproviders`: [Subprovider](_subproviders_subprovider_.subprovider.md)[]): *[RedundantSubprovider](#class-redundantsubprovider)* -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor - -\+ **new RedundantSubprovider**(`subproviders`: [Subprovider](#class-redundantsubprovider)* - -*Defined in [subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* +*Defined in [subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* Instantiates a new RedundantSubprovider @@ -1488,15 +1369,15 @@ Name | Type | Description | **Returns:** *[RedundantSubprovider](#class-redundantsubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1514,13 +1395,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: function): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* +*Defined in [subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1553,13 +1434,13 @@ Name | Type | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1575,36 +1456,25 @@ Name | Type | Description |
-> # Class: RPCSubprovider +# Class: RPCSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **RPCSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* -*Defined in [subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* +*Defined in [subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* **Parameters:** @@ -1615,15 +1485,15 @@ Name | Type | Default | Description | **Returns:** *[RPCSubprovider](#class-rpcsubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1641,13 +1511,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +*Defined in [subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1665,13 +1535,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1687,38 +1557,27 @@ Name | Type | Description |
-> # Class: SignerSubprovider +# Class: SignerSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It forwards JSON RPC requests involving the domain of a signer (getAccounts, sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests are passed onwards for subsequent subproviders to handle. -## Hierarchy +### Hierarchy * [Subprovider](#class-subprovider) * **SignerSubprovider** -## Index ### Constructors -* [constructor](#constructor) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new SignerSubprovider**(`supportedProvider`: `SupportedProvider`): *[SignerSubprovider](#class-signersubprovider)* -*Defined in [subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/signer.ts#L15)* +*Defined in [subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/signer.ts#L15)* Instantiates a new SignerSubprovider. @@ -1730,15 +1589,15 @@ Name | Type | Description | **Returns:** *[SignerSubprovider](#class-signersubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1756,13 +1615,13 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/signer.ts#L33)* +*Defined in [subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/signer.ts#L33)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1780,13 +1639,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1802,12 +1661,12 @@ Name | Type | Description |
-> # Class: Subprovider +# Class: Subprovider A altered version of the base class Subprovider found in [web3-provider-engine](https://github.com/MetaMask/provider-engine). This one has an async/await `emitPayloadAsync` and also defined types. -## Hierarchy +### Hierarchy * **Subprovider** @@ -1829,21 +1688,14 @@ This one has an async/await `emitPayloadAsync` and also defined types. * [MetamaskSubprovider](#class-metamasksubprovider) -## Index ### Methods -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#abstract-handlerequest) -* [setEngine](#setengine) - -## Methods - -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1861,11 +1713,11 @@ JSON RPC response payload ___ -### `Abstract` handleRequest +## `Abstract` handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* -*Defined in [subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L42)* +*Defined in [subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/subprovider.ts#L42)* **Parameters:** @@ -1879,11 +1731,11 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1899,37 +1751,22 @@ Name | Type | Description |
-> # Class: TrezorSubprovider +# Class: TrezorSubprovider -## Hierarchy +### Hierarchy * [BaseWalletSubprovider](#class-basewalletsubprovider) * **TrezorSubprovider** -## Index ### Constructors -* [constructor](#constructor) +## constructer -### Methods +\+ **new TrezorSubprovider**(`config`: [TrezorSubproviderConfig](#interface-trezorsubproviderconfig)): *[TrezorSubprovider](#class-trezorsubprovider)* -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor - -\+ **new TrezorSubprovider**(`config`: [TrezorSubproviderConfig](#class-trezorsubprovider)* - -*Defined in [subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L32)* +*Defined in [subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/trezor.ts#L32)* Instantiates a TrezorSubprovider. Defaults to private key path set to `44'/60'/0'/0/`. Must be initialized with trezor-connect API module https://github.com/trezor/connect. @@ -1944,15 +1781,15 @@ Name | Type | TrezorSubprovider instance -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Inherited from [Subprovider](#emitpayloadasync)* -*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -1970,13 +1807,13 @@ JSON RPC response payload ___ -### getAccountsAsync +## getAccountsAsync ▸ **getAccountsAsync**(`numberOfAccounts`: number): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-getaccountsasync)* -*Defined in [subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L56)* +*Defined in [subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/trezor.ts#L56)* Retrieve a users Trezor account. This method is automatically called when issuing a `eth_accounts` JSON RPC request via your providerEngine @@ -1994,7 +1831,7 @@ An array of accounts ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#errorcallback)): *`Promise`* @@ -2002,7 +1839,7 @@ ___ *Overrides [Subprovider](#abstract-handlerequest)* -*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -2020,13 +1857,13 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Inherited from [Subprovider](#setengine)* -*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/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 @@ -2042,13 +1879,13 @@ Name | Type | Description | ___ -### signPersonalMessageAsync +## signPersonalMessageAsync ▸ **signPersonalMessageAsync**(`data`: string, `address`: string): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signpersonalmessageasync)* -*Defined in [subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L129)* +*Defined in [subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/trezor.ts#L129)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. If you've added the TrezorSubprovider to @@ -2069,13 +1906,13 @@ Signature hex string (order: rsv) ___ -### signTransactionAsync +## signTransactionAsync ▸ **signTransactionAsync**(`txData`: [PartialTxParams](#interface-partialtxparams)): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtransactionasync)* -*Defined in [subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L70)* +*Defined in [subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/trezor.ts#L70)* Signs a transaction on the Trezor with the account specificed by the `from` field in txParams. If you've added the TrezorSubprovider to your app's provider, you can simply send an `eth_sendTransaction` @@ -2094,13 +1931,13 @@ Signed transaction hex string ___ -### signTypedDataAsync +## signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* *Overrides [BaseWalletSubprovider](#abstract-signtypeddataasync)* -*Defined in [subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/subproviders/trezor.ts#L161)* +*Defined in [subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/subproviders/trezor.ts#L161)* TODO:: eth_signTypedData is currently not supported on Trezor devices. @@ -2117,335 +1954,278 @@ Signature hex string (order: rsv)
-> # Enumeration: LedgerSubproviderErrors +# Enumeration: LedgerSubproviderErrors -## Index ### Enumeration members -* [MultipleOpenConnectionsDisallowed](#multipleopenconnectionsdisallowed) -* [TooOldLedgerFirmware](#toooldledgerfirmware) - -## Enumeration members - -### MultipleOpenConnectionsDisallowed +## MultipleOpenConnectionsDisallowed • **MultipleOpenConnectionsDisallowed**: = "MULTIPLE_OPEN_CONNECTIONS_DISALLOWED" -*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L116)* ___ -### TooOldLedgerFirmware +## TooOldLedgerFirmware • **TooOldLedgerFirmware**: = "TOO_OLD_LEDGER_FIRMWARE" -*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L115)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L115)*
-> # Enumeration: NonceSubproviderErrors +# Enumeration: NonceSubproviderErrors -## Index ### Enumeration members -* [CannotDetermineAddressFromPayload](#cannotdetermineaddressfrompayload) -* [EmptyParametersFound](#emptyparametersfound) - -## Enumeration members - -### CannotDetermineAddressFromPayload +## CannotDetermineAddressFromPayload • **CannotDetermineAddressFromPayload**: = "CANNOT_DETERMINE_ADDRESS_FROM_PAYLOAD" -*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L121)* ___ -### EmptyParametersFound +## EmptyParametersFound • **EmptyParametersFound**: = "EMPTY_PARAMETERS_FOUND" -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L120)*
-> # Enumeration: WalletSubproviderErrors +# Enumeration: WalletSubproviderErrors -## Index ### Enumeration members -* [AddressNotFound](#addressnotfound) -* [DataMissingForSignPersonalMessage](#datamissingforsignpersonalmessage) -* [DataMissingForSignTypedData](#datamissingforsigntypeddata) -* [FromAddressMissingOrInvalid](#fromaddressmissingorinvalid) -* [MethodNotSupported](#methodnotsupported) -* [SenderInvalidOrNotSupplied](#senderinvalidornotsupplied) - -## Enumeration members - -### AddressNotFound +## AddressNotFound • **AddressNotFound**: = "ADDRESS_NOT_FOUND" -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L107)* ___ -### DataMissingForSignPersonalMessage +## DataMissingForSignPersonalMessage • **DataMissingForSignPersonalMessage**: = "DATA_MISSING_FOR_SIGN_PERSONAL_MESSAGE" -*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L108)* +*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L108)* ___ -### DataMissingForSignTypedData +## DataMissingForSignTypedData • **DataMissingForSignTypedData**: = "DATA_MISSING_FOR_SIGN_TYPED_DATA" -*Defined in [types.ts:109](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L109)* +*Defined in [types.ts:109](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L109)* ___ -### FromAddressMissingOrInvalid +## FromAddressMissingOrInvalid • **FromAddressMissingOrInvalid**: = "FROM_ADDRESS_MISSING_OR_INVALID" -*Defined in [types.ts:111](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L111)* +*Defined in [types.ts:111](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L111)* ___ -### MethodNotSupported +## MethodNotSupported • **MethodNotSupported**: = "METHOD_NOT_SUPPORTED" -*Defined in [types.ts:112](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L112)* +*Defined in [types.ts:112](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L112)* ___ -### SenderInvalidOrNotSupplied +## SenderInvalidOrNotSupplied • **SenderInvalidOrNotSupplied**: = "SENDER_INVALID_OR_NOT_SUPPLIED" -*Defined in [types.ts:110](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L110)* +*Defined in [types.ts:110](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L110)*
-> # Interface: AccountFetchingConfigs +# Interface: AccountFetchingConfigs addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 numAddressesToReturn: Number of addresses to return from 'eth_accounts' call shouldAskForOnDeviceConfirmation: Whether you wish to prompt the user on their Ledger before fetching their addresses -## Hierarchy +### Hierarchy * **AccountFetchingConfigs** -## Index ### Properties -* [addressSearchLimit](#optional-addresssearchlimit) -* [numAddressesToReturn](#optional-numaddressestoreturn) -* [shouldAskForOnDeviceConfirmation](#optional-shouldaskforondeviceconfirmation) - -## Properties - -### `Optional` addressSearchLimit +## `Optional` addressSearchLimit • **addressSearchLimit**? : *undefined | number* -*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L55)* ___ -### `Optional` numAddressesToReturn +## `Optional` numAddressesToReturn • **numAddressesToReturn**? : *undefined | number* -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L56)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L56)* ___ -### `Optional` shouldAskForOnDeviceConfirmation +## `Optional` shouldAskForOnDeviceConfirmation • **shouldAskForOnDeviceConfirmation**? : *undefined | false | true* -*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L57)* +*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L57)*
-> # Interface: DerivedHDKeyInfo +# Interface: DerivedHDKeyInfo -## Hierarchy +### Hierarchy * **DerivedHDKeyInfo** -## Index ### Properties -* [address](#address) -* [baseDerivationPath](#basederivationpath) -* [derivationPath](#derivationpath) -* [hdKey](#hdkey) - -## Properties - -### address +## address • **address**: *string* -*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L124)* ___ -### baseDerivationPath +## baseDerivationPath • **baseDerivationPath**: *string* -*Defined in [types.ts:125](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L125)* ___ -### derivationPath +## derivationPath • **derivationPath**: *string* -*Defined in [types.ts:126](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L126)* +*Defined in [types.ts:126](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L126)* ___ -### hdKey +## hdKey • **hdKey**: *`HDNode`* -*Defined in [types.ts:127](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L127)* +*Defined in [types.ts:127](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L127)*
-> # Interface: ECSignatureString +# Interface: ECSignatureString -## Hierarchy +### Hierarchy * **ECSignatureString** -## Index ### Properties -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### r +## r • **r**: *string* -*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L29)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L30)* ___ -### v +## v • **v**: *string* -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L28)*
-> # Interface: JSONRPCRequestPayloadWithMethod +# Interface: JSONRPCRequestPayloadWithMethod -## Hierarchy +### Hierarchy * `JSONRPCRequestPayload` * **JSONRPCRequestPayloadWithMethod** -## Index ### Properties -* [id](#id) -* [jsonrpc](#jsonrpc) -* [method](#method) -* [params](#params) - -## Properties - -### id +## id • **id**: *number* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:262 + + ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:263 + + ___ -### method +## method • **method**: *string* *Overrides void* -*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L136)* +*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L136)* ___ -### params +## params • **params**: *any[]* -*Inherited from void* -Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-types/lib/index.d.ts:260 + +
-> # Interface: LedgerCommunication +# Interface: LedgerCommunication -## Hierarchy +### Hierarchy * **LedgerCommunication** -## Index ### Properties -* [close_async](#close_async) - -## Properties - -### close_async +## close_async • **close_async**: *function* -*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L98)* +*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L98)* #### Type declaration: @@ -2453,25 +2233,20 @@ Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-
-> # Interface: LedgerCommunicationClient +# Interface: LedgerCommunicationClient -## Hierarchy +### Hierarchy * **LedgerCommunicationClient** -## Index ### Properties -* [close](#close) - -## Properties - -### close +## close • **close**: *function* -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L5)* #### Type declaration: @@ -2479,33 +2254,25 @@ Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/packages/ethereum-
-> # Interface: LedgerEthereumClient +# Interface: LedgerEthereumClient Elliptic Curve signature The LedgerEthereumClient sends Ethereum-specific requests to the Ledger Nano S It uses an internal LedgerCommunicationClient to relay these requests. Currently NodeJs and Browser communication are supported. -## Hierarchy +### Hierarchy * **LedgerEthereumClient** -## Index ### Properties -* [getAddress](#getaddress) -* [signPersonalMessage](#signpersonalmessage) -* [signTransaction](#signtransaction) -* [transport](#transport) - -## Properties - -### getAddress +## getAddress • **getAddress**: *function* -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L17)* #### Type declaration: @@ -2521,11 +2288,11 @@ Name | Type | ___ -### signPersonalMessage +## signPersonalMessage • **signPersonalMessage**: *function* -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L23)* #### Type declaration: @@ -2540,11 +2307,11 @@ Name | Type | ___ -### signTransaction +## signTransaction • **signTransaction**: *function* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L22)* #### Type declaration: @@ -2559,415 +2326,348 @@ Name | Type | ___ -### transport +## transport • **transport**: *[LedgerCommunicationClient](#interface-ledgercommunicationclient)* -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L24)*
-> # Interface: LedgerGetAddressResult +# Interface: LedgerGetAddressResult -## Hierarchy +### Hierarchy * **LedgerGetAddressResult** -## Index ### Properties -* [address](#address) -* [chainCode](#chaincode) -* [publicKey](#publickey) - -## Properties - -### address +## address • **address**: *string* -*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L79)* +*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L79)* ___ -### chainCode +## chainCode • **chainCode**: *string* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L81)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L81)* ___ -### publicKey +## publicKey • **publicKey**: *string* -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L80)* +*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L80)*
-> # Interface: LedgerSubproviderConfigs +# Interface: LedgerSubproviderConfigs networkId: The ethereum networkId to set as the chainId from EIP155 ledgerConnectionType: Environment in which you wish to connect to Ledger (nodejs or browser) derivationPath: Initial derivation path to use e.g 44'/60'/0' accountFetchingConfigs: configs related to fetching accounts from a Ledger -## Hierarchy +### Hierarchy * **LedgerSubproviderConfigs** -## Index ### Properties -* [accountFetchingConfigs](#optional-accountfetchingconfigs) -* [baseDerivationPath](#optional-basederivationpath) -* [ledgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync) -* [networkId](#networkid) - -## Properties - -### `Optional` accountFetchingConfigs +## `Optional` accountFetchingConfigs • **accountFetchingConfigs**? : *[AccountFetchingConfigs](#interface-accountfetchingconfigs)* -*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L45)* ___ -### `Optional` baseDerivationPath +## `Optional` baseDerivationPath • **baseDerivationPath**? : *undefined | string* -*Defined in [types.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L44)* ___ -### ledgerEthereumClientFactoryAsync +## ledgerEthereumClientFactoryAsync • **ledgerEthereumClientFactoryAsync**: *[LedgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync)* -*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L43)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L42)*
-> # Interface: MnemonicWalletSubproviderConfigs +# Interface: MnemonicWalletSubproviderConfigs mnemonic: The string mnemonic seed addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 baseDerivationPath: The base derivation path (e.g 44'/60'/0'/0) -## Hierarchy +### Hierarchy * **MnemonicWalletSubproviderConfigs** -## Index ### Properties -* [addressSearchLimit](#optional-addresssearchlimit) -* [baseDerivationPath](#optional-basederivationpath) -* [mnemonic](#mnemonic) - -## Properties - -### `Optional` addressSearchLimit +## `Optional` addressSearchLimit • **addressSearchLimit**? : *undefined | number* -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L67)* ___ -### `Optional` baseDerivationPath +## `Optional` baseDerivationPath • **baseDerivationPath**? : *undefined | string* -*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L68)* ___ -### mnemonic +## mnemonic • **mnemonic**: *string* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L66)*
-> # Interface: PartialTxParams +# Interface: PartialTxParams -## Hierarchy +### Hierarchy * **PartialTxParams** -## Index ### Properties -* [chainId](#chainid) -* [data](#optional-data) -* [from](#from) -* [gas](#gas) -* [gasPrice](#optional-gasprice) -* [nonce](#nonce) -* [to](#to) -* [value](#optional-value) - -## Properties - -### chainId +## chainId • **chainId**: *number* -*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L92)* +*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L92)* ___ -### `Optional` data +## `Optional` data • **data**? : *undefined | string* -*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L91)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L89)* +*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L89)* ___ -### gas +## gas • **gas**: *string* -*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L87)* +*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L87)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *undefined | string* -*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L86)* +*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L86)* ___ -### nonce +## nonce • **nonce**: *string* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L85)* ___ -### to +## to • **to**: *string* -*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L88)* +*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L88)* ___ -### `Optional` value +## `Optional` value • **value**? : *undefined | string* -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L90)* +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L90)*
-> # Interface: ResponseWithTxParams +# Interface: ResponseWithTxParams -## Hierarchy +### Hierarchy * **ResponseWithTxParams** -## Index ### Properties -* [raw](#raw) -* [tx](#tx) - -## Properties - -### raw +## raw • **raw**: *string* -*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L102)* +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L102)* ___ -### tx +## tx • **tx**: *[PartialTxParams](#interface-partialtxparams)* -*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L103)* +*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L103)*
-> # Interface: SignatureData +# Interface: SignatureData -## Hierarchy +### Hierarchy * **SignatureData** -## Index ### Properties -* [hash](#hash) -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### hash +## hash • **hash**: *string* -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L72)* ___ -### r +## r • **r**: *string* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L73)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L74)* ___ -### v +## v • **v**: *number* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L75)*
-> # Interface: TrezorConnectResponse +# Interface: TrezorConnectResponse -## Hierarchy +### Hierarchy * **TrezorConnectResponse** -## Index ### Properties -* [id](#id) -* [payload](#payload) -* [success](#success) - -## Properties - -### id +## id • **id**: *number* -*Defined in [types.ts:175](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L175)* +*Defined in [types.ts:175](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L175)* ___ -### payload +## payload • **payload**: *any* -*Defined in [types.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L174)* +*Defined in [types.ts:174](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L174)* ___ -### success +## success • **success**: *boolean* -*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L176)* +*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L176)*
-> # Interface: TrezorGetPublicKeyResponsePayload +# Interface: TrezorGetPublicKeyResponsePayload -## Hierarchy +### Hierarchy * **TrezorGetPublicKeyResponsePayload** -## Index ### Properties -* [chainCode](#chaincode) -* [childNumb](#childnumb) -* [depth](#depth) -* [fingerprint](#fingerprint) -* [path](#path) -* [publicKey](#publickey) -* [serializedPath](#serializedpath) -* [xpub](#xpub) - -## Properties - -### chainCode +## chainCode • **chainCode**: *string* -*Defined in [types.ts:152](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L152)* +*Defined in [types.ts:152](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L152)* ___ -### childNumb +## childNumb • **childNumb**: *number* -*Defined in [types.ts:150](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L150)* +*Defined in [types.ts:150](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L150)* ___ -### depth +## depth • **depth**: *number* -*Defined in [types.ts:155](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L155)* +*Defined in [types.ts:155](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L155)* ___ -### fingerprint +## fingerprint • **fingerprint**: *number* -*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L154)* ___ -### path +## path • **path**: *object* -*Defined in [types.ts:146](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L146)* +*Defined in [types.ts:146](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L146)* #### Type declaration: @@ -2975,258 +2675,135 @@ ___ ___ -### publicKey +## publicKey • **publicKey**: *string* -*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L153)* ___ -### serializedPath +## serializedPath • **serializedPath**: *string* -*Defined in [types.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L149)* +*Defined in [types.ts:149](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L149)* ___ -### xpub +## xpub • **xpub**: *string* -*Defined in [types.ts:151](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L151)* +*Defined in [types.ts:151](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L151)*
-> # Interface: TrezorResponseErrorPayload +# Interface: TrezorResponseErrorPayload -## Hierarchy +### Hierarchy * **TrezorResponseErrorPayload** -## Index ### Properties -* [error](#error) - -## Properties - -### error +## error • **error**: *string* -*Defined in [types.ts:170](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L170)* +*Defined in [types.ts:170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L170)*
-> # Interface: TrezorSignMsgResponsePayload +# Interface: TrezorSignMsgResponsePayload -## Hierarchy +### Hierarchy * **TrezorSignMsgResponsePayload** -## Index ### Properties -* [address](#address) -* [signature](#signature) - -## Properties - -### address +## address • **address**: *string* -*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L165)* ___ -### signature +## signature • **signature**: *string* -*Defined in [types.ts:166](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L166)* +*Defined in [types.ts:166](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L166)*
-> # Interface: TrezorSignTxResponsePayload +# Interface: TrezorSignTxResponsePayload -## Hierarchy +### Hierarchy * **TrezorSignTxResponsePayload** -## Index ### Properties -* [r](#r) -* [s](#s) -* [v](#v) - -## Properties - -### r +## r • **r**: *string* -*Defined in [types.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L160)* +*Defined in [types.ts:160](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L160)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L161)* +*Defined in [types.ts:161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L161)* ___ -### v +## v • **v**: *string* -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L159)* +*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L159)*
-> # Interface: TrezorSubproviderConfig +# Interface: TrezorSubproviderConfig -## Hierarchy +### Hierarchy * **TrezorSubproviderConfig** -## Index ### Properties -* [accountFetchingConfigs](#accountfetchingconfigs) -* [networkId](#networkid) -* [trezorConnectClientApi](#trezorconnectclientapi) - -## Properties - -### accountFetchingConfigs +## accountFetchingConfigs • **accountFetchingConfigs**: *[AccountFetchingConfigs](#interface-accountfetchingconfigs)* -*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L140)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:142](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L142)* +*Defined in [types.ts:142](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L142)* ___ -### trezorConnectClientApi +## trezorConnectClientApi • **trezorConnectClientApi**: *any* -*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/subproviders/src/types.ts#L141)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [subproviders/base_wallet_subprovider](modules/_subproviders_base_wallet_subprovider_.md) - * [subproviders/base_wallet_subprovider.BaseWalletSubprovider](#class-basewalletsubprovider) - * [subproviders/empty_wallet_subprovider](modules/_subproviders_empty_wallet_subprovider_.md) - * [subproviders/empty_wallet_subprovider.EmptyWalletSubprovider](#class-emptywalletsubprovider) - * [subproviders/fake_gas_estimate_subprovider](modules/_subproviders_fake_gas_estimate_subprovider_.md) - * [subproviders/fake_gas_estimate_subprovider.FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider) - * [subproviders/ganache](modules/_subproviders_ganache_.md) - * [subproviders/ganache.GanacheSubprovider](#class-ganachesubprovider) - * [subproviders/ledger](modules/_subproviders_ledger_.md) - * [subproviders/ledger.LedgerSubprovider](#class-ledgersubprovider) - * [subproviders/metamask_subprovider](modules/_subproviders_metamask_subprovider_.md) - * [subproviders/metamask_subprovider.MetamaskSubprovider](#class-metamasksubprovider) - * [subproviders/mnemonic_wallet](modules/_subproviders_mnemonic_wallet_.md) - * [subproviders/mnemonic_wallet.MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider) - * [subproviders/nonce_tracker](modules/_subproviders_nonce_tracker_.md) - * [subproviders/nonce_tracker.NonceTrackerSubprovider](#class-noncetrackersubprovider) - * [subproviders/private_key_wallet](modules/_subproviders_private_key_wallet_.md) - * [subproviders/private_key_wallet.PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider) - * [subproviders/redundant_subprovider](modules/_subproviders_redundant_subprovider_.md) - * [subproviders/redundant_subprovider.RedundantSubprovider](#class-redundantsubprovider) - * [subproviders/rpc_subprovider](modules/_subproviders_rpc_subprovider_.md) - * [subproviders/rpc_subprovider.RPCSubprovider](#class-rpcsubprovider) - * [subproviders/signer](modules/_subproviders_signer_.md) - * [subproviders/signer.SignerSubprovider](#class-signersubprovider) - * [subproviders/subprovider](modules/_subproviders_subprovider_.md) - * [subproviders/subprovider.Subprovider](#class-subprovider) - * [subproviders/trezor](modules/_subproviders_trezor_.md) - * [subproviders/trezor.TrezorSubprovider](#class-trezorsubprovider) - * [types](modules/_types_.md) - * [types.LedgerSubproviderErrors](#class-ledgersubprovidererrors) - * [types.NonceSubproviderErrors](#class-noncesubprovidererrors) - * [types.WalletSubproviderErrors](#class-walletsubprovidererrors) - * [types.AccountFetchingConfigs](#class-accountfetchingconfigs) - * [types.DerivedHDKeyInfo](#class-derivedhdkeyinfo) - * [types.ECSignatureString](#class-ecsignaturestring) - * [types.JSONRPCRequestPayloadWithMethod](#class-jsonrpcrequestpayloadwithmethod) - * [types.LedgerCommunication](#class-ledgercommunication) - * [types.LedgerCommunicationClient](#class-ledgercommunicationclient) - * [types.LedgerEthereumClient](#class-ledgerethereumclient) - * [types.LedgerGetAddressResult](#class-ledgergetaddressresult) - * [types.LedgerSubproviderConfigs](#class-ledgersubproviderconfigs) - * [types.MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubproviderconfigs) - * [types.PartialTxParams](#class-partialtxparams) - * [types.ResponseWithTxParams](#class-responsewithtxparams) - * [types.SignatureData](#class-signaturedata) - * [types.TrezorConnectResponse](#class-trezorconnectresponse) - * [types.TrezorGetPublicKeyResponsePayload](#class-trezorgetpublickeyresponsepayload) - * [types.TrezorResponseErrorPayload](#class-trezorresponseerrorpayload) - * [types.TrezorSignMsgResponsePayload](#class-trezorsignmsgresponsepayload) - * [types.TrezorSignTxResponsePayload](#class-trezorsigntxresponsepayload) - * [types.TrezorSubproviderConfig](#class-trezorsubproviderconfig) - * [utils/subprovider_utils](modules/_utils_subprovider_utils_.md) - * [utils/wallet_utils](modules/_utils_wallet_utils_.md) -* [Classes]() - * [subproviders/base_wallet_subprovider.BaseWalletSubprovider](#class-basewalletsubprovider) - * [subproviders/empty_wallet_subprovider.EmptyWalletSubprovider](#class-emptywalletsubprovider) - * [subproviders/fake_gas_estimate_subprovider.FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider) - * [subproviders/ganache.GanacheSubprovider](#class-ganachesubprovider) - * [subproviders/ledger.LedgerSubprovider](#class-ledgersubprovider) - * [subproviders/metamask_subprovider.MetamaskSubprovider](#class-metamasksubprovider) - * [subproviders/mnemonic_wallet.MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider) - * [subproviders/nonce_tracker.NonceTrackerSubprovider](#class-noncetrackersubprovider) - * [subproviders/private_key_wallet.PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider) - * [subproviders/redundant_subprovider.RedundantSubprovider](#class-redundantsubprovider) - * [subproviders/rpc_subprovider.RPCSubprovider](#class-rpcsubprovider) - * [subproviders/signer.SignerSubprovider](#class-signersubprovider) - * [subproviders/subprovider.Subprovider](#class-subprovider) - * [subproviders/trezor.TrezorSubprovider](#class-trezorsubprovider) -* [Enums]() - * [types.LedgerSubproviderErrors](#class-ledgersubprovidererrors) - * [types.NonceSubproviderErrors](#class-noncesubprovidererrors) - * [types.WalletSubproviderErrors](#class-walletsubprovidererrors) -* [Interfaces]() - * [types.AccountFetchingConfigs](#class-accountfetchingconfigs) - * [types.DerivedHDKeyInfo](#class-derivedhdkeyinfo) - * [types.ECSignatureString](#class-ecsignaturestring) - * [types.JSONRPCRequestPayloadWithMethod](#class-jsonrpcrequestpayloadwithmethod) - * [types.LedgerCommunication](#class-ledgercommunication) - * [types.LedgerCommunicationClient](#class-ledgercommunicationclient) - * [types.LedgerEthereumClient](#class-ledgerethereumclient) - * [types.LedgerGetAddressResult](#class-ledgergetaddressresult) - * [types.LedgerSubproviderConfigs](#class-ledgersubproviderconfigs) - * [types.MnemonicWalletSubproviderConfigs](#class-mnemonicwalletsubproviderconfigs) - * [types.PartialTxParams](#class-partialtxparams) - * [types.ResponseWithTxParams](#class-responsewithtxparams) - * [types.SignatureData](#class-signaturedata) - * [types.TrezorConnectResponse](#class-trezorconnectresponse) - * [types.TrezorGetPublicKeyResponsePayload](#class-trezorgetpublickeyresponsepayload) - * [types.TrezorResponseErrorPayload](#class-trezorresponseerrorpayload) - * [types.TrezorSignMsgResponsePayload](#class-trezorsignmsgresponsepayload) - * [types.TrezorSignTxResponsePayload](#class-trezorsigntxresponsepayload) - * [types.TrezorSubproviderConfig](#class-trezorsubproviderconfig) +*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/subproviders/src/types.ts#L141)*
diff --git a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.10/reference.mdx b/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.10/reference.mdx index fb1b2c3141..31cd6df788 100644 --- a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.10/reference.mdx +++ b/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.10/reference.mdx @@ -1,68 +1,19 @@ -> # Class: Web3Wrapper +# Class: Web3Wrapper An alternative to the Web3.js library that provides a consistent, clean, promise-based interface. -## Hierarchy +### Hierarchy * **Web3Wrapper** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [abiDecoder](#abidecoder) -* [isZeroExWeb3Wrapper](#iszeroexweb3wrapper) - -### Methods - -* [awaitTransactionMinedAsync](#awaittransactionminedasync) -* [awaitTransactionSuccessAsync](#awaittransactionsuccessasync) -* [callAsync](#callasync) -* [doesContractExistAtAddressAsync](#doescontractexistataddressasync) -* [estimateGasAsync](#estimategasasync) -* [getAvailableAddressesAsync](#getavailableaddressesasync) -* [getBalanceInWeiAsync](#getbalanceinweiasync) -* [getBlockIfExistsAsync](#getblockifexistsasync) -* [getBlockNumberAsync](#getblocknumberasync) -* [getBlockTimestampAsync](#getblocktimestampasync) -* [getBlockWithTransactionDataAsync](#getblockwithtransactiondataasync) -* [getContractCodeAsync](#getcontractcodeasync) -* [getContractDefaults](#getcontractdefaults) -* [getLogsAsync](#getlogsasync) -* [getNetworkIdAsync](#getnetworkidasync) -* [getNodeTypeAsync](#getnodetypeasync) -* [getNodeVersionAsync](#getnodeversionasync) -* [getProvider](#getprovider) -* [getTransactionByHashAsync](#gettransactionbyhashasync) -* [getTransactionReceiptIfExistsAsync](#gettransactionreceiptifexistsasync) -* [getTransactionTraceAsync](#gettransactiontraceasync) -* [increaseTimeAsync](#increasetimeasync) -* [isSenderAddressAvailableAsync](#issenderaddressavailableasync) -* [mineBlockAsync](#mineblockasync) -* [revertSnapshotAsync](#revertsnapshotasync) -* [sendRawPayloadAsync](#sendrawpayloadasync) -* [sendTransactionAsync](#sendtransactionasync) -* [setHeadAsync](#setheadasync) -* [setProvider](#setprovider) -* [signMessageAsync](#signmessageasync) -* [signTypedDataAsync](#signtypeddataasync) -* [takeSnapshotAsync](#takesnapshotasync) -* [isAddress](#static-isaddress) -* [toBaseUnitAmount](#static-tobaseunitamount) -* [toUnitAmount](#static-tounitamount) -* [toWei](#static-towei) - -## Constructors - -### constructor +## constructer \+ **new Web3Wrapper**(`supportedProvider`: `SupportedProvider`, `callAndTxnDefaults`: `Partial`): *[Web3Wrapper](#class-web3wrapper)* -*Defined in [web3_wrapper.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L145)* +*Defined in [web3_wrapper.ts:145](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L145)* Instantiates a new Web3Wrapper. @@ -77,31 +28,31 @@ Name | Type | Default | Description | An instance of the Web3Wrapper class. -## Properties +### Properties -### abiDecoder +## abiDecoder • **abiDecoder**: *`AbiDecoder`* -*Defined in [web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L54)* +*Defined in [web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L54)* ___ -### isZeroExWeb3Wrapper +## isZeroExWeb3Wrapper • **isZeroExWeb3Wrapper**: *boolean* = true -*Defined in [web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L53)* +*Defined in [web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L53)* Flag to check if this instance is of type Web3Wrapper -## Methods +### Methods -### awaitTransactionMinedAsync +## awaitTransactionMinedAsync ▸ **awaitTransactionMinedAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* -*Defined in [web3_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L568)* +*Defined in [web3_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L568)* Waits for a transaction to be mined and returns the transaction receipt. Note that just because a transaction was mined does not mean it was @@ -123,11 +74,11 @@ Transaction receipt with decoded log args. ___ -### awaitTransactionSuccessAsync +## awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* -*Defined in [web3_wrapper.ts:643](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L643)* +*Defined in [web3_wrapper.ts:643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L643)* Waits for a transaction to be mined and returns the transaction receipt. Unlike awaitTransactionMinedAsync, it will throw if the receipt has a @@ -149,11 +100,11 @@ Transaction receipt with decoded log args. ___ -### callAsync +## callAsync ▸ **callAsync**(`callData`: `CallData`, `defaultBlock?`: `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:525](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L525)* +*Defined in [web3_wrapper.ts:525](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L525)* Call a smart contract method at a given block height @@ -170,11 +121,11 @@ The raw call result ___ -### doesContractExistAtAddressAsync +## doesContractExistAtAddressAsync ▸ **doesContractExistAtAddressAsync**(`address`: string): *`Promise`* -*Defined in [web3_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L273)* +*Defined in [web3_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L273)* Check if a contract exists at a given address @@ -190,11 +141,11 @@ Whether or not contract code was found at the supplied address ___ -### estimateGasAsync +## estimateGasAsync ▸ **estimateGasAsync**(`txData`: `Partial`): *`Promise`* -*Defined in [web3_wrapper.ts:508](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L508)* +*Defined in [web3_wrapper.ts:508](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L508)* Calculate the estimated gas cost for a given transaction @@ -210,11 +161,11 @@ Estimated gas cost ___ -### getAvailableAddressesAsync +## getAvailableAddressesAsync ▸ **getAvailableAddressesAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:421](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L421)* +*Defined in [web3_wrapper.ts:421](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L421)* Retrieve the user addresses available through the backing provider @@ -224,11 +175,11 @@ Available user addresses ___ -### getBalanceInWeiAsync +## getBalanceInWeiAsync ▸ **getBalanceInWeiAsync**(`owner`: string, `defaultBlock?`: `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:254](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L254)* +*Defined in [web3_wrapper.ts:254](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L254)* Retrieves an accounts Ether balance in wei @@ -245,11 +196,11 @@ Balance in wei ___ -### getBlockIfExistsAsync +## getBlockIfExistsAsync ▸ **getBlockIfExistsAsync**(`blockParam`: string | `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:361](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L361)* +*Defined in [web3_wrapper.ts:361](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L361)* Fetch a specific Ethereum block without transaction data @@ -266,11 +217,11 @@ The requested block without transaction data, or undefined if block was not foun ___ -### getBlockNumberAsync +## getBlockNumberAsync ▸ **getBlockNumberAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:347](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L347)* +*Defined in [web3_wrapper.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L347)* Fetches the latest block number @@ -280,11 +231,11 @@ Block number ___ -### getBlockTimestampAsync +## getBlockTimestampAsync ▸ **getBlockTimestampAsync**(`blockParam`: string | `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L409)* +*Defined in [web3_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L409)* Fetch a block's timestamp @@ -300,11 +251,11 @@ The block's timestamp ___ -### getBlockWithTransactionDataAsync +## getBlockWithTransactionDataAsync ▸ **getBlockWithTransactionDataAsync**(`blockParam`: string | `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L387)* +*Defined in [web3_wrapper.ts:387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L387)* Fetch a specific Ethereum block with transaction data @@ -320,11 +271,11 @@ The requested block with transaction data ___ -### getContractCodeAsync +## getContractCodeAsync ▸ **getContractCodeAsync**(`address`: string, `defaultBlock?`: `BlockParam`): *`Promise`* -*Defined in [web3_wrapper.ts:286](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L286)* +*Defined in [web3_wrapper.ts:286](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L286)* Gets the contract code by address @@ -341,11 +292,11 @@ Code of the contract ___ -### getContractDefaults +## getContractDefaults ▸ **getContractDefaults**(): *`Partial` | undefined* -*Defined in [web3_wrapper.ts:164](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L164)* +*Defined in [web3_wrapper.ts:164](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L164)* Get the contract defaults set to the Web3Wrapper instance @@ -355,11 +306,11 @@ CallAndTxnData defaults (e.g gas, gasPrice, nonce, etc...) ___ -### getLogsAsync +## getLogsAsync ▸ **getLogsAsync**(`filter`: `FilterObject`): *`Promise`* -*Defined in [web3_wrapper.ts:475](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L475)* +*Defined in [web3_wrapper.ts:475](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L475)* Retrieve smart contract logs for a given filter @@ -375,11 +326,11 @@ The corresponding log entries ___ -### getNetworkIdAsync +## getNetworkIdAsync ▸ **getNetworkIdAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L207)* +*Defined in [web3_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L207)* Fetches the networkId of the backing Ethereum node @@ -389,11 +340,11 @@ The network id ___ -### getNodeTypeAsync +## getNodeTypeAsync ▸ **getNodeTypeAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:690](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L690)* +*Defined in [web3_wrapper.ts:690](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L690)* Returns either NodeType.Geth or NodeType.Ganache depending on the type of the backing Ethereum node. Throws for any other type of node. @@ -402,11 +353,11 @@ the backing Ethereum node. Throws for any other type of node. ___ -### getNodeVersionAsync +## getNodeVersionAsync ▸ **getNodeVersionAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L199)* +*Defined in [web3_wrapper.ts:199](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L199)* Fetch the backing Ethereum node's version string (e.g `MetaMask/v4.2.0`) @@ -416,11 +367,11 @@ Ethereum node's version string ___ -### getProvider +## getProvider ▸ **getProvider**(): *`SupportedProvider`* -*Defined in [web3_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L171)* +*Defined in [web3_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L171)* Retrieve the Web3 provider @@ -430,11 +381,11 @@ Web3 provider instance ___ -### getTransactionByHashAsync +## getTransactionByHashAsync ▸ **getTransactionByHashAsync**(`txHash`: string): *`Promise`* -*Defined in [web3_wrapper.ts:239](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L239)* +*Defined in [web3_wrapper.ts:239](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L239)* Retrieves the transaction data for a given transaction @@ -450,11 +401,11 @@ The raw transaction data ___ -### getTransactionReceiptIfExistsAsync +## getTransactionReceiptIfExistsAsync ▸ **getTransactionReceiptIfExistsAsync**(`txHash`: string): *`Promise`* -*Defined in [web3_wrapper.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L217)* +*Defined in [web3_wrapper.ts:217](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L217)* Retrieves the transaction receipt for a given transaction hash if found @@ -470,11 +421,11 @@ The transaction receipt, including it's status (0: failed, 1: succeeded). Return ___ -### getTransactionTraceAsync +## getTransactionTraceAsync ▸ **getTransactionTraceAsync**(`txHash`: string, `traceParams`: `TraceParams`): *`Promise`* -*Defined in [web3_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L305)* +*Defined in [web3_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L305)* Gets the debug trace of a transaction @@ -491,11 +442,11 @@ Transaction trace ___ -### increaseTimeAsync +## increaseTimeAsync ▸ **increaseTimeAsync**(`timeDelta`: number): *`Promise`* -*Defined in [web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L458)* +*Defined in [web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L458)* Increase the next blocks timestamp on TestRPC/Ganache or Geth local node. Will throw if provider is neither TestRPC/Ganache or Geth. @@ -510,11 +461,11 @@ Name | Type | Description | ___ -### isSenderAddressAvailableAsync +## isSenderAddressAvailableAsync ▸ **isSenderAddressAvailableAsync**(`senderAddress`: string): *`Promise`* -*Defined in [web3_wrapper.ts:189](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L189)* +*Defined in [web3_wrapper.ts:189](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L189)* Check whether an address is available through the backing provider. This can be useful if you want to know whether a user can sign messages or transactions from @@ -532,11 +483,11 @@ Whether the address is available through the provider. ___ -### mineBlockAsync +## mineBlockAsync ▸ **mineBlockAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L450)* +*Defined in [web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L450)* Mine a block on a TestRPC/Ganache local node @@ -544,11 +495,11 @@ Mine a block on a TestRPC/Ganache local node ___ -### revertSnapshotAsync +## revertSnapshotAsync ▸ **revertSnapshotAsync**(`snapshotId`: number): *`Promise`* -*Defined in [web3_wrapper.ts:442](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L442)* +*Defined in [web3_wrapper.ts:442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L442)* Revert the blockchain state to a previous snapshot state on TestRPC/Ganache local node @@ -564,11 +515,11 @@ Whether the revert was successful ___ -### sendRawPayloadAsync +## sendRawPayloadAsync ▸ **sendRawPayloadAsync**<**A**>(`payload`: `Partial`): *`Promise`* -*Defined in [web3_wrapper.ts:671](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L671)* +*Defined in [web3_wrapper.ts:671](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L671)* Sends a raw Ethereum JSON RPC payload and returns the response's `result` key @@ -588,11 +539,11 @@ The contents nested under the result key of the response body ___ -### sendTransactionAsync +## sendTransactionAsync ▸ **sendTransactionAsync**(`txData`: `TxData`): *`Promise`* -*Defined in [web3_wrapper.ts:547](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L547)* +*Defined in [web3_wrapper.ts:547](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L547)* Send a transaction @@ -608,11 +559,11 @@ Transaction hash ___ -### setHeadAsync +## setHeadAsync ▸ **setHeadAsync**(`blockNumber`: number): *`Promise`* -*Defined in [web3_wrapper.ts:662](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L662)* +*Defined in [web3_wrapper.ts:662](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L662)* Calls the 'debug_setHead' JSON RPC method, which sets the current head of the local chain by block number. Note, this is a destructive action and @@ -630,11 +581,11 @@ Name | Type | Description | ___ -### setProvider +## setProvider ▸ **setProvider**(`supportedProvider`: `SupportedProvider`): *void* -*Defined in [web3_wrapper.ts:178](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L178)* +*Defined in [web3_wrapper.ts:178](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L178)* Update the used Web3 provider @@ -648,11 +599,11 @@ Name | Type | ___ -### signMessageAsync +## signMessageAsync ▸ **signMessageAsync**(`address`: string, `message`: string): *`Promise`* -*Defined in [web3_wrapper.ts:319](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L319)* +*Defined in [web3_wrapper.ts:319](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L319)* Sign a message with a specific address's private key (`eth_sign`) @@ -669,11 +620,11 @@ Signature string (might be VRS or RSV depending on the Signer) ___ -### signTypedDataAsync +## signTypedDataAsync ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* -*Defined in [web3_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L334)* +*Defined in [web3_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L334)* Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`) @@ -690,11 +641,11 @@ Signature string (as RSV) ___ -### takeSnapshotAsync +## takeSnapshotAsync ▸ **takeSnapshotAsync**(): *`Promise`* -*Defined in [web3_wrapper.ts:433](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L433)* +*Defined in [web3_wrapper.ts:433](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L433)* Take a snapshot of the blockchain state on a TestRPC/Ganache local node @@ -704,11 +655,11 @@ The snapshot id. This can be used to revert to this snapshot ___ -### `Static` isAddress +## `Static` isAddress ▸ **isAddress**(`address`: string): *boolean* -*Defined in [web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L65)* +*Defined in [web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L65)* Check if an address is a valid Ethereum address @@ -724,11 +675,11 @@ Whether the address is a valid Ethereum address ___ -### `Static` toBaseUnitAmount +## `Static` toBaseUnitAmount ▸ **toBaseUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* -*Defined in [web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L91)* +*Defined in [web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L91)* A baseUnit is defined as the smallest denomination of a token. An amount expressed in baseUnits is the amount expressed in the smallest denomination. @@ -747,11 +698,11 @@ The amount in baseUnits. ___ -### `Static` toUnitAmount +## `Static` toUnitAmount ▸ **toUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* -*Defined in [web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L76)* +*Defined in [web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L76)* A unit amount is defined as the amount of a token above the specified decimal places (integer part). E.g: If a currency has 18 decimal places, 1e18 or one quintillion of the currency is equivalent @@ -770,11 +721,11 @@ The amount in units. ___ -### `Static` toWei +## `Static` toWei ▸ **toWei**(`ethAmount`: `BigNumber`): *`BigNumber`* -*Defined in [web3_wrapper.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L107)* +*Defined in [web3_wrapper.ts:107](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/web3_wrapper.ts#L107)* Convert an Ether amount from ETH to Wei @@ -790,54 +741,43 @@ Amount in wei
-> # Enumeration: NodeType +# Enumeration: NodeType -## Index ### Enumeration members -* [Ganache](#ganache) -* [Geth](#geth) - -## Enumeration members - -### Ganache +## Ganache • **Ganache**: = "GANACHE" -*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L91)* ___ -### Geth +## Geth • **Geth**: = "GETH" -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L90)* +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L90)*
-> # Enumeration: Web3WrapperErrors +# Enumeration: Web3WrapperErrors -## Index ### Enumeration members -* [TransactionMiningTimeout](#transactionminingtimeout) - -## Enumeration members - -### TransactionMiningTimeout +## TransactionMiningTimeout • **TransactionMiningTimeout**: = "TRANSACTION_MINING_TIMEOUT" -*Defined in [types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L2)* +*Defined in [types.ts:2](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L2)*
-> # Interface: AbstractBlockRPC +# Interface: AbstractBlockRPC -## Hierarchy +### Hierarchy * **AbstractBlockRPC** @@ -845,681 +785,605 @@ ___ * [BlockWithTransactionDataRPC](#interface-blockwithtransactiondatarpc) -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *string* -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L15)* ___ -### extraData +## extraData • **extraData**: *string* -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L17)* ___ -### gasLimit +## gasLimit • **gasLimit**: *string* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L19)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L20)* ___ -### hash +## hash • **hash**: *string | null* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L7)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L11)* ___ -### miner +## miner • **miner**: *string* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L14)* ___ -### nonce +## nonce • **nonce**: *string | null* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L9)* ___ -### number +## number • **number**: *string | null* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L6)* ___ -### parentHash +## parentHash • **parentHash**: *string* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L8)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L10)* ___ -### size +## size • **size**: *string* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L18)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L13)* ___ -### timestamp +## timestamp • **timestamp**: *string* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L21)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *string* -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L16)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L12)* ___ -### uncles +## uncles • **uncles**: *string[]* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L22)*
-> # Interface: BlockWithoutTransactionDataRPC +# Interface: BlockWithoutTransactionDataRPC -## Hierarchy +### Hierarchy * [AbstractBlockRPC](#interface-abstractblockrpc) * **BlockWithoutTransactionDataRPC** -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *string* *Inherited from [AbstractBlockRPC](#difficulty)* -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L15)* ___ -### extraData +## extraData • **extraData**: *string* *Inherited from [AbstractBlockRPC](#extradata)* -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L17)* ___ -### gasLimit +## gasLimit • **gasLimit**: *string* *Inherited from [AbstractBlockRPC](#gaslimit)* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L19)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* *Inherited from [AbstractBlockRPC](#gasused)* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L20)* ___ -### hash +## hash • **hash**: *string | null* *Inherited from [AbstractBlockRPC](#hash)* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L7)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* *Inherited from [AbstractBlockRPC](#logsbloom)* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L11)* ___ -### miner +## miner • **miner**: *string* *Inherited from [AbstractBlockRPC](#miner)* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L14)* ___ -### nonce +## nonce • **nonce**: *string | null* *Inherited from [AbstractBlockRPC](#nonce)* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L9)* ___ -### number +## number • **number**: *string | null* *Inherited from [AbstractBlockRPC](#number)* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L6)* ___ -### parentHash +## parentHash • **parentHash**: *string* *Inherited from [AbstractBlockRPC](#parenthash)* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L8)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* *Inherited from [AbstractBlockRPC](#sha3uncles)* -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L10)* ___ -### size +## size • **size**: *string* *Inherited from [AbstractBlockRPC](#size)* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L18)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* *Inherited from [AbstractBlockRPC](#stateroot)* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L13)* ___ -### timestamp +## timestamp • **timestamp**: *string* *Inherited from [AbstractBlockRPC](#timestamp)* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L21)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *string* *Inherited from [AbstractBlockRPC](#totaldifficulty)* -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L16)* ___ -### transactions +## transactions • **transactions**: *string[]* -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L25)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* *Inherited from [AbstractBlockRPC](#transactionsroot)* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L12)* ___ -### uncles +## uncles • **uncles**: *string[]* *Inherited from [AbstractBlockRPC](#uncles)* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L22)*
-> # Interface: BlockWithTransactionDataRPC +# Interface: BlockWithTransactionDataRPC -## Hierarchy +### Hierarchy * [AbstractBlockRPC](#interface-abstractblockrpc) * **BlockWithTransactionDataRPC** -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *string* *Inherited from [AbstractBlockRPC](#difficulty)* -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L15)* ___ -### extraData +## extraData • **extraData**: *string* *Inherited from [AbstractBlockRPC](#extradata)* -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L17)* ___ -### gasLimit +## gasLimit • **gasLimit**: *string* *Inherited from [AbstractBlockRPC](#gaslimit)* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L19)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* *Inherited from [AbstractBlockRPC](#gasused)* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L20)* ___ -### hash +## hash • **hash**: *string | null* *Inherited from [AbstractBlockRPC](#hash)* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L7)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* *Inherited from [AbstractBlockRPC](#logsbloom)* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L11)* ___ -### miner +## miner • **miner**: *string* *Inherited from [AbstractBlockRPC](#miner)* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L14)* ___ -### nonce +## nonce • **nonce**: *string | null* *Inherited from [AbstractBlockRPC](#nonce)* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L9)* ___ -### number +## number • **number**: *string | null* *Inherited from [AbstractBlockRPC](#number)* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L6)* ___ -### parentHash +## parentHash • **parentHash**: *string* *Inherited from [AbstractBlockRPC](#parenthash)* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L8)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* *Inherited from [AbstractBlockRPC](#sha3uncles)* -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L10)* ___ -### size +## size • **size**: *string* *Inherited from [AbstractBlockRPC](#size)* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L18)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* *Inherited from [AbstractBlockRPC](#stateroot)* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L13)* ___ -### timestamp +## timestamp • **timestamp**: *string* *Inherited from [AbstractBlockRPC](#timestamp)* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L21)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *string* *Inherited from [AbstractBlockRPC](#totaldifficulty)* -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L16)* ___ -### transactions +## transactions • **transactions**: *[TransactionRPC](#interface-transactionrpc)[]* -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L28)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* *Inherited from [AbstractBlockRPC](#transactionsroot)* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L12)* ___ -### uncles +## uncles • **uncles**: *string[]* *Inherited from [AbstractBlockRPC](#uncles)* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L22)*
-> # Interface: CallDataRPC +# Interface: CallDataRPC -## Hierarchy +### Hierarchy * [CallTxDataBaseRPC](#interface-calltxdatabaserpc) * **CallDataRPC** -## Index ### Properties -* [data](#optional-data) -* [from](#optional-from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-data)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L76)* ___ -### `Optional` from +## `Optional` from • **from**? : *undefined | string* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L85)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-gas)* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L74)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-gasprice)* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L75)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-nonce)* -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L77)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-to)* -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L72)* ___ -### `Optional` value +## `Optional` value • **value**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-value)* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L73)*
-> # Interface: CallTxDataBaseRPC +# Interface: CallTxDataBaseRPC -## Hierarchy +### Hierarchy * **CallTxDataBaseRPC** @@ -1527,500 +1391,400 @@ ___ * [CallDataRPC](#interface-calldatarpc) -## Index ### Properties -* [data](#optional-data) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L76)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *undefined | string* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L74)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *undefined | string* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L75)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | string* -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L77)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L72)* ___ -### `Optional` value +## `Optional` value • **value**? : *undefined | string* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L73)*
-> # Interface: LogEntryRPC +# Interface: LogEntryRPC -## Hierarchy +### Hierarchy * **LogEntryRPC** -## Index ### Properties -* [address](#address) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L64)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L62)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L63)* ___ -### data +## data • **data**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L65)* ___ -### logIndex +## logIndex • **logIndex**: *string | null* -*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L59)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L66)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L61)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L60)*
-> # Interface: TransactionReceiptRPC +# Interface: TransactionReceiptRPC -## Hierarchy +### Hierarchy * **TransactionReceiptRPC** -## Index ### Properties -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [contractAddress](#contractaddress) -* [cumulativeGasUsed](#cumulativegasused) -* [from](#from) -* [gasUsed](#gasused) -* [logs](#logs) -* [status](#status) -* [to](#to) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### blockHash +## blockHash • **blockHash**: *string* -*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L45)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string* -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L46)* ___ -### contractAddress +## contractAddress • **contractAddress**: *string | null* -*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L54)* ___ -### cumulativeGasUsed +## cumulativeGasUsed • **cumulativeGasUsed**: *string* -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L52)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L49)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L53)* ___ -### logs +## logs • **logs**: *[LogEntryRPC](#interface-logentryrpc)[]* -*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L55)* ___ -### status +## status • **status**: *[TransactionReceiptStatusRPC](#transactionreceiptstatusrpc)* -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L51)* ___ -### to +## to • **to**: *string* -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L50)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L47)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L48)*
-> # Interface: TransactionRPC +# Interface: TransactionRPC -## Hierarchy +### Hierarchy * **TransactionRPC** -## Index ### Properties -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [from](#from) -* [gas](#gas) -* [gasPrice](#gasprice) -* [hash](#hash) -* [input](#input) -* [nonce](#nonce) -* [to](#to) -* [transactionIndex](#transactionindex) -* [value](#value) - -## Properties - -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L33)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L34)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L36)* ___ -### gas +## gas • **gas**: *string* -*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L40)* ___ -### gasPrice +## gasPrice • **gasPrice**: *string* -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L39)* ___ -### hash +## hash • **hash**: *string* -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L31)* ___ -### input +## input • **input**: *string* -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L41)* ___ -### nonce +## nonce • **nonce**: *string* -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L32)* ___ -### to +## to • **to**: *string | null* -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L37)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L35)* ___ -### value +## value • **value**: *string* -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L38)*
-> # Interface: TxDataRPC +# Interface: TxDataRPC -## Hierarchy +### Hierarchy * [CallTxDataBaseRPC](#interface-calltxdatabaserpc) * **TxDataRPC** -## Index ### Properties -* [data](#optional-data) -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-data)* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L76)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L81)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L81)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-gas)* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L74)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-gasprice)* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L75)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-nonce)* -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L77)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-to)* -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L72)* ___ -### `Optional` value +## `Optional` value • **value**? : *undefined | string* *Inherited from [CallTxDataBaseRPC](#optional-value)* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [marshaller](modules/_marshaller_.md) - * [types](modules/_types_.md) - * [types.NodeType](#class-nodetype) - * [types.Web3WrapperErrors](#class-web3wrappererrors) - * [types.AbstractBlockRPC](#class-abstractblockrpc) - * [types.BlockWithTransactionDataRPC](#class-blockwithtransactiondatarpc) - * [types.BlockWithoutTransactionDataRPC](#class-blockwithouttransactiondatarpc) - * [types.CallDataRPC](#class-calldatarpc) - * [types.CallTxDataBaseRPC](#class-calltxdatabaserpc) - * [types.LogEntryRPC](#class-logentryrpc) - * [types.TransactionRPC](#class-transactionrpc) - * [types.TransactionReceiptRPC](#class-transactionreceiptrpc) - * [types.TxDataRPC](#class-txdatarpc) - * [utils](modules/_utils_.md) - * [web3_wrapper](modules/_web3_wrapper_.md) - * [web3_wrapper.Web3Wrapper](#class-web3wrapper) -* [Classes]() - * [web3_wrapper.Web3Wrapper](#class-web3wrapper) -* [Enums]() - * [types.NodeType](#class-nodetype) - * [types.Web3WrapperErrors](#class-web3wrappererrors) -* [Interfaces]() - * [types.AbstractBlockRPC](#class-abstractblockrpc) - * [types.BlockWithTransactionDataRPC](#class-blockwithtransactiondatarpc) - * [types.BlockWithoutTransactionDataRPC](#class-blockwithouttransactiondatarpc) - * [types.CallDataRPC](#class-calldatarpc) - * [types.CallTxDataBaseRPC](#class-calltxdatabaserpc) - * [types.LogEntryRPC](#class-logentryrpc) - * [types.TransactionRPC](#class-transactionrpc) - * [types.TransactionReceiptRPC](#class-transactionreceiptrpc) - * [types.TxDataRPC](#class-txdatarpc) +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/web3-wrapper/src/types.ts#L73)*
diff --git a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/README.md b/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/README.md deleted file mode 100644 index 63fb34e636..0000000000 --- a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/README.md +++ /dev/null @@ -1,71 +0,0 @@ -## @0x/web3-wrapper - -Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript. - -### Read the [Documentation](https://0xproject.com/docs/web3-wrapper). - -## Installation - -```bash -yarn add @0x/web3-wrapper -``` - -If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: - -```json -"compilerOptions": { - "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], -} -``` - -## Contributing - -We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. - -Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. - -### Install dependencies - -If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: - -```bash -yarn config set workspaces-experimental true -``` - -Then install dependencies - -```bash -yarn install -``` - -### Build - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/web3-wrapper yarn build -``` - -Or continuously rebuild on change: - -```bash -PKG=@0x/web3-wrapper yarn watch -``` - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Run Tests - -```bash -yarn test -``` \ No newline at end of file diff --git a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/reference.mdx b/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/reference.mdx deleted file mode 100644 index fb1b2c3141..0000000000 --- a/packages/website/mdx/tools/@0x/web3-wrapper/v6.0.9/reference.mdx +++ /dev/null @@ -1,2026 +0,0 @@ -> # Class: Web3Wrapper - -An alternative to the Web3.js library that provides a consistent, clean, promise-based interface. - -## Hierarchy - -* **Web3Wrapper** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abiDecoder](#abidecoder) -* [isZeroExWeb3Wrapper](#iszeroexweb3wrapper) - -### Methods - -* [awaitTransactionMinedAsync](#awaittransactionminedasync) -* [awaitTransactionSuccessAsync](#awaittransactionsuccessasync) -* [callAsync](#callasync) -* [doesContractExistAtAddressAsync](#doescontractexistataddressasync) -* [estimateGasAsync](#estimategasasync) -* [getAvailableAddressesAsync](#getavailableaddressesasync) -* [getBalanceInWeiAsync](#getbalanceinweiasync) -* [getBlockIfExistsAsync](#getblockifexistsasync) -* [getBlockNumberAsync](#getblocknumberasync) -* [getBlockTimestampAsync](#getblocktimestampasync) -* [getBlockWithTransactionDataAsync](#getblockwithtransactiondataasync) -* [getContractCodeAsync](#getcontractcodeasync) -* [getContractDefaults](#getcontractdefaults) -* [getLogsAsync](#getlogsasync) -* [getNetworkIdAsync](#getnetworkidasync) -* [getNodeTypeAsync](#getnodetypeasync) -* [getNodeVersionAsync](#getnodeversionasync) -* [getProvider](#getprovider) -* [getTransactionByHashAsync](#gettransactionbyhashasync) -* [getTransactionReceiptIfExistsAsync](#gettransactionreceiptifexistsasync) -* [getTransactionTraceAsync](#gettransactiontraceasync) -* [increaseTimeAsync](#increasetimeasync) -* [isSenderAddressAvailableAsync](#issenderaddressavailableasync) -* [mineBlockAsync](#mineblockasync) -* [revertSnapshotAsync](#revertsnapshotasync) -* [sendRawPayloadAsync](#sendrawpayloadasync) -* [sendTransactionAsync](#sendtransactionasync) -* [setHeadAsync](#setheadasync) -* [setProvider](#setprovider) -* [signMessageAsync](#signmessageasync) -* [signTypedDataAsync](#signtypeddataasync) -* [takeSnapshotAsync](#takesnapshotasync) -* [isAddress](#static-isaddress) -* [toBaseUnitAmount](#static-tobaseunitamount) -* [toUnitAmount](#static-tounitamount) -* [toWei](#static-towei) - -## Constructors - -### constructor - -\+ **new Web3Wrapper**(`supportedProvider`: `SupportedProvider`, `callAndTxnDefaults`: `Partial`): *[Web3Wrapper](#class-web3wrapper)* - -*Defined in [web3_wrapper.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L145)* - -Instantiates a new Web3Wrapper. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`supportedProvider` | `SupportedProvider` | - | - | -`callAndTxnDefaults` | `Partial` | {} | Override Call and Txn Data defaults sent with RPC requests to the backing Ethereum node. | - -**Returns:** *[Web3Wrapper](#class-web3wrapper)* - -An instance of the Web3Wrapper class. - -## Properties - -### abiDecoder - -• **abiDecoder**: *`AbiDecoder`* - -*Defined in [web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L54)* - -___ - -### isZeroExWeb3Wrapper - -• **isZeroExWeb3Wrapper**: *boolean* = true - -*Defined in [web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L53)* - -Flag to check if this instance is of type Web3Wrapper - -## Methods - -### awaitTransactionMinedAsync - -▸ **awaitTransactionMinedAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* - -*Defined in [web3_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L568)* - -Waits for a transaction to be mined and returns the transaction receipt. -Note that just because a transaction was mined does not mean it was -successful. You need to check the status code of the transaction receipt -to find out if it was successful, or use the helper method -awaitTransactionSuccessAsync. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`txHash` | string | - | Transaction hash | -`pollingIntervalMs` | number | 1000 | How often (in ms) should we check if the transaction is mined. | -`timeoutMs?` | undefined \| number | - | How long (in ms) to poll for transaction mined until aborting. | - -**Returns:** *`Promise`* - -Transaction receipt with decoded log args. - -___ - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* - -*Defined in [web3_wrapper.ts:643](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L643)* - -Waits for a transaction to be mined and returns the transaction receipt. -Unlike awaitTransactionMinedAsync, it will throw if the receipt has a -status that is not equal to 1. A status of 0 or null indicates that the -transaction was mined, but failed. See: -https://github.com/ethereum/wiki/wiki/JavaScript-API#web3ethgettransactionreceipt - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`txHash` | string | - | Transaction hash | -`pollingIntervalMs` | number | 1000 | How often (in ms) should we check if the transaction is mined. | -`timeoutMs?` | undefined \| number | - | How long (in ms) to poll for transaction mined until aborting. | - -**Returns:** *`Promise`* - -Transaction receipt with decoded log args. - -___ - -### callAsync - -▸ **callAsync**(`callData`: `CallData`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:525](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L525)* - -Call a smart contract method at a given block height - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`callData` | `CallData` | Call data | -`defaultBlock?` | `BlockParam` | Block height at which to make the call. Defaults to `latest` | - -**Returns:** *`Promise`* - -The raw call result - -___ - -### doesContractExistAtAddressAsync - -▸ **doesContractExistAtAddressAsync**(`address`: string): *`Promise`* - -*Defined in [web3_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L273)* - -Check if a contract exists at a given address - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address to which to check | - -**Returns:** *`Promise`* - -Whether or not contract code was found at the supplied address - -___ - -### estimateGasAsync - -▸ **estimateGasAsync**(`txData`: `Partial`): *`Promise`* - -*Defined in [web3_wrapper.ts:508](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L508)* - -Calculate the estimated gas cost for a given transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txData` | `Partial` | Transaction data | - -**Returns:** *`Promise`* - -Estimated gas cost - -___ - -### getAvailableAddressesAsync - -▸ **getAvailableAddressesAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:421](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L421)* - -Retrieve the user addresses available through the backing provider - -**Returns:** *`Promise`* - -Available user addresses - -___ - -### getBalanceInWeiAsync - -▸ **getBalanceInWeiAsync**(`owner`: string, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:254](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L254)* - -Retrieves an accounts Ether balance in wei - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`owner` | string | Account whose balance you wish to check | -`defaultBlock?` | `BlockParam` | The block depth at which to fetch the balance (default=latest) | - -**Returns:** *`Promise`* - -Balance in wei - -___ - -### getBlockIfExistsAsync - -▸ **getBlockIfExistsAsync**(`blockParam`: string | `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:361](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L361)* - -Fetch a specific Ethereum block without transaction data - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | - -**Returns:** *`Promise`* - -The requested block without transaction data, or undefined if block was not found -(e.g the node isn't fully synced, there was a block re-org and the requested block was uncles, etc...) - -___ - -### getBlockNumberAsync - -▸ **getBlockNumberAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:347](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L347)* - -Fetches the latest block number - -**Returns:** *`Promise`* - -Block number - -___ - -### getBlockTimestampAsync - -▸ **getBlockTimestampAsync**(`blockParam`: string | `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L409)* - -Fetch a block's timestamp - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | - -**Returns:** *`Promise`* - -The block's timestamp - -___ - -### getBlockWithTransactionDataAsync - -▸ **getBlockWithTransactionDataAsync**(`blockParam`: string | `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L387)* - -Fetch a specific Ethereum block with transaction data - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`blockParam` | string \| `BlockParam` | The block you wish to fetch (blockHash, blockNumber or blockLiteral) | - -**Returns:** *`Promise`* - -The requested block with transaction data - -___ - -### getContractCodeAsync - -▸ **getContractCodeAsync**(`address`: string, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [web3_wrapper.ts:286](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L286)* - -Gets the contract code by address - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of the contract | -`defaultBlock?` | `BlockParam` | Block height at which to make the call. Defaults to `latest` | - -**Returns:** *`Promise`* - -Code of the contract - -___ - -### getContractDefaults - -▸ **getContractDefaults**(): *`Partial` | undefined* - -*Defined in [web3_wrapper.ts:164](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L164)* - -Get the contract defaults set to the Web3Wrapper instance - -**Returns:** *`Partial` | undefined* - -CallAndTxnData defaults (e.g gas, gasPrice, nonce, etc...) - -___ - -### getLogsAsync - -▸ **getLogsAsync**(`filter`: `FilterObject`): *`Promise`* - -*Defined in [web3_wrapper.ts:475](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L475)* - -Retrieve smart contract logs for a given filter - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`filter` | `FilterObject` | Parameters by which to filter which logs to retrieve | - -**Returns:** *`Promise`* - -The corresponding log entries - -___ - -### getNetworkIdAsync - -▸ **getNetworkIdAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L207)* - -Fetches the networkId of the backing Ethereum node - -**Returns:** *`Promise`* - -The network id - -___ - -### getNodeTypeAsync - -▸ **getNodeTypeAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:690](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L690)* - -Returns either NodeType.Geth or NodeType.Ganache depending on the type of -the backing Ethereum node. Throws for any other type of node. - -**Returns:** *`Promise`* - -___ - -### getNodeVersionAsync - -▸ **getNodeVersionAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L199)* - -Fetch the backing Ethereum node's version string (e.g `MetaMask/v4.2.0`) - -**Returns:** *`Promise`* - -Ethereum node's version string - -___ - -### getProvider - -▸ **getProvider**(): *`SupportedProvider`* - -*Defined in [web3_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L171)* - -Retrieve the Web3 provider - -**Returns:** *`SupportedProvider`* - -Web3 provider instance - -___ - -### getTransactionByHashAsync - -▸ **getTransactionByHashAsync**(`txHash`: string): *`Promise`* - -*Defined in [web3_wrapper.ts:239](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L239)* - -Retrieves the transaction data for a given transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txHash` | string | Transaction hash | - -**Returns:** *`Promise`* - -The raw transaction data - -___ - -### getTransactionReceiptIfExistsAsync - -▸ **getTransactionReceiptIfExistsAsync**(`txHash`: string): *`Promise`* - -*Defined in [web3_wrapper.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L217)* - -Retrieves the transaction receipt for a given transaction hash if found - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txHash` | string | Transaction hash | - -**Returns:** *`Promise`* - -The transaction receipt, including it's status (0: failed, 1: succeeded). Returns undefined if transaction not found. - -___ - -### getTransactionTraceAsync - -▸ **getTransactionTraceAsync**(`txHash`: string, `traceParams`: `TraceParams`): *`Promise`* - -*Defined in [web3_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L305)* - -Gets the debug trace of a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txHash` | string | Hash of the transactuon to get a trace for | -`traceParams` | `TraceParams` | Config object allowing you to specify if you need memory/storage/stack traces. | - -**Returns:** *`Promise`* - -Transaction trace - -___ - -### increaseTimeAsync - -▸ **increaseTimeAsync**(`timeDelta`: number): *`Promise`* - -*Defined in [web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L458)* - -Increase the next blocks timestamp on TestRPC/Ganache or Geth local node. -Will throw if provider is neither TestRPC/Ganache or Geth. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`timeDelta` | number | Amount of time to add in seconds | - -**Returns:** *`Promise`* - -___ - -### isSenderAddressAvailableAsync - -▸ **isSenderAddressAvailableAsync**(`senderAddress`: string): *`Promise`* - -*Defined in [web3_wrapper.ts:189](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L189)* - -Check whether an address is available through the backing provider. This can be -useful if you want to know whether a user can sign messages or transactions from -a given Ethereum address. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`senderAddress` | string | Address to check availability for | - -**Returns:** *`Promise`* - -Whether the address is available through the provider. - -___ - -### mineBlockAsync - -▸ **mineBlockAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L450)* - -Mine a block on a TestRPC/Ganache local node - -**Returns:** *`Promise`* - -___ - -### revertSnapshotAsync - -▸ **revertSnapshotAsync**(`snapshotId`: number): *`Promise`* - -*Defined in [web3_wrapper.ts:442](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L442)* - -Revert the blockchain state to a previous snapshot state on TestRPC/Ganache local node - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`snapshotId` | number | snapshot id to revert to | - -**Returns:** *`Promise`* - -Whether the revert was successful - -___ - -### sendRawPayloadAsync - -▸ **sendRawPayloadAsync**<**A**>(`payload`: `Partial`): *`Promise`* - -*Defined in [web3_wrapper.ts:671](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L671)* - -Sends a raw Ethereum JSON RPC payload and returns the response's `result` key - -**Type parameters:** - -▪ **A** - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | A partial JSON RPC payload. No need to include version, id, params (if none needed) | - -**Returns:** *`Promise`* - -The contents nested under the result key of the response body - -___ - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`txData`: `TxData`): *`Promise`* - -*Defined in [web3_wrapper.ts:547](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L547)* - -Send a transaction - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`txData` | `TxData` | Transaction data | - -**Returns:** *`Promise`* - -Transaction hash - -___ - -### setHeadAsync - -▸ **setHeadAsync**(`blockNumber`: number): *`Promise`* - -*Defined in [web3_wrapper.ts:662](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L662)* - -Calls the 'debug_setHead' JSON RPC method, which sets the current head of -the local chain by block number. Note, this is a destructive action and -may severely damage your chain. Use with extreme caution. As of now, this -is only supported by Geth. It sill throw if the 'debug_setHead' method is -not supported. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`blockNumber` | number | The block number to reset to. | - -**Returns:** *`Promise`* - -___ - -### setProvider - -▸ **setProvider**(`supportedProvider`: `SupportedProvider`): *void* - -*Defined in [web3_wrapper.ts:178](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L178)* - -Update the used Web3 provider - -**Parameters:** - -Name | Type | ------- | ------ | -`supportedProvider` | `SupportedProvider` | - -**Returns:** *void* - -___ - -### signMessageAsync - -▸ **signMessageAsync**(`address`: string, `message`: string): *`Promise`* - -*Defined in [web3_wrapper.ts:319](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L319)* - -Sign a message with a specific address's private key (`eth_sign`) - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of signer | -`message` | string | Message to sign | - -**Returns:** *`Promise`* - -Signature string (might be VRS or RSV depending on the Signer) - -___ - -### signTypedDataAsync - -▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* - -*Defined in [web3_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L334)* - -Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`) - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address of signer | -`typedData` | any | Typed data message to sign | - -**Returns:** *`Promise`* - -Signature string (as RSV) - -___ - -### takeSnapshotAsync - -▸ **takeSnapshotAsync**(): *`Promise`* - -*Defined in [web3_wrapper.ts:433](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L433)* - -Take a snapshot of the blockchain state on a TestRPC/Ganache local node - -**Returns:** *`Promise`* - -The snapshot id. This can be used to revert to this snapshot - -___ - -### `Static` isAddress - -▸ **isAddress**(`address`: string): *boolean* - -*Defined in [web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L65)* - -Check if an address is a valid Ethereum address - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`address` | string | Address to check | - -**Returns:** *boolean* - -Whether the address is a valid Ethereum address - -___ - -### `Static` toBaseUnitAmount - -▸ **toBaseUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* - -*Defined in [web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L91)* - -A baseUnit is defined as the smallest denomination of a token. An amount expressed in baseUnits -is the amount expressed in the smallest denomination. -E.g: 1 unit of a token with 18 decimal places is expressed in baseUnits as 1000000000000000000 - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`amount` | `BigNumber` | The amount of units that you would like converted to baseUnits. | -`decimals` | number | The number of decimal places the unit amount has. | - -**Returns:** *`BigNumber`* - -The amount in baseUnits. - -___ - -### `Static` toUnitAmount - -▸ **toUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* - -*Defined in [web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L76)* - -A unit amount is defined as the amount of a token above the specified decimal places (integer part). -E.g: If a currency has 18 decimal places, 1e18 or one quintillion of the currency is equivalent -to 1 unit. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`amount` | `BigNumber` | The amount in baseUnits that you would like converted to units. | -`decimals` | number | The number of decimal places the unit amount has. | - -**Returns:** *`BigNumber`* - -The amount in units. - -___ - -### `Static` toWei - -▸ **toWei**(`ethAmount`: `BigNumber`): *`BigNumber`* - -*Defined in [web3_wrapper.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/web3_wrapper.ts#L107)* - -Convert an Ether amount from ETH to Wei - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`ethAmount` | `BigNumber` | Amount of Ether to convert to wei | - -**Returns:** *`BigNumber`* - -Amount in wei - -
- -> # Enumeration: NodeType - -## Index - -### Enumeration members - -* [Ganache](#ganache) -* [Geth](#geth) - -## Enumeration members - -### Ganache - -• **Ganache**: = "GANACHE" - -*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L91)* - -___ - -### Geth - -• **Geth**: = "GETH" - -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L90)* - -
- -> # Enumeration: Web3WrapperErrors - -## Index - -### Enumeration members - -* [TransactionMiningTimeout](#transactionminingtimeout) - -## Enumeration members - -### TransactionMiningTimeout - -• **TransactionMiningTimeout**: = "TRANSACTION_MINING_TIMEOUT" - -*Defined in [types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L2)* - -
- -> # Interface: AbstractBlockRPC - -## Hierarchy - -* **AbstractBlockRPC** - - * [BlockWithoutTransactionDataRPC](#interface-blockwithouttransactiondatarpc) - - * [BlockWithTransactionDataRPC](#interface-blockwithtransactiondatarpc) - -## Index - -### Properties - -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty - -• **difficulty**: *string* - -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* - -___ - -### extraData - -• **extraData**: *string* - -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* - -___ - -### gasLimit - -• **gasLimit**: *string* - -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* - -___ - -### gasUsed - -• **gasUsed**: *string* - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* - -___ - -### hash - -• **hash**: *string | null* - -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* - -___ - -### logsBloom - -• **logsBloom**: *string | null* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* - -___ - -### miner - -• **miner**: *string* - -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* - -___ - -### nonce - -• **nonce**: *string | null* - -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* - -___ - -### number - -• **number**: *string | null* - -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* - -___ - -### parentHash - -• **parentHash**: *string* - -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* - -___ - -### sha3Uncles - -• **sha3Uncles**: *string* - -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* - -___ - -### size - -• **size**: *string* - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* - -___ - -### stateRoot - -• **stateRoot**: *string* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* - -___ - -### timestamp - -• **timestamp**: *string* - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* - -___ - -### totalDifficulty - -• **totalDifficulty**: *string* - -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* - -___ - -### transactionsRoot - -• **transactionsRoot**: *string* - -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* - -___ - -### uncles - -• **uncles**: *string[]* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* - -
- -> # Interface: BlockWithoutTransactionDataRPC - -## Hierarchy - -* [AbstractBlockRPC](#interface-abstractblockrpc) - - * **BlockWithoutTransactionDataRPC** - -## Index - -### Properties - -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty - -• **difficulty**: *string* - -*Inherited from [AbstractBlockRPC](#difficulty)* - -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* - -___ - -### extraData - -• **extraData**: *string* - -*Inherited from [AbstractBlockRPC](#extradata)* - -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* - -___ - -### gasLimit - -• **gasLimit**: *string* - -*Inherited from [AbstractBlockRPC](#gaslimit)* - -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* - -___ - -### gasUsed - -• **gasUsed**: *string* - -*Inherited from [AbstractBlockRPC](#gasused)* - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* - -___ - -### hash - -• **hash**: *string | null* - -*Inherited from [AbstractBlockRPC](#hash)* - -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* - -___ - -### logsBloom - -• **logsBloom**: *string | null* - -*Inherited from [AbstractBlockRPC](#logsbloom)* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* - -___ - -### miner - -• **miner**: *string* - -*Inherited from [AbstractBlockRPC](#miner)* - -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* - -___ - -### nonce - -• **nonce**: *string | null* - -*Inherited from [AbstractBlockRPC](#nonce)* - -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* - -___ - -### number - -• **number**: *string | null* - -*Inherited from [AbstractBlockRPC](#number)* - -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* - -___ - -### parentHash - -• **parentHash**: *string* - -*Inherited from [AbstractBlockRPC](#parenthash)* - -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* - -___ - -### sha3Uncles - -• **sha3Uncles**: *string* - -*Inherited from [AbstractBlockRPC](#sha3uncles)* - -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* - -___ - -### size - -• **size**: *string* - -*Inherited from [AbstractBlockRPC](#size)* - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* - -___ - -### stateRoot - -• **stateRoot**: *string* - -*Inherited from [AbstractBlockRPC](#stateroot)* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* - -___ - -### timestamp - -• **timestamp**: *string* - -*Inherited from [AbstractBlockRPC](#timestamp)* - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* - -___ - -### totalDifficulty - -• **totalDifficulty**: *string* - -*Inherited from [AbstractBlockRPC](#totaldifficulty)* - -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* - -___ - -### transactions - -• **transactions**: *string[]* - -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L25)* - -___ - -### transactionsRoot - -• **transactionsRoot**: *string* - -*Inherited from [AbstractBlockRPC](#transactionsroot)* - -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* - -___ - -### uncles - -• **uncles**: *string[]* - -*Inherited from [AbstractBlockRPC](#uncles)* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* - -
- -> # Interface: BlockWithTransactionDataRPC - -## Hierarchy - -* [AbstractBlockRPC](#interface-abstractblockrpc) - - * **BlockWithTransactionDataRPC** - -## Index - -### Properties - -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty - -• **difficulty**: *string* - -*Inherited from [AbstractBlockRPC](#difficulty)* - -*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L15)* - -___ - -### extraData - -• **extraData**: *string* - -*Inherited from [AbstractBlockRPC](#extradata)* - -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L17)* - -___ - -### gasLimit - -• **gasLimit**: *string* - -*Inherited from [AbstractBlockRPC](#gaslimit)* - -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L19)* - -___ - -### gasUsed - -• **gasUsed**: *string* - -*Inherited from [AbstractBlockRPC](#gasused)* - -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L20)* - -___ - -### hash - -• **hash**: *string | null* - -*Inherited from [AbstractBlockRPC](#hash)* - -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L7)* - -___ - -### logsBloom - -• **logsBloom**: *string | null* - -*Inherited from [AbstractBlockRPC](#logsbloom)* - -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L11)* - -___ - -### miner - -• **miner**: *string* - -*Inherited from [AbstractBlockRPC](#miner)* - -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L14)* - -___ - -### nonce - -• **nonce**: *string | null* - -*Inherited from [AbstractBlockRPC](#nonce)* - -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L9)* - -___ - -### number - -• **number**: *string | null* - -*Inherited from [AbstractBlockRPC](#number)* - -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L6)* - -___ - -### parentHash - -• **parentHash**: *string* - -*Inherited from [AbstractBlockRPC](#parenthash)* - -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L8)* - -___ - -### sha3Uncles - -• **sha3Uncles**: *string* - -*Inherited from [AbstractBlockRPC](#sha3uncles)* - -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L10)* - -___ - -### size - -• **size**: *string* - -*Inherited from [AbstractBlockRPC](#size)* - -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L18)* - -___ - -### stateRoot - -• **stateRoot**: *string* - -*Inherited from [AbstractBlockRPC](#stateroot)* - -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L13)* - -___ - -### timestamp - -• **timestamp**: *string* - -*Inherited from [AbstractBlockRPC](#timestamp)* - -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L21)* - -___ - -### totalDifficulty - -• **totalDifficulty**: *string* - -*Inherited from [AbstractBlockRPC](#totaldifficulty)* - -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L16)* - -___ - -### transactions - -• **transactions**: *[TransactionRPC](#interface-transactionrpc)[]* - -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L28)* - -___ - -### transactionsRoot - -• **transactionsRoot**: *string* - -*Inherited from [AbstractBlockRPC](#transactionsroot)* - -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L12)* - -___ - -### uncles - -• **uncles**: *string[]* - -*Inherited from [AbstractBlockRPC](#uncles)* - -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L22)* - -
- -> # Interface: CallDataRPC - -## Hierarchy - -* [CallTxDataBaseRPC](#interface-calltxdatabaserpc) - - * **CallDataRPC** - -## Index - -### Properties - -* [data](#optional-data) -* [from](#optional-from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-data)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* - -___ - -### `Optional` from - -• **from**? : *undefined | string* - -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L85)* - -___ - -### `Optional` gas - -• **gas**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-gas)* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-gasprice)* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-nonce)* - -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-to)* - -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* - -___ - -### `Optional` value - -• **value**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-value)* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* - -
- -> # Interface: CallTxDataBaseRPC - -## Hierarchy - -* **CallTxDataBaseRPC** - - * [TxDataRPC](#interface-txdatarpc) - - * [CallDataRPC](#interface-calldatarpc) - -## Index - -### Properties - -* [data](#optional-data) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* - -___ - -### `Optional` gas - -• **gas**? : *undefined | string* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *undefined | string* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | string* - -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* - -___ - -### `Optional` value - -• **value**? : *undefined | string* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* - -
- -> # Interface: LogEntryRPC - -## Hierarchy - -* **LogEntryRPC** - -## Index - -### Properties - -* [address](#address) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address - -• **address**: *string* - -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L64)* - -___ - -### blockHash - -• **blockHash**: *string | null* - -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L62)* - -___ - -### blockNumber - -• **blockNumber**: *string | null* - -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L63)* - -___ - -### data - -• **data**: *string* - -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L65)* - -___ - -### logIndex - -• **logIndex**: *string | null* - -*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L59)* - -___ - -### topics - -• **topics**: *string[]* - -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L66)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L61)* - -___ - -### transactionIndex - -• **transactionIndex**: *string | null* - -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L60)* - -
- -> # Interface: TransactionReceiptRPC - -## Hierarchy - -* **TransactionReceiptRPC** - -## Index - -### Properties - -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [contractAddress](#contractaddress) -* [cumulativeGasUsed](#cumulativegasused) -* [from](#from) -* [gasUsed](#gasused) -* [logs](#logs) -* [status](#status) -* [to](#to) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### blockHash - -• **blockHash**: *string* - -*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L45)* - -___ - -### blockNumber - -• **blockNumber**: *string* - -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L46)* - -___ - -### contractAddress - -• **contractAddress**: *string | null* - -*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L54)* - -___ - -### cumulativeGasUsed - -• **cumulativeGasUsed**: *string* - -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L52)* - -___ - -### from - -• **from**: *string* - -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L49)* - -___ - -### gasUsed - -• **gasUsed**: *string* - -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L53)* - -___ - -### logs - -• **logs**: *[LogEntryRPC](#interface-logentryrpc)[]* - -*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L55)* - -___ - -### status - -• **status**: *[TransactionReceiptStatusRPC](#transactionreceiptstatusrpc)* - -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L51)* - -___ - -### to - -• **to**: *string* - -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L50)* - -___ - -### transactionHash - -• **transactionHash**: *string* - -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L47)* - -___ - -### transactionIndex - -• **transactionIndex**: *string* - -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L48)* - -
- -> # Interface: TransactionRPC - -## Hierarchy - -* **TransactionRPC** - -## Index - -### Properties - -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [from](#from) -* [gas](#gas) -* [gasPrice](#gasprice) -* [hash](#hash) -* [input](#input) -* [nonce](#nonce) -* [to](#to) -* [transactionIndex](#transactionindex) -* [value](#value) - -## Properties - -### blockHash - -• **blockHash**: *string | null* - -*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L33)* - -___ - -### blockNumber - -• **blockNumber**: *string | null* - -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L34)* - -___ - -### from - -• **from**: *string* - -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L36)* - -___ - -### gas - -• **gas**: *string* - -*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L40)* - -___ - -### gasPrice - -• **gasPrice**: *string* - -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L39)* - -___ - -### hash - -• **hash**: *string* - -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L31)* - -___ - -### input - -• **input**: *string* - -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L41)* - -___ - -### nonce - -• **nonce**: *string* - -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L32)* - -___ - -### to - -• **to**: *string | null* - -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L37)* - -___ - -### transactionIndex - -• **transactionIndex**: *string | null* - -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L35)* - -___ - -### value - -• **value**: *string* - -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L38)* - -
- -> # Interface: TxDataRPC - -## Hierarchy - -* [CallTxDataBaseRPC](#interface-calltxdatabaserpc) - - * **TxDataRPC** - -## Index - -### Properties - -* [data](#optional-data) -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data - -• **data**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-data)* - -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L76)* - -___ - -### from - -• **from**: *string* - -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L81)* - -___ - -### `Optional` gas - -• **gas**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-gas)* - -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L74)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-gasprice)* - -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L75)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-nonce)* - -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L77)* - -___ - -### `Optional` to - -• **to**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-to)* - -*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L72)* - -___ - -### `Optional` value - -• **value**? : *undefined | string* - -*Inherited from [CallTxDataBaseRPC](#optional-value)* - -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/web3-wrapper/src/types.ts#L73)* - -
- -* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [marshaller](modules/_marshaller_.md) - * [types](modules/_types_.md) - * [types.NodeType](#class-nodetype) - * [types.Web3WrapperErrors](#class-web3wrappererrors) - * [types.AbstractBlockRPC](#class-abstractblockrpc) - * [types.BlockWithTransactionDataRPC](#class-blockwithtransactiondatarpc) - * [types.BlockWithoutTransactionDataRPC](#class-blockwithouttransactiondatarpc) - * [types.CallDataRPC](#class-calldatarpc) - * [types.CallTxDataBaseRPC](#class-calltxdatabaserpc) - * [types.LogEntryRPC](#class-logentryrpc) - * [types.TransactionRPC](#class-transactionrpc) - * [types.TransactionReceiptRPC](#class-transactionreceiptrpc) - * [types.TxDataRPC](#class-txdatarpc) - * [utils](modules/_utils_.md) - * [web3_wrapper](modules/_web3_wrapper_.md) - * [web3_wrapper.Web3Wrapper](#class-web3wrapper) -* [Classes]() - * [web3_wrapper.Web3Wrapper](#class-web3wrapper) -* [Enums]() - * [types.NodeType](#class-nodetype) - * [types.Web3WrapperErrors](#class-web3wrappererrors) -* [Interfaces]() - * [types.AbstractBlockRPC](#class-abstractblockrpc) - * [types.BlockWithTransactionDataRPC](#class-blockwithtransactiondatarpc) - * [types.BlockWithoutTransactionDataRPC](#class-blockwithouttransactiondatarpc) - * [types.CallDataRPC](#class-calldatarpc) - * [types.CallTxDataBaseRPC](#class-calltxdatabaserpc) - * [types.LogEntryRPC](#class-logentryrpc) - * [types.TransactionRPC](#class-transactionrpc) - * [types.TransactionReceiptRPC](#class-transactionreceiptrpc) - * [types.TxDataRPC](#class-txdatarpc) - -
- diff --git a/packages/website/mdx/tools/ethereum-types/v2.1.4/reference.mdx b/packages/website/mdx/tools/ethereum-types/v2.1.4/reference.mdx index d3f030ccb5..ba4bff1bfb 100644 --- a/packages/website/mdx/tools/ethereum-types/v2.1.4/reference.mdx +++ b/packages/website/mdx/tools/ethereum-types/v2.1.4/reference.mdx @@ -1,1392 +1,1226 @@ -> # Enumeration: AbiType +# Enumeration: AbiType -## Index ### Enumeration members -* [Constructor](#constructor) -* [Event](#event) -* [Fallback](#fallback) -* [Function](#function) - -## Enumeration members - -### Constructor +## Constructor • **Constructor**: = "constructor" -*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L455)* ___ -### Event +## Event • **Event**: = "event" -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L456)* ___ -### Fallback +## Fallback • **Fallback**: = "fallback" -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L457)* ___ -### Function +## Function • **Function**: = "function" -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L454)*
-> # Enumeration: BlockParamLiteral +# Enumeration: BlockParamLiteral -## Index ### Enumeration members -* [Earliest](#earliest) -* [Latest](#latest) -* [Pending](#pending) - -## Enumeration members - -### Earliest +## Earliest • **Earliest**: = "earliest" -*Defined in [index.ts:470](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L470)* +*Defined in [index.ts:470](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L470)* ___ -### Latest +## Latest • **Latest**: = "latest" -*Defined in [index.ts:471](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L471)* +*Defined in [index.ts:471](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L471)* ___ -### Pending +## Pending • **Pending**: = "pending" -*Defined in [index.ts:472](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L472)* +*Defined in [index.ts:472](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L472)*
-> # Enumeration: OpCode +# Enumeration: OpCode -## Index ### Enumeration members -* [Add](#add) -* [AddMod](#addmod) -* [Address](#address) -* [And](#and) -* [Balance](#balance) -* [BlockHash](#blockhash) -* [Byte](#byte) -* [Call](#call) -* [CallCode](#callcode) -* [CallDataCopy](#calldatacopy) -* [CallDataLoad](#calldataload) -* [CallDataSize](#calldatasize) -* [CallValue](#callvalue) -* [Caller](#caller) -* [CodeCopy](#codecopy) -* [CodeSize](#codesize) -* [Coinbase](#coinbase) -* [Create](#create) -* [DelegateCall](#delegatecall) -* [Difficulty](#difficulty) -* [Div](#div) -* [Dup1](#dup1) -* [Dup10](#dup10) -* [Dup11](#dup11) -* [Dup12](#dup12) -* [Dup13](#dup13) -* [Dup14](#dup14) -* [Dup15](#dup15) -* [Dup16](#dup16) -* [Dup2](#dup2) -* [Dup3](#dup3) -* [Dup4](#dup4) -* [Dup5](#dup5) -* [Dup6](#dup6) -* [Dup7](#dup7) -* [Dup8](#dup8) -* [Dup9](#dup9) -* [Eq](#eq) -* [Exp](#exp) -* [ExtCodeCopy](#extcodecopy) -* [ExtCodeSize](#extcodesize) -* [Gas](#gas) -* [GasPrice](#gasprice) -* [Gaslimit](#gaslimit) -* [Gt](#gt) -* [Invalid](#invalid) -* [IsZero](#iszero) -* [Jump](#jump) -* [JumpDest](#jumpdest) -* [Jumpi](#jumpi) -* [Log1](#log1) -* [Log2](#log2) -* [Log3](#log3) -* [Log4](#log4) -* [Lt](#lt) -* [MLoad](#mload) -* [MSize](#msize) -* [MStore](#mstore) -* [MStore8](#mstore8) -* [Mod](#mod) -* [Mul](#mul) -* [MulMod](#mulmod) -* [Not](#not) -* [Number](#number) -* [Or](#or) -* [Origin](#origin) -* [Pc](#pc) -* [Pop](#pop) -* [Push1](#push1) -* [Push10](#push10) -* [Push11](#push11) -* [Push12](#push12) -* [Push13](#push13) -* [Push14](#push14) -* [Push15](#push15) -* [Push16](#push16) -* [Push17](#push17) -* [Push18](#push18) -* [Push19](#push19) -* [Push2](#push2) -* [Push20](#push20) -* [Push21](#push21) -* [Push22](#push22) -* [Push23](#push23) -* [Push24](#push24) -* [Push25](#push25) -* [Push26](#push26) -* [Push27](#push27) -* [Push28](#push28) -* [Push29](#push29) -* [Push3](#push3) -* [Push30](#push30) -* [Push31](#push31) -* [Push32](#push32) -* [Push4](#push4) -* [Push5](#push5) -* [Push6](#push6) -* [Push7](#push7) -* [Push8](#push8) -* [Push9](#push9) -* [Return](#return) -* [ReturnDataCopy](#returndatacopy) -* [ReturnDataSize](#returndatasize) -* [Revert](#revert) -* [SDiv](#sdiv) -* [SGt](#sgt) -* [SLoad](#sload) -* [SLt](#slt) -* [SMod](#smod) -* [SStore](#sstore) -* [SelfDestruct](#selfdestruct) -* [Sha3](#sha3) -* [SignExtend](#signextend) -* [StaticCall](#staticcall) -* [Stop](#stop) -* [Sub](#sub) -* [Swap1](#swap1) -* [Swap10](#swap10) -* [Swap11](#swap11) -* [Swap12](#swap12) -* [Swap13](#swap13) -* [Swap14](#swap14) -* [Swap15](#swap15) -* [Swap16](#swap16) -* [Swap2](#swap2) -* [Swap3](#swap3) -* [Swap4](#swap4) -* [Swap5](#swap5) -* [Swap6](#swap6) -* [Swap7](#swap7) -* [Swap8](#swap8) -* [Swap9](#swap9) -* [TimeStamp](#timestamp) -* [Xor](#xor) - -## Enumeration members - -### Add +## Add • **Add**: = "ADD" -*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L141)* +*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L141)* ___ -### AddMod +## AddMod • **AddMod**: = "ADDMOD" -*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L148)* +*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L148)* ___ -### Address +## Address • **Address**: = "ADDRESS" -*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L167)* +*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L167)* ___ -### And +## And • **And**: = "AND" -*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L159)* +*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L159)* ___ -### Balance +## Balance • **Balance**: = "BALANCE" -*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L168)* +*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L168)* ___ -### BlockHash +## BlockHash • **BlockHash**: = "BLOCKHASH" -*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L183)* +*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L183)* ___ -### Byte +## Byte • **Byte**: = "BYTE" -*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L163)* +*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L163)* ___ -### Call +## Call • **Call**: = "CALL" -*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L276)* +*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L276)* ___ -### CallCode +## CallCode • **CallCode**: = "CALLCODE" -*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L277)* +*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L277)* ___ -### CallDataCopy +## CallDataCopy • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L174)* +*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L174)* ___ -### CallDataLoad +## CallDataLoad • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [index.ts:172](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L172)* +*Defined in [index.ts:172](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L172)* ___ -### CallDataSize +## CallDataSize • **CallDataSize**: = "CALLDATASIZE" -*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L173)* +*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L173)* ___ -### CallValue +## CallValue • **CallValue**: = "CALLVALUE" -*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L171)* +*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L171)* ___ -### Caller +## Caller • **Caller**: = "CALLER" -*Defined in [index.ts:170](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L170)* +*Defined in [index.ts:170](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L170)* ___ -### CodeCopy +## CodeCopy • **CodeCopy**: = "CODECOPY" -*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L176)* +*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L176)* ___ -### CodeSize +## CodeSize • **CodeSize**: = "CODESIZE" -*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L175)* +*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L175)* ___ -### Coinbase +## Coinbase • **Coinbase**: = "COINBASE" -*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L184)* +*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L184)* ___ -### Create +## Create • **Create**: = "CREATE" -*Defined in [index.ts:275](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L275)* +*Defined in [index.ts:275](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L275)* ___ -### DelegateCall +## DelegateCall • **DelegateCall**: = "DELEGATECALL" -*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L279)* +*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L279)* ___ -### Difficulty +## Difficulty • **Difficulty**: = "DIFFICULTY" -*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L187)* +*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L187)* ___ -### Div +## Div • **Div**: = "DIV" -*Defined in [index.ts:144](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L144)* +*Defined in [index.ts:144](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L144)* ___ -### Dup1 +## Dup1 • **Dup1**: = "DUP1" -*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L236)* +*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L236)* ___ -### Dup10 +## Dup10 • **Dup10**: = "DUP10" -*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L245)* +*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L245)* ___ -### Dup11 +## Dup11 • **Dup11**: = "DUP11" -*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L246)* +*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L246)* ___ -### Dup12 +## Dup12 • **Dup12**: = "DUP12" -*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L247)* +*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L247)* ___ -### Dup13 +## Dup13 • **Dup13**: = "DUP13" -*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L248)* +*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L248)* ___ -### Dup14 +## Dup14 • **Dup14**: = "DUP14" -*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L249)* +*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L249)* ___ -### Dup15 +## Dup15 • **Dup15**: = "DUP15" -*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L250)* +*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L250)* ___ -### Dup16 +## Dup16 • **Dup16**: = "DUP16" -*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L251)* +*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L251)* ___ -### Dup2 +## Dup2 • **Dup2**: = "DUP2" -*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L237)* +*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L237)* ___ -### Dup3 +## Dup3 • **Dup3**: = "DUP3" -*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L238)* +*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L238)* ___ -### Dup4 +## Dup4 • **Dup4**: = "DUP4" -*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L239)* +*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L239)* ___ -### Dup5 +## Dup5 • **Dup5**: = "DUP5" -*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L240)* +*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L240)* ___ -### Dup6 +## Dup6 • **Dup6**: = "DUP6" -*Defined in [index.ts:241](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L241)* +*Defined in [index.ts:241](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L241)* ___ -### Dup7 +## Dup7 • **Dup7**: = "DUP7" -*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L242)* +*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L242)* ___ -### Dup8 +## Dup8 • **Dup8**: = "DUP8" -*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L243)* +*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L243)* ___ -### Dup9 +## Dup9 • **Dup9**: = "DUP9" -*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L244)* +*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L244)* ___ -### Eq +## Eq • **Eq**: = "EQ" -*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L157)* +*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L157)* ___ -### Exp +## Exp • **Exp**: = "EXP" -*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L150)* +*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L150)* ___ -### ExtCodeCopy +## ExtCodeCopy • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L179)* +*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L179)* ___ -### ExtCodeSize +## ExtCodeSize • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L178)* +*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L178)* ___ -### Gas +## Gas • **Gas**: = "GAS" -*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L200)* +*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L200)* ___ -### GasPrice +## GasPrice • **GasPrice**: = "GASPRICE" -*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L177)* +*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L177)* ___ -### Gaslimit +## Gaslimit • **Gaslimit**: = "GASLIMIT" -*Defined in [index.ts:188](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L188)* +*Defined in [index.ts:188](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L188)* ___ -### Gt +## Gt • **Gt**: = "GT" -*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L154)* +*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L154)* ___ -### Invalid +## Invalid • **Invalid**: = "INVALID" -*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L282)* +*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L282)* ___ -### IsZero +## IsZero • **IsZero**: = "ISZERO" -*Defined in [index.ts:158](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L158)* +*Defined in [index.ts:158](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L158)* ___ -### Jump +## Jump • **Jump**: = "JUMP" -*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L196)* +*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L196)* ___ -### JumpDest +## JumpDest • **JumpDest**: = "JUMPDEST" -*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L201)* +*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L201)* ___ -### Jumpi +## Jumpi • **Jumpi**: = "JUMPI" -*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L197)* +*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L197)* ___ -### Log1 +## Log1 • **Log1**: = "LOG1" -*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L270)* +*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L270)* ___ -### Log2 +## Log2 • **Log2**: = "LOG2" -*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L271)* +*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L271)* ___ -### Log3 +## Log3 • **Log3**: = "LOG3" -*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L272)* +*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L272)* ___ -### Log4 +## Log4 • **Log4**: = "LOG4" -*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L273)* +*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L273)* ___ -### Lt +## Lt • **Lt**: = "LT" -*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L153)* +*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L153)* ___ -### MLoad +## MLoad • **MLoad**: = "MLOAD" -*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L191)* +*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L191)* ___ -### MSize +## MSize • **MSize**: = "MSIZE" -*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L199)* +*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L199)* ___ -### MStore +## MStore • **MStore**: = "MSTORE" -*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L192)* +*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L192)* ___ -### MStore8 +## MStore8 • **MStore8**: = "MSTORE8" -*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L193)* +*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L193)* ___ -### Mod +## Mod • **Mod**: = "MOD" -*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L146)* +*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L146)* ___ -### Mul +## Mul • **Mul**: = "MUL" -*Defined in [index.ts:142](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L142)* +*Defined in [index.ts:142](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L142)* ___ -### MulMod +## MulMod • **MulMod**: = "MULMOD" -*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L149)* +*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L149)* ___ -### Not +## Not • **Not**: = "NOT" -*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L162)* +*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L162)* ___ -### Number +## Number • **Number**: = "NUMBER" -*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L186)* +*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L186)* ___ -### Or +## Or • **Or**: = "OR" -*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L160)* +*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L160)* ___ -### Origin +## Origin • **Origin**: = "ORIGIN" -*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L169)* +*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L169)* ___ -### Pc +## Pc • **Pc**: = "PC" -*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L198)* +*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L198)* ___ -### Pop +## Pop • **Pop**: = "POP" -*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L190)* +*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L190)* ___ -### Push1 +## Push1 • **Push1**: = "PUSH1" -*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L203)* +*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L203)* ___ -### Push10 +## Push10 • **Push10**: = "PUSH10" -*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L212)* +*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L212)* ___ -### Push11 +## Push11 • **Push11**: = "PUSH11" -*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L213)* +*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L213)* ___ -### Push12 +## Push12 • **Push12**: = "PUSH12" -*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L214)* +*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L214)* ___ -### Push13 +## Push13 • **Push13**: = "PUSH13" -*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L215)* +*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L215)* ___ -### Push14 +## Push14 • **Push14**: = "PUSH14" -*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L216)* +*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L216)* ___ -### Push15 +## Push15 • **Push15**: = "PUSH15" -*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L217)* +*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L217)* ___ -### Push16 +## Push16 • **Push16**: = "PUSH16" -*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L218)* +*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L218)* ___ -### Push17 +## Push17 • **Push17**: = "PUSH17" -*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L219)* +*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L219)* ___ -### Push18 +## Push18 • **Push18**: = "PUSH18" -*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L220)* +*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L220)* ___ -### Push19 +## Push19 • **Push19**: = "PUSH19" -*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L221)* +*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L221)* ___ -### Push2 +## Push2 • **Push2**: = "PUSH2" -*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L204)* +*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L204)* ___ -### Push20 +## Push20 • **Push20**: = "PUSH20" -*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L222)* +*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L222)* ___ -### Push21 +## Push21 • **Push21**: = "PUSH21" -*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L223)* +*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L223)* ___ -### Push22 +## Push22 • **Push22**: = "PUSH22" -*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L224)* +*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L224)* ___ -### Push23 +## Push23 • **Push23**: = "PUSH23" -*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L225)* +*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L225)* ___ -### Push24 +## Push24 • **Push24**: = "PUSH24" -*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L226)* +*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L226)* ___ -### Push25 +## Push25 • **Push25**: = "PUSH25" -*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L227)* +*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L227)* ___ -### Push26 +## Push26 • **Push26**: = "PUSH26" -*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L228)* +*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L228)* ___ -### Push27 +## Push27 • **Push27**: = "PUSH27" -*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L229)* +*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L229)* ___ -### Push28 +## Push28 • **Push28**: = "PUSH28" -*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L230)* +*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L230)* ___ -### Push29 +## Push29 • **Push29**: = "PUSH29" -*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L231)* +*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L231)* ___ -### Push3 +## Push3 • **Push3**: = "PUSH3" -*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L205)* +*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L205)* ___ -### Push30 +## Push30 • **Push30**: = "PUSH30" -*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L232)* +*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L232)* ___ -### Push31 +## Push31 • **Push31**: = "PUSH31" -*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L233)* +*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L233)* ___ -### Push32 +## Push32 • **Push32**: = "PUSH32" -*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L234)* +*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L234)* ___ -### Push4 +## Push4 • **Push4**: = "PUSH4" -*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L206)* +*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L206)* ___ -### Push5 +## Push5 • **Push5**: = "PUSH5" -*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L207)* +*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L207)* ___ -### Push6 +## Push6 • **Push6**: = "PUSH6" -*Defined in [index.ts:208](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L208)* +*Defined in [index.ts:208](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L208)* ___ -### Push7 +## Push7 • **Push7**: = "PUSH7" -*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L209)* +*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L209)* ___ -### Push8 +## Push8 • **Push8**: = "PUSH8" -*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L210)* +*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L210)* ___ -### Push9 +## Push9 • **Push9**: = "PUSH9" -*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L211)* +*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L211)* ___ -### Return +## Return • **Return**: = "RETURN" -*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L278)* +*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L278)* ___ -### ReturnDataCopy +## ReturnDataCopy • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L181)* +*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L181)* ___ -### ReturnDataSize +## ReturnDataSize • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L180)* +*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L180)* ___ -### Revert +## Revert • **Revert**: = "REVERT" -*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L281)* +*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L281)* ___ -### SDiv +## SDiv • **SDiv**: = "SDIV" -*Defined in [index.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L145)* +*Defined in [index.ts:145](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L145)* ___ -### SGt +## SGt • **SGt**: = "SGT" -*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L156)* +*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L156)* ___ -### SLoad +## SLoad • **SLoad**: = "SLOAD" -*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L194)* +*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L194)* ___ -### SLt +## SLt • **SLt**: = "SLT" -*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L155)* +*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L155)* ___ -### SMod +## SMod • **SMod**: = "SMOD" -*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L147)* +*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L147)* ___ -### SStore +## SStore • **SStore**: = "SSTORE" -*Defined in [index.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L195)* +*Defined in [index.ts:195](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L195)* ___ -### SelfDestruct +## SelfDestruct • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L283)* +*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L283)* ___ -### Sha3 +## Sha3 • **Sha3**: = "SHA3" -*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L165)* +*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L165)* ___ -### SignExtend +## SignExtend • **SignExtend**: = "SIGNEXTEND" -*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L151)* +*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L151)* ___ -### StaticCall +## StaticCall • **StaticCall**: = "STATICCALL" -*Defined in [index.ts:280](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L280)* +*Defined in [index.ts:280](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L280)* ___ -### Stop +## Stop • **Stop**: = "STOP" -*Defined in [index.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L140)* +*Defined in [index.ts:140](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L140)* ___ -### Sub +## Sub • **Sub**: = "SUB" -*Defined in [index.ts:143](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L143)* +*Defined in [index.ts:143](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L143)* ___ -### Swap1 +## Swap1 • **Swap1**: = "SWAP1" -*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L253)* +*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L253)* ___ -### Swap10 +## Swap10 • **Swap10**: = "SWAP10" -*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L262)* +*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L262)* ___ -### Swap11 +## Swap11 • **Swap11**: = "SWAP11" -*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L263)* +*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L263)* ___ -### Swap12 +## Swap12 • **Swap12**: = "SWAP12" -*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L264)* +*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L264)* ___ -### Swap13 +## Swap13 • **Swap13**: = "SWAP13" -*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L265)* +*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L265)* ___ -### Swap14 +## Swap14 • **Swap14**: = "SWAP14" -*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L266)* +*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L266)* ___ -### Swap15 +## Swap15 • **Swap15**: = "SWAP15" -*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L267)* +*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L267)* ___ -### Swap16 +## Swap16 • **Swap16**: = "SWAP16" -*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L268)* +*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L268)* ___ -### Swap2 +## Swap2 • **Swap2**: = "SWAP2" -*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L254)* +*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L254)* ___ -### Swap3 +## Swap3 • **Swap3**: = "SWAP3" -*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L255)* +*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L255)* ___ -### Swap4 +## Swap4 • **Swap4**: = "SWAP4" -*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L256)* +*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L256)* ___ -### Swap5 +## Swap5 • **Swap5**: = "SWAP5" -*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L257)* +*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L257)* ___ -### Swap6 +## Swap6 • **Swap6**: = "SWAP6" -*Defined in [index.ts:258](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L258)* +*Defined in [index.ts:258](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L258)* ___ -### Swap7 +## Swap7 • **Swap7**: = "SWAP7" -*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L259)* +*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L259)* ___ -### Swap8 +## Swap8 • **Swap8**: = "SWAP8" -*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L260)* +*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L260)* ___ -### Swap9 +## Swap9 • **Swap9**: = "SWAP9" -*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L261)* +*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L261)* ___ -### TimeStamp +## TimeStamp • **TimeStamp**: = "TimeStamp" -*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L185)* +*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L185)* ___ -### Xor +## Xor • **Xor**: = "XOR" -*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L161)* +*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L161)*
-> # Enumeration: SolidityTypes +# Enumeration: SolidityTypes -## Index ### Enumeration members -* [Address](#address) -* [Bool](#bool) -* [Bytes](#bytes) -* [Int](#int) -* [String](#string) -* [Tuple](#tuple) -* [Uint](#uint) -* [Uint256](#uint256) -* [Uint8](#uint8) - -## Enumeration members - -### Address +## Address • **Address**: = "address" -*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L489)* +*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L489)* ___ -### Bool +## Bool • **Bool**: = "bool" -*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L490)* +*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L490)* ___ -### Bytes +## Bytes • **Bytes**: = "bytes" -*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L491)* +*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L491)* ___ -### Int +## Int • **Int**: = "int" -*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L492)* +*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L492)* ___ -### String +## String • **String**: = "string" -*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L493)* +*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L493)* ___ -### Tuple +## Tuple • **Tuple**: = "tuple" -*Defined in [index.ts:494](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L494)* +*Defined in [index.ts:494](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L494)* ___ -### Uint +## Uint • **Uint**: = "uint" -*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L497)* +*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L497)* ___ -### Uint256 +## Uint256 • **Uint256**: = "uint256" -*Defined in [index.ts:495](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L495)* +*Defined in [index.ts:495](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L495)* ___ -### Uint8 +## Uint8 • **Uint8**: = "uint8" -*Defined in [index.ts:496](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L496)* +*Defined in [index.ts:496](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L496)*
-> # Interface: AbstractBlock +# Interface: AbstractBlock -## Hierarchy +### Hierarchy * **AbstractBlock** @@ -1394,681 +1228,605 @@ ___ * [BlockWithTransactionData](#class-blockwithtransactiondata) -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *`BigNumber`* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L350)* ___ -### extraData +## extraData • **extraData**: *string* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L352)* ___ -### gasLimit +## gasLimit • **gasLimit**: *number* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L354)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L355)* ___ -### hash +## hash • **hash**: *string | null* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L342)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* -*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L346)* ___ -### miner +## miner • **miner**: *string* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L349)* ___ -### nonce +## nonce • **nonce**: *string | null* -*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L344)* ___ -### number +## number • **number**: *number | null* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L341)* ___ -### parentHash +## parentHash • **parentHash**: *string* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L343)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* -*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L345)* ___ -### size +## size • **size**: *number* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L353)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L348)* ___ -### timestamp +## timestamp • **timestamp**: *number* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L356)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *`BigNumber`* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L351)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L347)* ___ -### uncles +## uncles • **uncles**: *string[]* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L357)*
-> # Interface: BlockWithoutTransactionData +# Interface: BlockWithoutTransactionData -## Hierarchy +### Hierarchy * [AbstractBlock](#class-abstractblock) * **BlockWithoutTransactionData** -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *`BigNumber`* *Inherited from [AbstractBlock](#difficulty)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L350)* ___ -### extraData +## extraData • **extraData**: *string* *Inherited from [AbstractBlock](#extradata)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L352)* ___ -### gasLimit +## gasLimit • **gasLimit**: *number* *Inherited from [AbstractBlock](#gaslimit)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L354)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* *Inherited from [AbstractBlock](#gasused)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L355)* ___ -### hash +## hash • **hash**: *string | null* *Inherited from [AbstractBlock](#hash)* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L342)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* *Inherited from [AbstractBlock](#logsbloom)* -*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L346)* ___ -### miner +## miner • **miner**: *string* *Inherited from [AbstractBlock](#miner)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L349)* ___ -### nonce +## nonce • **nonce**: *string | null* *Inherited from [AbstractBlock](#nonce)* -*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L344)* ___ -### number +## number • **number**: *number | null* *Inherited from [AbstractBlock](#number)* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L341)* ___ -### parentHash +## parentHash • **parentHash**: *string* *Inherited from [AbstractBlock](#parenthash)* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L343)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* *Inherited from [AbstractBlock](#sha3uncles)* -*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L345)* ___ -### size +## size • **size**: *number* *Inherited from [AbstractBlock](#size)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L353)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* *Inherited from [AbstractBlock](#stateroot)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L348)* ___ -### timestamp +## timestamp • **timestamp**: *number* *Inherited from [AbstractBlock](#timestamp)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L356)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *`BigNumber`* *Inherited from [AbstractBlock](#totaldifficulty)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L351)* ___ -### transactions +## transactions • **transactions**: *string[]* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L361)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* *Inherited from [AbstractBlock](#transactionsroot)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L347)* ___ -### uncles +## uncles • **uncles**: *string[]* *Inherited from [AbstractBlock](#uncles)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L357)*
-> # Interface: BlockWithTransactionData +# Interface: BlockWithTransactionData -## Hierarchy +### Hierarchy * [AbstractBlock](#class-abstractblock) * **BlockWithTransactionData** -## Index ### Properties -* [difficulty](#difficulty) -* [extraData](#extradata) -* [gasLimit](#gaslimit) -* [gasUsed](#gasused) -* [hash](#hash) -* [logsBloom](#logsbloom) -* [miner](#miner) -* [nonce](#nonce) -* [number](#number) -* [parentHash](#parenthash) -* [sha3Uncles](#sha3uncles) -* [size](#size) -* [stateRoot](#stateroot) -* [timestamp](#timestamp) -* [totalDifficulty](#totaldifficulty) -* [transactions](#transactions) -* [transactionsRoot](#transactionsroot) -* [uncles](#uncles) - -## Properties - -### difficulty +## difficulty • **difficulty**: *`BigNumber`* *Inherited from [AbstractBlock](#difficulty)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L350)* ___ -### extraData +## extraData • **extraData**: *string* *Inherited from [AbstractBlock](#extradata)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L352)* ___ -### gasLimit +## gasLimit • **gasLimit**: *number* *Inherited from [AbstractBlock](#gaslimit)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L354)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* *Inherited from [AbstractBlock](#gasused)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L355)* ___ -### hash +## hash • **hash**: *string | null* *Inherited from [AbstractBlock](#hash)* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L342)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* *Inherited from [AbstractBlock](#logsbloom)* -*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L346)* ___ -### miner +## miner • **miner**: *string* *Inherited from [AbstractBlock](#miner)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L349)* ___ -### nonce +## nonce • **nonce**: *string | null* *Inherited from [AbstractBlock](#nonce)* -*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L344)* ___ -### number +## number • **number**: *number | null* *Inherited from [AbstractBlock](#number)* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L341)* ___ -### parentHash +## parentHash • **parentHash**: *string* *Inherited from [AbstractBlock](#parenthash)* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L343)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* *Inherited from [AbstractBlock](#sha3uncles)* -*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L345)* ___ -### size +## size • **size**: *number* *Inherited from [AbstractBlock](#size)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L353)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* *Inherited from [AbstractBlock](#stateroot)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L348)* ___ -### timestamp +## timestamp • **timestamp**: *number* *Inherited from [AbstractBlock](#timestamp)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L356)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *`BigNumber`* *Inherited from [AbstractBlock](#totaldifficulty)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L351)* ___ -### transactions +## transactions • **transactions**: *[Transaction](#class-transaction)[]* -*Defined in [index.ts:365](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L365)* +*Defined in [index.ts:365](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L365)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* *Inherited from [AbstractBlock](#transactionsroot)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L347)* ___ -### uncles +## uncles • **uncles**: *string[]* *Inherited from [AbstractBlock](#uncles)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L357)*
-> # Interface: CallData +# Interface: CallData -## Hierarchy +### Hierarchy * [CallTxDataBase](#class-calltxdatabase) * **CallData** -## Index ### Properties -* [data](#optional-data) -* [from](#optional-from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-data)* -*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L387)* ___ -### `Optional` from +## `Optional` from • **from**? : *undefined | string* -*Defined in [index.ts:396](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L396)* +*Defined in [index.ts:396](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L396)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gas)* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L385)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gasprice)* -*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L386)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#optional-nonce)* -*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L388)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-to)* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L383)* ___ -### `Optional` value +## `Optional` value • **value**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-value)* -*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L384)*
-> # Interface: CallTxDataBase +# Interface: CallTxDataBase -## Hierarchy +### Hierarchy * **CallTxDataBase** @@ -2076,68 +1834,58 @@ ___ * [CallData](#class-calldata) -## Index ### Properties -* [data](#optional-data) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* -*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L387)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *number | string | `BigNumber`* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L385)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* -*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L386)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* -*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L388)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L383)* ___ -### `Optional` value +## `Optional` value • **value**? : *number | string | `BigNumber`* -*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L384)*
-> # Interface: CompilerOptions +# Interface: CompilerOptions Options you can specify (as flags or in a compiler.json file) when invoking sol-compiler contractsDir: Directory containing your project's Solidity contracts. Can contain nested directories. @@ -2151,176 +1899,148 @@ isOfflineMode: If set to true - sol-compiler will not fetch the list of solc rel solcVersion: If you don't want to compile each contract with the Solidity version specified in-file, you can force all contracts to compile with the the version specified here. -## Hierarchy +### Hierarchy * **CompilerOptions** -## Index ### Properties -* [artifactsDir](#optional-artifactsdir) -* [compilerSettings](#optional-compilersettings) -* [contracts](#optional-contracts) -* [contractsDir](#optional-contractsdir) -* [isOfflineMode](#optional-isofflinemode) -* [solcVersion](#optional-solcversion) -* [useDockerisedSolc](#optional-usedockerisedsolc) - -## Properties - -### `Optional` artifactsDir +## `Optional` artifactsDir • **artifactsDir**? : *undefined | string* -*Defined in [index.ts:723](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L723)* +*Defined in [index.ts:723](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L723)* ___ -### `Optional` compilerSettings +## `Optional` compilerSettings • **compilerSettings**? : *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:724](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L724)* +*Defined in [index.ts:724](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L724)* ___ -### `Optional` contracts +## `Optional` contracts • **contracts**? : *string[] | "*"* -*Defined in [index.ts:725](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L725)* +*Defined in [index.ts:725](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L725)* ___ -### `Optional` contractsDir +## `Optional` contractsDir • **contractsDir**? : *undefined | string* -*Defined in [index.ts:722](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L722)* +*Defined in [index.ts:722](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L722)* ___ -### `Optional` isOfflineMode +## `Optional` isOfflineMode • **isOfflineMode**? : *undefined | false | true* -*Defined in [index.ts:727](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L727)* +*Defined in [index.ts:727](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L727)* ___ -### `Optional` solcVersion +## `Optional` solcVersion • **solcVersion**? : *undefined | string* -*Defined in [index.ts:728](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L728)* +*Defined in [index.ts:728](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L728)* ___ -### `Optional` useDockerisedSolc +## `Optional` useDockerisedSolc • **useDockerisedSolc**? : *undefined | false | true* -*Defined in [index.ts:726](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L726)* +*Defined in [index.ts:726](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L726)*
-> # Interface: CompilerOpts +# Interface: CompilerOpts -## Hierarchy +### Hierarchy * **CompilerOpts** -## Index ### Properties -* [name](#name) -* [settings](#settings) -* [version](#version) - -## Properties - -### name +## name • **name**: *"solc"* -*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L647)* ___ -### settings +## settings • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:649](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L649)* +*Defined in [index.ts:649](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L649)* ___ -### version +## version • **version**: *string* -*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L648)* +*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L648)*
-> # Interface: CompilerSettings +# Interface: CompilerSettings -## Hierarchy +### Hierarchy * **CompilerSettings** -## Index ### Properties -* [evmVersion](#optional-evmversion) -* [libraries](#optional-libraries) -* [metadata](#optional-metadata) -* [optimizer](#optional-optimizer) -* [outputSelection](#outputselection) -* [remappings](#optional-remappings) - -## Properties - -### `Optional` evmVersion +## `Optional` evmVersion • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L681)* +*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L681)* ___ -### `Optional` libraries +## `Optional` libraries • **libraries**? : *undefined | object* -*Defined in [index.ts:683](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L683)* +*Defined in [index.ts:683](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L683)* ___ -### `Optional` metadata +## `Optional` metadata • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L682)* +*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L682)* ___ -### `Optional` optimizer +## `Optional` optimizer • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L680)* +*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L680)* ___ -### outputSelection +## outputSelection • **outputSelection**: *object* -*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L688)* +*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L688)* #### Type declaration: @@ -2330,86 +2050,73 @@ ___ ___ -### `Optional` remappings +## `Optional` remappings • **remappings**? : *string[]* -*Defined in [index.ts:679](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L679)* +*Defined in [index.ts:679](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L679)*
-> # Interface: CompilerSettingsMetadata +# Interface: CompilerSettingsMetadata -## Hierarchy +### Hierarchy * **CompilerSettingsMetadata** -## Index ### Properties -* [useLiteralContent](#useliteralcontent) - -## Properties - -### useLiteralContent +## useLiteralContent • **useLiteralContent**: *true* -*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L696)* +*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L696)*
-> # Interface: ConstructorAbi +# Interface: ConstructorAbi -## Hierarchy +### Hierarchy * **ConstructorAbi** -## Index ### Properties -* [inputs](#inputs) -* [payable](#payable) -* [stateMutability](#statemutability) -* [type](#type) - -## Properties - -### inputs +## inputs • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L103)* +*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L103)* ___ -### payable +## payable • **payable**: *boolean* -*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L104)* +*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L104)* ___ -### stateMutability +## stateMutability • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L105)* +*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L105)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L102)*
-> # Interface: ContractArtifact +# Interface: ContractArtifact This type defines the schema of the artifact.json file generated by Sol-compiler schemaVersion: The version of the artifact schema @@ -2423,78 +2130,66 @@ 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 -## Hierarchy +### Hierarchy * [ContractVersionData](#class-contractversiondata) * **ContractArtifact** -## Index ### Properties -* [compiler](#compiler) -* [compilerOutput](#compileroutput) -* [contractName](#contractname) -* [networks](#networks) -* [schemaVersion](#schemaversion) -* [sourceCodes](#sourcecodes) -* [sourceTreeHashHex](#sourcetreehashhex) -* [sources](#sources) - -## Properties - -### compiler +## compiler • **compiler**: *[CompilerOpts](#class-compileropts)* *Inherited from [ContractVersionData](#compiler)* -*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L633)* +*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L633)* ___ -### compilerOutput +## compilerOutput • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* *Inherited from [ContractVersionData](#compileroutput)* -*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L643)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L643)* ___ -### contractName +## contractName • **contractName**: *string* -*Defined in [index.ts:667](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L667)* +*Defined in [index.ts:667](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L667)* ___ -### networks +## networks • **networks**: *[ContractNetworks](#class-contractnetworks)* -*Defined in [index.ts:668](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L668)* +*Defined in [index.ts:668](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L668)* ___ -### schemaVersion +## schemaVersion • **schemaVersion**: *string* -*Defined in [index.ts:666](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L666)* +*Defined in [index.ts:666](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L666)* ___ -### sourceCodes +## sourceCodes • **sourceCodes**: *object* *Inherited from [ContractVersionData](#sourcecodes)* -*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L639)* +*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L639)* #### Type declaration: @@ -2502,23 +2197,23 @@ ___ ___ -### sourceTreeHashHex +## sourceTreeHashHex • **sourceTreeHashHex**: *string* *Inherited from [ContractVersionData](#sourcetreehashhex)* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L642)* ___ -### sources +## sources • **sources**: *object* *Inherited from [ContractVersionData](#sources)* -*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L634)* +*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L634)* #### Type declaration: @@ -2526,43 +2221,36 @@ ___
-> # Interface: ContractNetworkData +# Interface: ContractNetworkData -## Hierarchy +### Hierarchy * **ContractNetworkData** -## Index ### Properties -* [address](#address) -* [constructorArgs](#constructorargs) -* [links](#links) - -## Properties - -### address +## address • **address**: *string* -*Defined in [index.ts:546](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L546)* +*Defined in [index.ts:546](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L546)* ___ -### constructorArgs +## constructerArgs • **constructorArgs**: *string* -*Defined in [index.ts:550](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L550)* +*Defined in [index.ts:550](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L550)* ___ -### links +## links • **links**: *object* -*Defined in [index.ts:547](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L547)* +*Defined in [index.ts:547](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L547)* #### Type declaration: @@ -2570,59 +2258,43 @@ ___
-> # Interface: ContractNetworks +# Interface: ContractNetworks -## Hierarchy +### Hierarchy * **ContractNetworks** -## Indexable -● \[▪ **networkId**: *number*\]: [ContractNetworkData](#class-contractnetworkdata) - -
- -> # Interface: ContractVersionData - -## Hierarchy +### Hierarchy * **ContractVersionData** * [ContractArtifact](#class-contractartifact) -## Index ### Properties -* [compiler](#compiler) -* [compilerOutput](#compileroutput) -* [sourceCodes](#sourcecodes) -* [sourceTreeHashHex](#sourcetreehashhex) -* [sources](#sources) - -## Properties - -### compiler +## compiler • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L633)* +*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L633)* ___ -### compilerOutput +## compilerOutput • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L643)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L643)* ___ -### sourceCodes +## sourceCodes • **sourceCodes**: *object* -*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L639)* +*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L639)* #### Type declaration: @@ -2630,19 +2302,19 @@ ___ ___ -### sourceTreeHashHex +## sourceTreeHashHex • **sourceTreeHashHex**: *string* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L642)* ___ -### sources +## sources • **sources**: *object* -*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L634)* +*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L634)* #### Type declaration: @@ -2650,9 +2322,9 @@ ___
-> # Interface: DataItem +# Interface: DataItem -## Hierarchy +### Hierarchy * **DataItem** @@ -2660,59 +2332,45 @@ ___ * [TupleDataItem](#class-tupledataitem) -## Index ### Properties -* [components](#optional-components) -* [name](#name) -* [type](#type) - -## Properties - -### `Optional` components +## `Optional` components • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L131)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L129)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L130)*
-> # Interface: DecodedLogArgs +# Interface: DecodedLogArgs -## Hierarchy +### Hierarchy * **DecodedLogArgs** -## Indexable -● \[▪ **argName**: *string*\]: [ContractEventArg](#contracteventarg) - -
- -> # Interface: DecodedLogEntry <**A**> - -## Type parameters +### Type parameters ▪ **A** -## Hierarchy +### Hierarchy * [LogEntry](#class-logentry) @@ -2722,286 +2380,250 @@ ___ * [LogWithDecodedArgs](#class-logwithdecodedargs) -## Index ### Properties -* [address](#address) -* [args](#args) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [event](#event) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* *Inherited from [LogEntry](#address)* -*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L428)* ___ -### args +## args • **args**: *`A`* -*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L411)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#blockhash)* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#blocknumber)* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* *Inherited from [LogEntry](#data)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L429)* ___ -### event +## event • **event**: *string* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L410)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#logindex)* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L423)* ___ -### topics +## topics • **topics**: *string[]* *Inherited from [LogEntry](#topics)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#transactionhash)* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#transactionindex)* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L424)*
-> # Interface: DecodedLogEntryEvent <**A**> +# Interface: DecodedLogEntryEvent <**A**> -## Type parameters +### Type parameters ▪ **A** -## Hierarchy +### Hierarchy * [DecodedLogEntry](#class-decodedlogentry)‹*`A`*› * **DecodedLogEntryEvent** -## Index ### Properties -* [address](#address) -* [args](#args) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [event](#event) -* [logIndex](#logindex) -* [removed](#removed) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* *Inherited from [LogEntry](#address)* -*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L428)* ___ -### args +## args • **args**: *`A`* *Inherited from [DecodedLogEntry](#args)* -*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L411)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#blockhash)* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#blocknumber)* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* *Inherited from [LogEntry](#data)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L429)* ___ -### event +## event • **event**: *string* *Inherited from [DecodedLogEntry](#event)* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L410)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#logindex)* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L423)* ___ -### removed +## removed • **removed**: *boolean* -*Defined in [index.ts:415](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L415)* +*Defined in [index.ts:415](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L415)* ___ -### topics +## topics • **topics**: *string[]* *Inherited from [LogEntry](#topics)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#transactionhash)* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#transactionindex)* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L424)*
-> # Interface: DevdocOutput +# Interface: DevdocOutput -## Hierarchy +### Hierarchy * **DevdocOutput** -## Index ### Properties -* [author](#optional-author) -* [methods](#methods) -* [title](#optional-title) - -## Properties - -### `Optional` author +## `Optional` author • **author**? : *undefined | string* -*Defined in [index.ts:620](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L620)* +*Defined in [index.ts:620](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L620)* ___ -### methods +## methods • **methods**: *object* -*Defined in [index.ts:621](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L621)* +*Defined in [index.ts:621](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L621)* #### Type declaration: @@ -3009,46 +2631,36 @@ ___ ___ -### `Optional` title +## `Optional` title • **title**? : *undefined | string* -*Defined in [index.ts:619](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L619)* +*Defined in [index.ts:619](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L619)*
-> # Interface: EIP1193Provider +# Interface: EIP1193Provider -## Hierarchy +### Hierarchy * **EIP1193Provider** -## Index ### Properties -* [isEIP1193](#iseip1193) - -### Methods - -* [on](#on) -* [send](#send) - -## Properties - -### isEIP1193 +## isEIP1193 • **isEIP1193**: *boolean* -*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L73)* +*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L73)* -## Methods +### Methods -### on +## on ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L75)* +*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -3068,11 +2680,11 @@ Name | Type | ___ -### send +## send ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -3085,282 +2697,234 @@ Name | Type |
-> # Interface: EventAbi +# Interface: EventAbi -## Hierarchy +### Hierarchy * **EventAbi** -## Index ### Properties -* [anonymous](#anonymous) -* [inputs](#inputs) -* [name](#name) -* [type](#type) - -## Properties - -### anonymous +## anonymous • **anonymous**: *boolean* -*Defined in [index.ts:125](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L125)* +*Defined in [index.ts:125](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L125)* ___ -### inputs +## inputs • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [index.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L124)* +*Defined in [index.ts:124](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L124)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:123](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L123)* +*Defined in [index.ts:123](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L123)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L122)* +*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L122)*
-> # Interface: EventParameter +# Interface: EventParameter -## Hierarchy +### Hierarchy * [DataItem](#class-dataitem) * **EventParameter** -## Index ### Properties -* [components](#optional-components) -* [indexed](#indexed) -* [name](#name) -* [type](#type) - -## Properties - -### `Optional` components +## `Optional` components • **components**? : *[DataItem](#class-dataitem)[]* *Inherited from [DataItem](#optional-components)* -*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L131)* ___ -### indexed +## indexed • **indexed**: *boolean* -*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L116)* +*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L116)* ___ -### name +## name • **name**: *string* *Inherited from [DataItem](#name)* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L129)* ___ -### type +## type • **type**: *string* *Inherited from [DataItem](#type)* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L130)*
-> # Interface: EvmBytecodeOutput +# Interface: EvmBytecodeOutput -## Hierarchy +### Hierarchy * **EvmBytecodeOutput** -## Index ### Properties -* [object](#object) -* [sourceMap](#sourcemap) - -## Properties - -### object +## object • **object**: *string* -*Defined in [index.ts:614](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L614)* +*Defined in [index.ts:614](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L614)* ___ -### sourceMap +## sourceMap • **sourceMap**: *string* -*Defined in [index.ts:615](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L615)* +*Defined in [index.ts:615](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L615)*
-> # Interface: EvmOutput +# Interface: EvmOutput -## Hierarchy +### Hierarchy * **EvmOutput** -## Index ### Properties -* [bytecode](#bytecode) -* [deployedBytecode](#deployedbytecode) - -## Properties - -### bytecode +## bytecode • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:609](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L609)* +*Defined in [index.ts:609](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L609)* ___ -### deployedBytecode +## deployedBytecode • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:610](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L610)* +*Defined in [index.ts:610](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L610)*
-> # Interface: FallbackAbi +# Interface: FallbackAbi -## Hierarchy +### Hierarchy * **FallbackAbi** -## Index ### Properties -* [payable](#payable) -* [type](#type) - -## Properties - -### payable +## payable • **payable**: *boolean* -*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L112)* +*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L112)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L111)* +*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L111)*
-> # Interface: FilterObject +# Interface: FilterObject -## Hierarchy +### Hierarchy * **FilterObject** -## Index ### Properties -* [address](#optional-address) -* [blockHash](#optional-blockhash) -* [fromBlock](#optional-fromblock) -* [toBlock](#optional-toblock) -* [topics](#optional-topics) - -## Properties - -### `Optional` address +## `Optional` address • **address**? : *undefined | string* -*Defined in [index.ts:403](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L403)* +*Defined in [index.ts:403](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L403)* ___ -### `Optional` blockHash +## `Optional` blockHash • **blockHash**? : *undefined | string* -*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L402)* +*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L402)* ___ -### `Optional` fromBlock +## `Optional` fromBlock • **fromBlock**? : *number | string* -*Defined in [index.ts:400](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L400)* +*Defined in [index.ts:400](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L400)* ___ -### `Optional` toBlock +## `Optional` toBlock • **toBlock**? : *number | string* -*Defined in [index.ts:401](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L401)* +*Defined in [index.ts:401](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L401)* ___ -### `Optional` topics +## `Optional` topics • **topics**? : *[LogTopic](#logtopic)[]* -*Defined in [index.ts:404](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L404)* +*Defined in [index.ts:404](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L404)*
-> # Interface: GanacheProvider +# Interface: GanacheProvider -## Hierarchy +### Hierarchy * **GanacheProvider** -## Index ### Methods -* [sendAsync](#sendasync) - -## Methods - -### sendAsync +## sendAsync ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L14)* +*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -3373,178 +2937,149 @@ Name | Type |
-> # Interface: GeneratedCompilerOptions +# Interface: GeneratedCompilerOptions -## Hierarchy +### Hierarchy * **GeneratedCompilerOptions** -## Index ### Properties -* [name](#name) -* [settings](#settings) -* [version](#version) - -## Properties - -### name +## name • **name**: *"solc"* -*Defined in [index.ts:672](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L672)* +*Defined in [index.ts:672](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L672)* ___ -### settings +## settings • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L674)* +*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L674)* ___ -### version +## version • **version**: *string* -*Defined in [index.ts:673](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L673)* +*Defined in [index.ts:673](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L673)*
-> # Interface: JSONRPCRequestPayload +# Interface: JSONRPCRequestPayload -## Hierarchy +### Hierarchy * **JSONRPCRequestPayload** -## Index ### Properties -* [id](#id) -* [jsonrpc](#jsonrpc) -* [method](#method) -* [params](#params) - -## Properties - -### id +## id • **id**: *number* -*Defined in [index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L324)* +*Defined in [index.ts:324](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L324)* ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Defined in [index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L325)* +*Defined in [index.ts:325](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L325)* ___ -### method +## method • **method**: *string* -*Defined in [index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L323)* +*Defined in [index.ts:323](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L323)* ___ -### params +## params • **params**: *any[]* -*Defined in [index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L322)* +*Defined in [index.ts:322](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L322)*
-> # Interface: JSONRPCResponseError +# Interface: JSONRPCResponseError -## Hierarchy +### Hierarchy * **JSONRPCResponseError** -## Index ### Properties -* [code](#code) -* [message](#message) - -## Properties - -### code +## code • **code**: *number* -*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L330)* +*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L330)* ___ -### message +## message • **message**: *string* -*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L329)* +*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L329)*
-> # Interface: JSONRPCResponsePayload +# Interface: JSONRPCResponsePayload -## Hierarchy +### Hierarchy * **JSONRPCResponsePayload** -## Index ### Properties -* [error](#optional-error) -* [id](#id) -* [jsonrpc](#jsonrpc) -* [result](#result) - -## Properties - -### `Optional` error +## `Optional` error • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L337)* +*Defined in [index.ts:337](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L337)* ___ -### id +## id • **id**: *number* -*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L335)* +*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L335)* ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L336)* +*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L336)* ___ -### result +## result • **result**: *any* -*Defined in [index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L334)* +*Defined in [index.ts:334](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L334)*
-> # Interface: LogEntry +# Interface: LogEntry -## Hierarchy +### Hierarchy * **LogEntry** @@ -3552,452 +3087,391 @@ ___ * [LogEntryEvent](#class-logentryevent) -## Index ### Properties -* [address](#address) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* -*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L428)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L429)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L423)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L424)*
-> # Interface: LogEntryEvent +# Interface: LogEntryEvent -## Hierarchy +### Hierarchy * [LogEntry](#class-logentry) * **LogEntryEvent** -## Index ### Properties -* [address](#address) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [logIndex](#logindex) -* [removed](#removed) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* *Inherited from [LogEntry](#address)* -*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L428)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#blockhash)* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#blocknumber)* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* *Inherited from [LogEntry](#data)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L429)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#logindex)* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L423)* ___ -### removed +## removed • **removed**: *boolean* -*Defined in [index.ts:419](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L419)* +*Defined in [index.ts:419](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L419)* ___ -### topics +## topics • **topics**: *string[]* *Inherited from [LogEntry](#topics)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#transactionhash)* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#transactionindex)* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L424)*
-> # Interface: LogWithDecodedArgs <**ArgsType**> +# Interface: LogWithDecodedArgs <**ArgsType**> -## Type parameters +### Type parameters ▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* -## Hierarchy +### Hierarchy * [DecodedLogEntry](#class-decodedlogentry)‹*`ArgsType`*› * **LogWithDecodedArgs** -## Index ### Properties -* [address](#address) -* [args](#args) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [event](#event) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* *Inherited from [LogEntry](#address)* -*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L428)* ___ -### args +## args • **args**: *`ArgsType`* *Inherited from [DecodedLogEntry](#args)* -*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L411)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#blockhash)* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#blocknumber)* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* *Inherited from [LogEntry](#data)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L429)* ___ -### event +## event • **event**: *string* *Inherited from [DecodedLogEntry](#event)* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L410)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#logindex)* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L423)* ___ -### topics +## topics • **topics**: *string[]* *Inherited from [LogEntry](#topics)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#transactionhash)* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#transactionindex)* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L424)*
-> # Interface: MethodAbi +# Interface: MethodAbi -## Hierarchy +### Hierarchy * **MethodAbi** -## Index ### Properties -* [constant](#constant) -* [inputs](#inputs) -* [name](#name) -* [outputs](#outputs) -* [payable](#payable) -* [stateMutability](#statemutability) -* [type](#type) - -## Properties - -### constant +## constant • **constant**: *boolean* -*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L94)* +*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L94)* ___ -### inputs +## inputs • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L92)* +*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L92)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L91)* +*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L91)* ___ -### outputs +## outputs • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L93)* ___ -### payable +## payable • **payable**: *boolean* -*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L96)* +*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L96)* ___ -### stateMutability +## stateMutability • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L95)* +*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L95)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L90)* +*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L90)*
-> # Interface: OptimizerSettings +# Interface: OptimizerSettings -## Hierarchy +### Hierarchy * **OptimizerSettings** -## Index ### Properties -* [enabled](#enabled) -* [runs](#optional-runs) - -## Properties - -### enabled +## enabled • **enabled**: *boolean* -*Defined in [index.ts:700](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L700)* +*Defined in [index.ts:700](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L700)* ___ -### `Optional` runs +## `Optional` runs • **runs**? : *undefined | number* -*Defined in [index.ts:701](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L701)* +*Defined in [index.ts:701](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L701)*
-> # Interface: Provider +# Interface: Provider -## Hierarchy +### Hierarchy * **Provider** -## Index ### Methods -* [sendAsync](#sendasync) - -## Methods - -### sendAsync +## sendAsync ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L20)* +*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L20)* **Parameters:** @@ -4010,281 +3484,233 @@ Name | Type |
-> # Interface: RawLogEntry +# Interface: RawLogEntry -## Hierarchy +### Hierarchy * **RawLogEntry** -## Index ### Properties -* [address](#address) -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [data](#data) -* [logIndex](#logindex) -* [topics](#topics) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### address +## address • **address**: *string* -*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L483)* +*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L483)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [index.ts:481](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L481)* +*Defined in [index.ts:481](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L481)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [index.ts:482](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L482)* +*Defined in [index.ts:482](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L482)* ___ -### data +## data • **data**: *string* -*Defined in [index.ts:484](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L484)* +*Defined in [index.ts:484](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L484)* ___ -### logIndex +## logIndex • **logIndex**: *string | null* -*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L478)* +*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L478)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [index.ts:485](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L485)* +*Defined in [index.ts:485](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L485)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L480)* +*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L480)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L479)* +*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L479)*
-> # Interface: SolcError +# Interface: SolcError -## Hierarchy +### Hierarchy * **SolcError** -## Index ### Properties -* [component](#component) -* [formattedMessage](#optional-formattedmessage) -* [message](#message) -* [severity](#severity) -* [sourceLocation](#optional-sourcelocation) -* [type](#type) - -## Properties - -### component +## component • **component**: *"general" | "ewasm"* -*Defined in [index.ts:596](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L596)* +*Defined in [index.ts:596](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L596)* ___ -### `Optional` formattedMessage +## `Optional` formattedMessage • **formattedMessage**? : *undefined | string* -*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L599)* +*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L599)* ___ -### message +## message • **message**: *string* -*Defined in [index.ts:598](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L598)* +*Defined in [index.ts:598](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L598)* ___ -### severity +## severity • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [index.ts:597](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L597)* +*Defined in [index.ts:597](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L597)* ___ -### `Optional` sourceLocation +## `Optional` sourceLocation • **sourceLocation**? : *[SourceLocation](#class-sourcelocation)* -*Defined in [index.ts:594](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L594)* +*Defined in [index.ts:594](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L594)* ___ -### type +## type • **type**: *[ErrorType](#errortype)* -*Defined in [index.ts:595](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L595)* +*Defined in [index.ts:595](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L595)*
-> # Interface: Source +# Interface: Source -## Hierarchy +### Hierarchy * **Source** -## Index ### Properties -* [id](#id) - -## Properties - -### id +## id • **id**: *number* -*Defined in [index.ts:705](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L705)* +*Defined in [index.ts:705](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L705)*
-> # Interface: SourceLocation +# Interface: SourceLocation -## Hierarchy +### Hierarchy * **SourceLocation** -## Index ### Properties -* [end](#end) -* [file](#file) -* [start](#start) - -## Properties - -### end +## end • **end**: *number* -*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L605)* +*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L605)* ___ -### file +## file • **file**: *string* -*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L603)* +*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L603)* ___ -### start +## start • **start**: *number* -*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L604)* +*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L604)*
-> # Interface: StandardContractOutput +# Interface: StandardContractOutput -## Hierarchy +### Hierarchy * **StandardContractOutput** -## Index ### Properties -* [abi](#abi) -* [devdoc](#optional-devdoc) -* [evm](#evm) - -## Properties - -### abi +## abi • **abi**: *[ContractAbi](#contractabi)* -*Defined in [index.ts:556](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L556)* +*Defined in [index.ts:556](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L556)* ___ -### `Optional` devdoc +## `Optional` devdoc • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L558)* +*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L558)* ___ -### evm +## evm • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [index.ts:557](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L557)* +*Defined in [index.ts:557](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L557)*
-> # Interface: StandardOutput +# Interface: StandardOutput -## Hierarchy +### Hierarchy * **StandardOutput** -## Index ### Properties -* [contracts](#contracts) -* [errors](#errors) -* [sources](#sources) - -## Properties - -### contracts +## contracts • **contracts**: *object* -*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L570)* +*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L570)* #### Type declaration: @@ -4294,19 +3720,19 @@ ___ ___ -### errors +## errors • **errors**: *[SolcError](#class-solcerror)[]* -*Defined in [index.ts:562](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L562)* +*Defined in [index.ts:562](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L562)* ___ -### sources +## sources • **sources**: *object* -*Defined in [index.ts:563](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L563)* +*Defined in [index.ts:563](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L563)* #### Type declaration: @@ -4314,97 +3740,84 @@ ___
-> # Interface: StructLog +# Interface: StructLog -## Hierarchy +### Hierarchy * **StructLog** -## Index ### Properties -* [depth](#depth) -* [error](#error) -* [gas](#gas) -* [gasCost](#gascost) -* [memory](#memory) -* [op](#op) -* [pc](#pc) -* [stack](#stack) -* [storage](#storage) - -## Properties - -### depth +## depth • **depth**: *number* -*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L287)* +*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L287)* ___ -### error +## error • **error**: *string* -*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L288)* +*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L288)* ___ -### gas +## gas • **gas**: *number* -*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L289)* +*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L289)* ___ -### gasCost +## gasCost • **gasCost**: *number* -*Defined in [index.ts:290](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L290)* +*Defined in [index.ts:290](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L290)* ___ -### memory +## memory • **memory**: *string[]* -*Defined in [index.ts:291](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L291)* +*Defined in [index.ts:291](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L291)* ___ -### op +## op • **op**: *[OpCode](#enumeration-opcode)* -*Defined in [index.ts:292](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L292)* +*Defined in [index.ts:292](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L292)* ___ -### pc +## pc • **pc**: *number* -*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L293)* +*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L293)* ___ -### stack +## stack • **stack**: *string[]* -*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L294)* +*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L294)* ___ -### storage +## storage • **storage**: *object* -*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L295)* +*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L295)* #### Type declaration: @@ -4412,521 +3825,453 @@ ___
-> # Interface: TraceParams +# Interface: TraceParams -## Hierarchy +### Hierarchy * **TraceParams** -## Index ### Properties -* [disableMemory](#optional-disablememory) -* [disableStack](#optional-disablestack) -* [disableStorage](#optional-disablestorage) -* [timeout](#optional-timeout) -* [tracer](#optional-tracer) - -## Properties - -### `Optional` disableMemory +## `Optional` disableMemory • **disableMemory**? : *undefined | false | true* -*Defined in [index.ts:510](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L510)* +*Defined in [index.ts:510](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L510)* ___ -### `Optional` disableStack +## `Optional` disableStack • **disableStack**? : *undefined | false | true* -*Defined in [index.ts:511](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L511)* +*Defined in [index.ts:511](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L511)* ___ -### `Optional` disableStorage +## `Optional` disableStorage • **disableStorage**? : *undefined | false | true* -*Defined in [index.ts:512](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L512)* +*Defined in [index.ts:512](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L512)* ___ -### `Optional` timeout +## `Optional` timeout • **timeout**? : *undefined | string* -*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L514)* +*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L514)* ___ -### `Optional` tracer +## `Optional` tracer • **tracer**? : *undefined | string* -*Defined in [index.ts:513](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L513)* +*Defined in [index.ts:513](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L513)*
-> # Interface: Transaction +# Interface: Transaction -## Hierarchy +### Hierarchy * **Transaction** -## Index ### Properties -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [from](#from) -* [gas](#gas) -* [gasPrice](#gasprice) -* [hash](#hash) -* [input](#input) -* [nonce](#nonce) -* [to](#to) -* [transactionIndex](#transactionindex) -* [value](#value) - -## Properties - -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L371)* +*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L371)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* -*Defined in [index.ts:372](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L372)* +*Defined in [index.ts:372](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L372)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:374](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L374)* +*Defined in [index.ts:374](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L374)* ___ -### gas +## gas • **gas**: *number* -*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L378)* +*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L378)* ___ -### gasPrice +## gasPrice • **gasPrice**: *`BigNumber`* -*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L377)* +*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L377)* ___ -### hash +## hash • **hash**: *string* -*Defined in [index.ts:369](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L369)* +*Defined in [index.ts:369](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L369)* ___ -### input +## input • **input**: *string* -*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L379)* +*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L379)* ___ -### nonce +## nonce • **nonce**: *number* -*Defined in [index.ts:370](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L370)* +*Defined in [index.ts:370](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L370)* ___ -### to +## to • **to**: *string | null* -*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L375)* +*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L375)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* -*Defined in [index.ts:373](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L373)* +*Defined in [index.ts:373](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L373)* ___ -### value +## value • **value**: *`BigNumber`* -*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L376)* +*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L376)*
-> # Interface: TransactionReceipt +# Interface: TransactionReceipt -## Hierarchy +### Hierarchy * **TransactionReceipt** * [TransactionReceiptWithDecodedLogs](#class-transactionreceiptwithdecodedlogs) -## Index ### Properties -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [contractAddress](#contractaddress) -* [cumulativeGasUsed](#cumulativegasused) -* [from](#from) -* [gasUsed](#gasused) -* [logs](#logs) -* [status](#status) -* [to](#to) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### blockHash +## blockHash • **blockHash**: *string* -*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L440)* +*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L440)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number* -*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L441)* +*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L441)* ___ -### contractAddress +## contractAddress • **contractAddress**: *string | null* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L449)* ___ -### cumulativeGasUsed +## cumulativeGasUsed • **cumulativeGasUsed**: *number* -*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L447)* +*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L447)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L444)* +*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L444)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L448)* ___ -### logs +## logs • **logs**: *[LogEntry](#class-logentry)[]* -*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L450)* ___ -### status +## status • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L446)* +*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L446)* ___ -### to +## to • **to**: *string* -*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L445)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L442)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number* -*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L443)* +*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L443)*
-> # Interface: TransactionReceiptWithDecodedLogs +# Interface: TransactionReceiptWithDecodedLogs Contains the logs returned by a TransactionReceipt. We attempt to decode the logs using AbiDecoder. If we have the logs corresponding ABI, we decode it, otherwise we don't. -## Hierarchy +### Hierarchy * [TransactionReceipt](#class-transactionreceipt) * **TransactionReceiptWithDecodedLogs** -## Index ### Properties -* [blockHash](#blockhash) -* [blockNumber](#blocknumber) -* [contractAddress](#contractaddress) -* [cumulativeGasUsed](#cumulativegasused) -* [from](#from) -* [gasUsed](#gasused) -* [logs](#logs) -* [status](#status) -* [to](#to) -* [transactionHash](#transactionhash) -* [transactionIndex](#transactionindex) - -## Properties - -### blockHash +## blockHash • **blockHash**: *string* *Inherited from [TransactionReceipt](#blockhash)* -*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L440)* +*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L440)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number* *Inherited from [TransactionReceipt](#blocknumber)* -*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L441)* +*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L441)* ___ -### contractAddress +## contractAddress • **contractAddress**: *string | null* *Inherited from [TransactionReceipt](#contractaddress)* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L449)* ___ -### cumulativeGasUsed +## cumulativeGasUsed • **cumulativeGasUsed**: *number* *Inherited from [TransactionReceipt](#cumulativegasused)* -*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L447)* +*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L447)* ___ -### from +## from • **from**: *string* *Inherited from [TransactionReceipt](#from)* -*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L444)* +*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L444)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* *Inherited from [TransactionReceipt](#gasused)* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L448)* ___ -### logs +## logs • **logs**: *`Array | LogEntry>`* *Overrides [TransactionReceipt](#logs)* -*Defined in [index.ts:506](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L506)* +*Defined in [index.ts:506](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L506)* ___ -### status +## status • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* *Inherited from [TransactionReceipt](#status)* -*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L446)* +*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L446)* ___ -### to +## to • **to**: *string* *Inherited from [TransactionReceipt](#to)* -*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L445)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* *Inherited from [TransactionReceipt](#transactionhash)* -*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L442)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number* *Inherited from [TransactionReceipt](#transactionindex)* -*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L443)* +*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L443)*
-> # Interface: TransactionTrace +# Interface: TransactionTrace -## Hierarchy +### Hierarchy * **TransactionTrace** -## Index ### Properties -* [gas](#gas) -* [returnValue](#returnvalue) -* [structLogs](#structlogs) - -## Properties - -### gas +## gas • **gas**: *number* -*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L299)* +*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L299)* ___ -### returnValue +## returnValue • **returnValue**: *any* -*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L300)* +*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L300)* ___ -### structLogs +## structLogs • **structLogs**: *[StructLog](#class-structlog)[]* -*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L301)* +*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L301)*
-> # Interface: TupleDataItem +# Interface: TupleDataItem -## Hierarchy +### Hierarchy * [DataItem](#class-dataitem) * **TupleDataItem** -## Index ### Properties -* [components](#components) -* [name](#name) -* [type](#type) - -## Properties - -### components +## components • **components**: *[DataItem](#class-dataitem)[]* *Overrides [DataItem](#optional-components)* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L135)* ___ -### name +## name • **name**: *string* *Inherited from [DataItem](#name)* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L129)* ___ -### type +## type • **type**: *string* *Inherited from [DataItem](#type)* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L130)*
-> # Interface: TxData +# Interface: TxData -## Hierarchy +### Hierarchy * [CallTxDataBase](#class-calltxdatabase) @@ -4934,204 +4279,176 @@ ___ * [TxDataPayable](#class-txdatapayable) -## Index ### Properties -* [data](#optional-data) -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-data)* -*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L387)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L392)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gas)* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L385)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gasprice)* -*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L386)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#optional-nonce)* -*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L388)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-to)* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L383)* ___ -### `Optional` value +## `Optional` value • **value**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-value)* -*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L384)*
-> # Interface: TxDataPayable +# Interface: TxDataPayable -## Hierarchy +### Hierarchy * [TxData](#class-txdata) * **TxDataPayable** -## Index ### Properties -* [data](#optional-data) -* [from](#from) -* [gas](#optional-gas) -* [gasPrice](#optional-gasprice) -* [nonce](#optional-nonce) -* [to](#optional-to) -* [value](#optional-value) - -## Properties - -### `Optional` data +## `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-data)* -*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L387)* ___ -### from +## from • **from**: *string* *Inherited from [TxData](#from)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L392)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gas)* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L385)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#optional-gasprice)* -*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L386)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#optional-nonce)* -*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L388)* ___ -### `Optional` to +## `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#optional-to)* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L383)* ___ -### `Optional` value +## `Optional` value • **value**? : *`BigNumber`* *Overrides [CallTxDataBase](#optional-value)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L434)*
-> # Interface: Web3JsV1Provider +# 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. -## Hierarchy +### Hierarchy * **Web3JsV1Provider** -## Index ### Methods -* [send](#send) -* [sendAsync](#sendasync) +## send -## Methods +▸ **send**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -### send - -▸ **send**(`payload`: [JSONRPCRequestPayload](#class-jsonrpcresponsepayload)* - -*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -5143,11 +4460,11 @@ Name | Type | ___ -### sendAsync +## sendAsync ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -5160,29 +4477,24 @@ Name | Type |
-> # Interface: Web3JsV2Provider +# 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 -## Hierarchy +### Hierarchy * **Web3JsV2Provider** -## Index ### Methods -* [send](#send) - -## Methods - -### send +## send ▸ **send**(`payload`: [JSONRPCRequestPayload](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -5195,29 +4507,24 @@ Name | Type |
-> # Interface: Web3JsV3Provider +# 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. -## Hierarchy +### Hierarchy * **Web3JsV3Provider** -## Index ### Methods -* [send](#send) - -## Methods - -### send +## send ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -5230,71 +4537,58 @@ Name | Type |
-> # Interface: ZeroExProvider +# Interface: ZeroExProvider The interface for the provider used internally by 0x libraries Any property we use from any SupportedProvider should we explicitly add here -## Hierarchy +### Hierarchy * **ZeroExProvider** -## Index ### Properties -* [isMetaMask](#optional-ismetamask) -* [isParity](#optional-isparity) -* [isZeroExProvider](#optional-iszeroexprovider) - -### Methods - -* [enable](#optional-enable) -* [sendAsync](#sendasync) -* [stop](#optional-stop) - -## Properties - -### `Optional` isMetaMask +## `Optional` isMetaMask • **isMetaMask**? : *undefined | false | true* -*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L31)* ___ -### `Optional` isParity +## `Optional` isParity • **isParity**? : *undefined | false | true* -*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L32)* ___ -### `Optional` isZeroExProvider +## `Optional` isZeroExProvider • **isZeroExProvider**? : *undefined | false | true* -*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L30)* +*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L30)* -## Methods +### Methods -### `Optional` enable +## `Optional` enable ▸ **enable**(): *`Promise`* -*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* ___ -### sendAsync +## sendAsync ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L35)* +*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -5307,141 +4601,13 @@ Name | Type | ___ -### `Optional` stop +## `Optional` stop ▸ **stop**(): *void* -*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/ethereum-types/src/index.ts#L33)* +*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/a6f43f536/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void*
-* [Globals](globals.md) -* [External Modules]() - * [index](modules/_index_.md) - * [index.AbiType](#class-abitype) - * [index.BlockParamLiteral](#class-blockparamliteral) - * [index.OpCode](#class-opcode) - * [index.SolidityTypes](#class-soliditytypes) - * [index.AbstractBlock](#class-abstractblock) - * [index.BlockWithTransactionData](#class-blockwithtransactiondata) - * [index.BlockWithoutTransactionData](#class-blockwithouttransactiondata) - * [index.CallData](#class-calldata) - * [index.CallTxDataBase](#class-calltxdatabase) - * [index.CompilerOptions](#class-compileroptions) - * [index.CompilerOpts](#class-compileropts) - * [index.CompilerSettings](#class-compilersettings) - * [index.CompilerSettingsMetadata](#class-compilersettingsmetadata) - * [index.ConstructorAbi](#class-constructorabi) - * [index.ContractArtifact](#class-contractartifact) - * [index.ContractNetworkData](#class-contractnetworkdata) - * [index.ContractNetworks](#class-contractnetworks) - * [index.ContractVersionData](#class-contractversiondata) - * [index.DataItem](#class-dataitem) - * [index.DecodedLogArgs](#class-decodedlogargs) - * [index.DecodedLogEntry](#class-decodedlogentry) - * [index.DecodedLogEntryEvent](#class-decodedlogentryevent) - * [index.DevdocOutput](#class-devdocoutput) - * [index.EIP1193Provider](#class-eip1193provider) - * [index.EventAbi](#class-eventabi) - * [index.EventParameter](#class-eventparameter) - * [index.EvmBytecodeOutput](#class-evmbytecodeoutput) - * [index.EvmOutput](#class-evmoutput) - * [index.FallbackAbi](#class-fallbackabi) - * [index.FilterObject](#class-filterobject) - * [index.GanacheProvider](#class-ganacheprovider) - * [index.GeneratedCompilerOptions](#class-generatedcompileroptions) - * [index.JSONRPCRequestPayload](#class-jsonrpcrequestpayload) - * [index.JSONRPCResponseError](#class-jsonrpcresponseerror) - * [index.JSONRPCResponsePayload](#class-jsonrpcresponsepayload) - * [index.LogEntry](#class-logentry) - * [index.LogEntryEvent](#class-logentryevent) - * [index.LogWithDecodedArgs](#class-logwithdecodedargs) - * [index.MethodAbi](#class-methodabi) - * [index.OptimizerSettings](#class-optimizersettings) - * [index.Provider](#class-provider) - * [index.RawLogEntry](#class-rawlogentry) - * [index.SolcError](#class-solcerror) - * [index.Source](#class-source) - * [index.SourceLocation](#class-sourcelocation) - * [index.StandardContractOutput](#class-standardcontractoutput) - * [index.StandardOutput](#class-standardoutput) - * [index.StructLog](#class-structlog) - * [index.TraceParams](#class-traceparams) - * [index.Transaction](#class-transaction) - * [index.TransactionReceipt](#class-transactionreceipt) - * [index.TransactionReceiptWithDecodedLogs](#class-transactionreceiptwithdecodedlogs) - * [index.TransactionTrace](#class-transactiontrace) - * [index.TupleDataItem](#class-tupledataitem) - * [index.TxData](#class-txdata) - * [index.TxDataPayable](#class-txdatapayable) - * [index.Web3JsV1Provider](#class-web3jsv1provider) - * [index.Web3JsV2Provider](#class-web3jsv2provider) - * [index.Web3JsV3Provider](#class-web3jsv3provider) - * [index.ZeroExProvider](#class-zeroexprovider) -* [Enums]() - * [index.AbiType](#class-abitype) - * [index.BlockParamLiteral](#class-blockparamliteral) - * [index.OpCode](#class-opcode) - * [index.SolidityTypes](#class-soliditytypes) -* [Interfaces]() - * [index.AbstractBlock](#class-abstractblock) - * [index.BlockWithTransactionData](#class-blockwithtransactiondata) - * [index.BlockWithoutTransactionData](#class-blockwithouttransactiondata) - * [index.CallData](#class-calldata) - * [index.CallTxDataBase](#class-calltxdatabase) - * [index.CompilerOptions](#class-compileroptions) - * [index.CompilerOpts](#class-compileropts) - * [index.CompilerSettings](#class-compilersettings) - * [index.CompilerSettingsMetadata](#class-compilersettingsmetadata) - * [index.ConstructorAbi](#class-constructorabi) - * [index.ContractArtifact](#class-contractartifact) - * [index.ContractNetworkData](#class-contractnetworkdata) - * [index.ContractNetworks](#class-contractnetworks) - * [index.ContractVersionData](#class-contractversiondata) - * [index.DataItem](#class-dataitem) - * [index.DecodedLogArgs](#class-decodedlogargs) - * [index.DecodedLogEntry](#class-decodedlogentry) - * [index.DecodedLogEntryEvent](#class-decodedlogentryevent) - * [index.DevdocOutput](#class-devdocoutput) - * [index.EIP1193Provider](#class-eip1193provider) - * [index.EventAbi](#class-eventabi) - * [index.EventParameter](#class-eventparameter) - * [index.EvmBytecodeOutput](#class-evmbytecodeoutput) - * [index.EvmOutput](#class-evmoutput) - * [index.FallbackAbi](#class-fallbackabi) - * [index.FilterObject](#class-filterobject) - * [index.GanacheProvider](#class-ganacheprovider) - * [index.GeneratedCompilerOptions](#class-generatedcompileroptions) - * [index.JSONRPCRequestPayload](#class-jsonrpcrequestpayload) - * [index.JSONRPCResponseError](#class-jsonrpcresponseerror) - * [index.JSONRPCResponsePayload](#class-jsonrpcresponsepayload) - * [index.LogEntry](#class-logentry) - * [index.LogEntryEvent](#class-logentryevent) - * [index.LogWithDecodedArgs](#class-logwithdecodedargs) - * [index.MethodAbi](#class-methodabi) - * [index.OptimizerSettings](#class-optimizersettings) - * [index.Provider](#class-provider) - * [index.RawLogEntry](#class-rawlogentry) - * [index.SolcError](#class-solcerror) - * [index.Source](#class-source) - * [index.SourceLocation](#class-sourcelocation) - * [index.StandardContractOutput](#class-standardcontractoutput) - * [index.StandardOutput](#class-standardoutput) - * [index.StructLog](#class-structlog) - * [index.TraceParams](#class-traceparams) - * [index.Transaction](#class-transaction) - * [index.TransactionReceipt](#class-transactionreceipt) - * [index.TransactionReceiptWithDecodedLogs](#class-transactionreceiptwithdecodedlogs) - * [index.TransactionTrace](#class-transactiontrace) - * [index.TupleDataItem](#class-tupledataitem) - * [index.TxData](#class-txdata) - * [index.TxDataPayable](#class-txdatapayable) - * [index.Web3JsV1Provider](#class-web3jsv1provider) - * [index.Web3JsV2Provider](#class-web3jsv2provider) - * [index.Web3JsV3Provider](#class-web3jsv3provider) - * [index.ZeroExProvider](#class-zeroexprovider) - -
- diff --git a/packages/website/ts/utils/algolia_helpers.ts b/packages/website/ts/utils/algolia_helpers.ts index b33102dbf9..445d1b1238 100644 --- a/packages/website/ts/utils/algolia_helpers.ts +++ b/packages/website/ts/utils/algolia_helpers.ts @@ -107,11 +107,11 @@ async function processMdxAsync(algoliaIndex: any, file: File, indexName: string) await remark() .use(slug) // slugify heading text as ids .use(mdx) - .use(() => (tree: Node[]) => processContentTree(tree, file, algoliaIndex, indexName)) + .use(() => async (tree: Node[]) => { await processContentTreeAsync(tree, file, algoliaIndex, indexName); }) .process(content); } -function processContentTree(tree: Node[], file: File, algoliaIndex: any, indexName: string): void { +async function processContentTreeAsync(tree: Node[], file: File, algoliaIndex: any, indexName: string): Promise { const modify = modifyChildren(modifier); // We first modify the tree to get slugified ids from headings to all text nodes // This is done to be able to link to a certain section in a doc after clicking a search suggestion @@ -127,7 +127,7 @@ function processContentTree(tree: Node[], file: File, algoliaIndex: any, indexNa // Adds meta and formats information on all formatted text nodes const content = getContent(file, formattedTextNodes, indexName); - void pushObjectsToAlgoliaAsync(algoliaIndex, content); + await pushObjectsToAlgoliaAsync(algoliaIndex, content); } } diff --git a/packages/website/ts/utils/algolia_meta.json b/packages/website/ts/utils/algolia_meta.json index df6fe38016..ea767a17e2 100644 --- a/packages/website/ts/utils/algolia_meta.json +++ b/packages/website/ts/utils/algolia_meta.json @@ -87,7 +87,7 @@ "tags": ["Trader", "Protocol Developer"], "type": "Typescript Libraries", "path": "tools/@0x/asset-swapper/v1.0.1/reference.mdx", - "versions": ["v1.0.1", "v1.0.0"] + "versions": ["v1.0.1"] }, "0x-js": { "title": "0x.js", @@ -110,7 +110,7 @@ "tags": ["Trader", "Relayer"], "type": "Typescript Libraries", "path": "tools/@0x/connect/v5.0.16/reference.mdx", - "versions": ["v5.0.16", "v5.0.15"] + "versions": ["v5.0.16"] }, "subproviders": { "title": "@0x/subproviders", @@ -122,7 +122,7 @@ "tags": ["Relayer", "Trader"], "type": "Typescript Libraries", "path": "tools/@0x/subproviders/v5.0.1/reference.mdx", - "versions": ["v5.0.1", "v5.0.0"] + "versions": ["v5.0.1"] }, "asset-buyer": { "title": "@0x/asset-buyer", @@ -134,7 +134,7 @@ "tags": ["Trader", "Protocol Developer"], "type": "Typescript Libraries", "path": "tools/@0x/asset-buyer/v6.1.11/reference.mdx", - "versions": ["v6.1.11", "v6.1.10"], + "versions": ["v6.1.11"], "isHidden": true }, "ethereum-types": { @@ -161,7 +161,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/contract-wrappers/v11.0.0/reference.mdx", - "versions": ["v11.0.0", "v10.1.0"] + "versions": ["v11.0.0"] }, "json-schemas": { "title": "@0x/json-schemas", @@ -174,7 +174,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/json-schemas/v3.1.13/reference.mdx", - "versions": ["v3.1.13", "v3.1.12"] + "versions": ["v3.1.13"] }, "order-utils": { "title": "@0x/order-utils", @@ -187,7 +187,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/order-utils/v8.2.5/reference.mdx", - "versions": ["v8.2.5", "v8.2.4"] + "versions": ["v8.2.5"] }, "sol-compiler": { "title": "@0x/sol-compiler", @@ -200,7 +200,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/sol-compiler/v3.1.12/reference.mdx", - "versions": ["v3.1.12", "v3.1.11"] + "versions": ["v3.1.12"] }, "sol-coverage": { "title": "@0x/sol-coverage", @@ -213,7 +213,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/sol-coverage/v3.0.9/reference.mdx", - "versions": ["v3.0.9", "v3.0.8"] + "versions": ["v3.0.9"] }, "sol-profiler": { "title": "@0x/sol-profiler", @@ -226,7 +226,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/sol-profiler/v3.1.11/reference.mdx", - "versions": ["v3.1.11", "v3.1.10"] + "versions": ["v3.1.11"] }, "sol-trace": { "title": "@0x/sol-trace", @@ -239,7 +239,7 @@ "type": "Typescript Libraries", "isHidden": true, "path": "tools/@0x/sol-trace/v2.0.17/reference.mdx", - "versions": ["v2.0.17", "v2.0.16"] + "versions": ["v2.0.17"] }, "web3-wrapper": { "title": "@0x/web3-wrapper", @@ -423,7 +423,7 @@ "tags": ["Protocol Developer", "Relayer"], "type": "Command-line tool", "path": "tools/@0x/migrations/v4.2.0/reference.mdx", - "versions": ["v4.2.0", "v4.1.11"] + "versions": ["v4.2.0"] }, "launch-kit-wizard": { "title": "@0x/launch-kit-wizard", @@ -459,4 +459,4 @@ "externalUrl": "https://github.com/0xProject/0x-coordinator-server" } } -} +} \ No newline at end of file