From 6e2d0ab13d4d3d9ccdc37a1f58bd83604a242c22 Mon Sep 17 00:00:00 2001 From: fabioberger Date: Sun, 25 Aug 2019 22:34:28 +0200 Subject: [PATCH] Update docs to latest format --- packages/asset-buyer/docs/reference.mdx | 585 +- packages/asset-swapper/docs/reference.mdx | 1429 +- packages/connect/docs/reference.mdx | 213 +- packages/contract-wrappers/docs/reference.mdx | 27559 +--------------- packages/ethereum-types/docs/reference.mdx | 2760 +- packages/json-schemas/docs/reference.mdx | 33 +- packages/migrations/docs/reference.mdx | 117 +- packages/order-utils/docs/reference.mdx | 613 +- packages/sol-compiler/docs/reference.mdx | 193 +- packages/sol-coverage/docs/reference.mdx | 66 +- packages/sol-profiler/docs/reference.mdx | 48 +- packages/sol-trace/docs/reference.mdx | 43 +- packages/subproviders/docs/reference.mdx | 1087 +- packages/web3-wrapper/docs/reference.mdx | 827 +- 14 files changed, 3451 insertions(+), 32122 deletions(-) diff --git a/packages/asset-buyer/docs/reference.mdx b/packages/asset-buyer/docs/reference.mdx index 80b2dc620f..5428e22d9c 100644 --- a/packages/asset-buyer/docs/reference.mdx +++ b/packages/asset-buyer/docs/reference.mdx @@ -1,41 +1,17 @@ -> # Class: AssetBuyer +# Class: AssetBuyer -## Hierarchy +### 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 +## constructer \+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[AssetBuyer](#class-assetbuyer)* -*Defined in [asset_buyer.ts:84](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L84)* +*Defined in [asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L41)* +*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L39)* +*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L38)* +*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L40)* +*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L37)* +*Defined in [asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L227)* +*Defined in [asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L297)* +*Defined in [asset_buyer.ts:302](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L126)* +*Defined in [asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L174)* +*Defined in [asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L193)* +*Defined in [asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L306)* +*Defined in [asset_buyer.ts:311](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L54)* +*Defined in [asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/asset_buyer.ts#L73)* +*Defined in [asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/errors.ts#L12)* **Parameters:** @@ -299,43 +262,43 @@ 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/b834b7060/packages/asset-buyer/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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* + ___ -### name +## name • **name**: *string* -*Inherited from void* + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* @@ -343,7 +306,7 @@ ___ ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* @@ -351,38 +314,24 @@ ___
-> # 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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L122)* +*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L115)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L123)* +*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L108)* +*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L108)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L106)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L106)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L48)* ___ -### assetData +## assetData • **assetData**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L52)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L51)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L93)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L97)* +*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L95)* +*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L96)* +*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L62)* ___ -### feeEthAmount +## feeEthAmount • **feeEthAmount**: *`BigNumber`* -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L63)* ___ -### totalEthAmount +## totalEthAmount • **totalEthAmount**: *`BigNumber`* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L73)* ___ -### shouldForceOrderRefresh +## shouldForceOrderRefresh • **shouldForceOrderRefresh**: *boolean* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L74)* ___ -### slippagePercentage +## slippagePercentage • **slippagePercentage**: *number* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L141)* ___ -### tokensAvailableInBaseUnits +## tokensAvailableInBaseUnits • **tokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L33)* #### Type declaration: @@ -1024,275 +891,239 @@ 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/b834b7060/packages/asset-buyer/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L10)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-buyer/src/types.ts#L132)* +*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L132)* ___ -### remainingFillableMakerAssetAmounts +## remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L133)* +*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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* + ___ -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Inherited from void* + ___ -### feeRecipientAddress +## feeRecipientAddress • **feeRecipientAddress**: *string* -*Inherited from void* + ___ -### makerAddress +## makerAddress • **makerAddress**: *string* -*Inherited from void* + ___ -### makerAssetAmount +## makerAssetAmount • **makerAssetAmount**: *`BigNumber`* -*Inherited from void* + ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Inherited from void* + ___ -### makerFee +## makerFee • **makerFee**: *`BigNumber`* -*Inherited from void* + ___ -### `Optional` remainingFillableMakerAssetAmount +## `Optional` remainingFillableMakerAssetAmount • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-buyer/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L26)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Inherited from void* + ___ -### senderAddress +## senderAddress • **senderAddress**: *string* -*Inherited from void* + ___ -### signature +## signature • **signature**: *string* -*Inherited from void* + ___ -### takerAddress +## takerAddress • **takerAddress**: *string* -*Inherited from void* + ___ -### takerAssetAmount +## takerAssetAmount • **takerAssetAmount**: *`BigNumber`* -*Inherited from void* + ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Inherited from void* + ___ -### takerFee +## takerFee • **takerFee**: *`BigNumber`* -*Inherited from void* + diff --git a/packages/asset-swapper/docs/reference.mdx b/packages/asset-swapper/docs/reference.mdx index 5f1ec0b0fc..e958082492 100644 --- a/packages/asset-swapper/docs/reference.mdx +++ b/packages/asset-swapper/docs/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/b834b7060/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/errors.ts#L12)* **Parameters:** @@ -38,43 +25,43 @@ 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/b834b7060/packages/asset-swapper/src/errors.ts#L12)* +*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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* + ___ -### name +## name • **name**: *string* -*Inherited from void* + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* @@ -82,7 +69,7 @@ ___ ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* @@ -90,39 +77,24 @@ ___
-> # 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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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) - -### 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 +## constructer \+ **new SwapQuoter**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [swap_quoter.ts:93](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L93)* +*Defined in [swap_quoter.ts:92](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L41)* +*Defined in [swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L39)* +*Defined in [swap_quoter.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L38)* +*Defined in [swap_quoter.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L40)* +*Defined in [swap_quoter.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L37)* +*Defined in [swap_quoter.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L291)* +*Defined in [swap_quoter.ts:290](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L280)* +*Defined in [swap_quoter.ts:279](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L246)* +*Defined in [swap_quoter.ts:245](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L187)* +*Defined in [swap_quoter.ts:186](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L162)* +*Defined in [swap_quoter.ts:161](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L217)* +*Defined in [swap_quoter.ts:216](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L136)* +*Defined in [swap_quoter.ts:135](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L320)* +*Defined in [swap_quoter.ts:319](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L381)* +*Defined in [swap_quoter.ts:380](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L302)* +*Defined in [swap_quoter.ts:301](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L54)* +*Defined in [swap_quoter.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/swap_quoter.ts#L74)* +*Defined in [swap_quoter.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L102)* +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L102)* ___ -### Forwarder +## Forwarder • **Forwarder**: -*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L101)* +*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L304)* +*Defined in [types.ts:304](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L303)* +*Defined in [types.ts:303](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L305)* +*Defined in [types.ts:305](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L306)* +*Defined in [types.ts:306](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L307)* +*Defined in [types.ts:307](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L320)* +*Defined in [types.ts:320](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L317)* +*Defined in [types.ts:317](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L318)* +*Defined in [types.ts:318](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L319)* +*Defined in [types.ts:319](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L314)* +*Defined in [types.ts:314](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L315)* +*Defined in [types.ts:315](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L316)* +*Defined in [types.ts:316](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L53)* ___ -### methodAbi +## methodAbi • **methodAbi**: *`MethodAbi`* -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L51)* ___ -### toAddress +## toAddress • **toAddress**: *string* -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L76)* ___ -### type +## type • **type**: *`Buy`* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L76)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L93)* +*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L93)* ___ -### type +## type • **type**: *`Sell`* -*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L94)* +*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L84)* +*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L117)* +*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L117)* ___ -### feePercentage +## feePercentage • **feePercentage**: *`BigNumber`* -*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L119)* +*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L119)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L120)* ___ -### feeSignatures +## feeSignatures • **feeSignatures**: *string[]* -*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L118)* +*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L192)* ___ -### feePercentage +## feePercentage • **feePercentage**: *number* -*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L190)* ___ -### feeRecipient +## feeRecipient • **feeRecipient**: *string* -*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L336)* +*Defined in [types.ts:336](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L336)* ___ -### takerTokensAvailableInBaseUnits +## takerTokensAvailableInBaseUnits • **takerTokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [types.ts:337](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L337)* +*Defined in [types.ts:337](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L223)* ___ -### makerAssetFillAmount +## makerAssetFillAmount • **makerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L244)* +*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L222)* ___ -### type +## type • **type**: *`Buy`* -*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L245)* +*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L249)* +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L244)* +*Defined in [types.ts:244](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L245)* +*Defined in [types.ts:245](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L222)* ___ -### takerAssetFillAmount +## takerAssetFillAmount • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L235)* +*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L235)* ___ -### type +## type • **type**: *`Sell`* -*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L236)* +*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L249)* +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L235)* +*Defined in [types.ts:235](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L236)* +*Defined in [types.ts:236](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L11)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L13)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L328)* +*Defined in [types.ts:328](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L328)* ___ -### remainingFillableMakerAssetAmounts +## remainingFillableMakerAssetAmounts • **remainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [types.ts:329](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L329)* +*Defined in [types.ts:329](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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* + ___ -### expirationTimeSeconds +## expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* -*Inherited from void* + ___ -### feeRecipientAddress +## feeRecipientAddress • **feeRecipientAddress**: *string* -*Inherited from void* + ___ -### makerAddress +## makerAddress • **makerAddress**: *string* -*Inherited from void* + ___ -### makerAssetAmount +## makerAssetAmount • **makerAssetAmount**: *`BigNumber`* -*Inherited from void* + ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Inherited from void* + ___ -### makerFee +## makerFee • **makerFee**: *`BigNumber`* -*Inherited from void* + ___ -### `Optional` remainingFillableMakerAssetAmount +## `Optional` remainingFillableMakerAssetAmount • **remainingFillableMakerAssetAmount**? : *`BigNumber`* -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L28)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Inherited from void* + ___ -### senderAddress +## senderAddress • **senderAddress**: *string* -*Inherited from void* + ___ -### signature +## signature • **signature**: *string* -*Inherited from void* + ___ -### takerAddress +## takerAddress • **takerAddress**: *string* -*Inherited from void* + ___ -### takerAssetAmount +## takerAssetAmount • **takerAssetAmount**: *`BigNumber`* -*Inherited from void* + ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Inherited from void* + ___ -### takerFee +## takerFee • **takerFee**: *`BigNumber`* -*Inherited from void* +
-> # 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/b834b7060/packages/asset-swapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L75)* ___ -### signatures +## signatures • **signatures**: *string[]* -*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L66)* ___ -### methodAbi +## methodAbi • **methodAbi**: *`MethodAbi`* -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L67)* ___ -### params +## params • **params**: *`T`* -*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L64)* ___ -### toAddress +## toAddress • **toAddress**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L226)* +*Defined in [types.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L226)* ___ -### feeOrders +## feeOrders • **feeOrders**: *`SignedOrder`[]* -*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L225)* +*Defined in [types.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L225)* ___ -### makerAssetData +## makerAssetData • **makerAssetData**: *string* -*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L223)* +*Defined in [types.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L223)* ___ -### orders +## orders • **orders**: *`SignedOrder`[]* -*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L224)* +*Defined in [types.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L224)* ___ -### takerAssetData +## takerAssetData • **takerAssetData**: *string* -*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L222)* +*Defined in [types.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L227)* +*Defined in [types.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L158)* +*Defined in [types.ts:158](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L202)* +*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L203)* +*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L180)* +*Defined in [types.ts:180](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L181)* +*Defined in [types.ts:181](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L179)* +*Defined in [types.ts:179](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L192)* +*Defined in [types.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L190)* +*Defined in [types.ts:190](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L191)* +*Defined in [types.ts:191](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L202)* +*Defined in [types.ts:202](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L203)* +*Defined in [types.ts:203](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L265)* +*Defined in [types.ts:265](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L265)* ___ -### makerTokenAmount +## makerTokenAmount • **makerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:268](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L268)* +*Defined in [types.ts:268](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L268)* ___ -### takerTokenAmount +## takerTokenAmount • **takerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:267](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L267)* +*Defined in [types.ts:267](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L267)* ___ -### totalTakerTokenAmount +## totalTakerTokenAmount • **totalTakerTokenAmount**: *`BigNumber`* -*Defined in [types.ts:266](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L266)* +*Defined in [types.ts:266](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L278)* +*Defined in [types.ts:278](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L278)* ___ -### shouldForceOrderRefresh +## shouldForceOrderRefresh • **shouldForceOrderRefresh**: *boolean* -*Defined in [types.ts:277](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L277)* +*Defined in [types.ts:277](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L277)* ___ -### slippagePercentage +## slippagePercentage • **slippagePercentage**: *number* -*Defined in [types.ts:279](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L279)* +*Defined in [types.ts:279](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/asset-swapper/src/types.ts#L296)* +*Defined in [types.ts:296](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L296)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:294](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L294)* +*Defined in [types.ts:294](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L294)* ___ -### orderRefreshIntervalMs +## orderRefreshIntervalMs • **orderRefreshIntervalMs**: *number* -*Defined in [types.ts:295](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/asset-swapper/src/types.ts#L295)* +*Defined in [types.ts:295](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L295)*
-> # Interface: SwapQuoteWithAffiliateFeeBase +# Interface: SwapQuoteWithAffiliateFeeBase -## Hierarchy +### Hierarchy * **SwapQuoteWithAffiliateFeeBase** @@ -3259,19 +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/b834b7060/packages/asset-swapper/src/types.ts#L249)* +*Defined in [types.ts:249](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-swapper/src/types.ts#L249)*
diff --git a/packages/connect/docs/reference.mdx b/packages/connect/docs/reference.mdx index ae43de6e6e..e2934f9c68 100644 --- a/packages/connect/docs/reference.mdx +++ b/packages/connect/docs/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/b834b7060/packages/connect/src/http_client.ts#L44)* +*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L59)* +*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L160)* +*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L99)* +*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L139)* +*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L117)* +*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L79)* +*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/http_client.ts#L177)* +*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [close](#close) -* [subscribe](#subscribe) - -## Constructors - -### constructor +## constructer \+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *[WebSocketOrdersChannel](#class-websocketorderschannel)* -*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/ws_orders_channel.ts#L21)* +*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/ws_orders_channel.ts#L66)* +*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/ws_orders_channel.ts#L50)* +*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L46)* ___ -### Post +## Post • **Post**: = "POST" -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/connect/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/connect/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L35)* #### Type declaration: @@ -600,13 +539,13 @@ Name | Type |
-> # Interface: OrdersChannelSubscriptionOptsMap +# Interface: OrdersChannelSubscriptionOptsMap -## Hierarchy +### Hierarchy * **OrdersChannelSubscriptionOptsMap** -## Indexable +### Indexable ● \[▪ **key**: *string*\]: `OrdersChannelSubscriptionOpts` diff --git a/packages/contract-wrappers/docs/reference.mdx b/packages/contract-wrappers/docs/reference.mdx index 1a02871ce4..fe91e0ef15 100644 --- a/packages/contract-wrappers/docs/reference.mdx +++ b/packages/contract-wrappers/docs/reference.mdx @@ -1,41 +1,19 @@ -> # Class: ContractWrappers +# Class: ContractWrappers The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. -## Hierarchy +### Hierarchy * **ContractWrappers** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [coordinator](#coordinator) -* [dutchAuction](#dutchauction) -* [erc20Proxy](#erc20proxy) -* [erc721Proxy](#erc721proxy) -* [exchange](#exchange) -* [forwarder](#forwarder) -* [orderValidator](#ordervalidator) -* [weth9](#weth9) - -### Methods - -* [getAbiDecoder](#getabidecoder) -* [getProvider](#getprovider) -* [unsubscribeAll](#unsubscribeall) - -## Constructors - -### constructor +## constructer \+ **new ContractWrappers**(`supportedProvider`: `SupportedProvider`, `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* -*Defined in [contract_wrappers.ts:72](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L72)* +*Defined in [contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L78)* Instantiates a new ContractWrappers instance. @@ -50,96 +28,106 @@ Name | Type | Description | An instance of the ContractWrappers class. -## Properties +### Properties -### coordinator +## contractAddresses + +• **contractAddresses**: *`ContractAddresses`* + +*Defined in [contract_wrappers.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L41)* + +An index of the default contract addresses for this network. + +___ + +## coordinator • **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* -*Defined in [contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L70)* +*Defined in [contract_wrappers.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L76)* An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. ___ -### dutchAuction +## dutchAuction -• **dutchAuction**: *[DutchAuctionContract](#class-dutchauctioncontract)* +• **dutchAuction**: *`DutchAuctionContract`* -*Defined in [contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L66)* +*Defined in [contract_wrappers.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L72)* An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. ___ -### erc20Proxy +## erc20Proxy -• **erc20Proxy**: *[ERC20ProxyContract](#class-erc20proxycontract)* +• **erc20Proxy**: *`ERC20ProxyContract`* -*Defined in [contract_wrappers.ts:44](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L44)* +*Defined in [contract_wrappers.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L50)* An instance of the ERC20ProxyContract class containing methods for interacting with the erc20Proxy smart contract. ___ -### erc721Proxy +## erc721Proxy -• **erc721Proxy**: *[ERC721ProxyContract](#class-erc721proxycontract)* +• **erc721Proxy**: *`ERC721ProxyContract`* -*Defined in [contract_wrappers.ts:49](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L49)* +*Defined in [contract_wrappers.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L55)* An instance of the ERC721ProxyContract class containing methods for interacting with the erc721Proxy smart contract. ___ -### exchange +## exchange -• **exchange**: *[ExchangeContract](#class-exchangecontract)* +• **exchange**: *`ExchangeContract`* -*Defined in [contract_wrappers.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L39)* +*Defined in [contract_wrappers.ts:45](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L45)* An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. ___ -### forwarder +## forwarder -• **forwarder**: *[ForwarderContract](#class-forwardercontract)* +• **forwarder**: *`ForwarderContract`* -*Defined in [contract_wrappers.ts:58](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L58)* +*Defined in [contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L64)* An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. ___ -### orderValidator +## orderValidator -• **orderValidator**: *[OrderValidatorContract](#class-ordervalidatorcontract)* +• **orderValidator**: *`OrderValidatorContract`* -*Defined in [contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L62)* +*Defined in [contract_wrappers.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L68)* An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. ___ -### weth9 +## weth9 -• **weth9**: *[WETH9Contract](#class-weth9contract)* +• **weth9**: *`WETH9Contract`* -*Defined in [contract_wrappers.ts:54](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L54)* +*Defined in [contract_wrappers.ts:60](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L60)* An instance of the WETH9Contract class containing methods for interacting with the WETH9 smart contract. -## Methods +### Methods -### getAbiDecoder +## getAbiDecoder ▸ **getAbiDecoder**(): *`AbiDecoder`* -*Defined in [contract_wrappers.ts:140](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L140)* +*Defined in [contract_wrappers.ts:147](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L147)* Get the abi decoder instance currently used by contract-wrappers @@ -149,11 +137,11 @@ AbiDecoder instance ___ -### getProvider +## getProvider ▸ **getProvider**(): *`SupportedProvider`* -*Defined in [contract_wrappers.ts:133](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L133)* +*Defined in [contract_wrappers.ts:140](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L140)* Get the provider instance currently used by contract-wrappers @@ -163,11 +151,11 @@ Web3 provider instance ___ -### unsubscribeAll +## unsubscribeAll ▸ **unsubscribeAll**(): *void* -*Defined in [contract_wrappers.ts:123](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/contract_wrappers.ts#L123)* +*Defined in [contract_wrappers.ts:130](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/contract_wrappers.ts#L130)* Unsubscribes from all subscriptions for all contracts. @@ -175,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 [coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* +*Defined in [coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* Instantiate CoordinatorWrapper @@ -240,53 +195,53 @@ Name | Type | Description | **Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* -## Properties +### Properties -### abi +## abi • **abi**: *`ContractAbi`* = Coordinator.compilerOutput.abi -*Defined in [coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* +*Defined in [coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* ___ -### address +## address • **address**: *string* -*Defined in [coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* +*Defined in [coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* ___ -### exchangeAddress +## exchangeAddress • **exchangeAddress**: *string* -*Defined in [coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* +*Defined in [coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* +*Defined in [coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* ___ -### registryAddress +## registryAddress • **registryAddress**: *string* -*Defined in [coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* +*Defined in [coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 [coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L637)* +*Defined in [coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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. @@ -305,11 +260,11 @@ Name | Type | Description | ___ -### batchFillOrKillOrdersAsync +## batchFillOrKillOrdersAsync ▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* +*Defined in [coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. @@ -328,11 +283,11 @@ Transaction hash. ___ -### batchFillOrdersAsync +## batchFillOrdersAsync ▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L203)* +*Defined in [coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -356,11 +311,11 @@ Transaction hash. ___ -### batchFillOrdersNoThrowAsync +## batchFillOrdersNoThrowAsync ▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* +*Defined in [coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* No throw version of batchFillOrdersAsync @@ -379,11 +334,11 @@ Transaction hash. ___ -### batchHardCancelOrdersAsync +## batchHardCancelOrdersAsync ▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L568)* +*Defined in [coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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. @@ -401,11 +356,11 @@ Transaction hash. ___ -### batchSoftCancelOrdersAsync +## batchSoftCancelOrdersAsync ▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* +*Defined in [coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* Batch version of softCancelOrderAsync. Requests multiple soft cancels @@ -421,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 [coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L166)* +*Defined in [coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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. @@ -445,11 +400,11 @@ Transaction hash. ___ -### fillOrderAsync +## fillOrderAsync ▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* +*Defined in [coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -472,11 +427,11 @@ Transaction hash. ___ -### fillOrderNoThrowAsync +## fillOrderNoThrowAsync ▸ **fillOrderNoThrowAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L133)* +*Defined in [coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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. @@ -495,11 +450,11 @@ Transaction hash. ___ -### getSignerAddressAsync +## getSignerAddressAsync ▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* -*Defined in [coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* +*Defined in [coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* Recovers the address of a signer given a hash and signature. @@ -516,11 +471,11 @@ Signer address. ___ -### hardCancelOrderAsync +## hardCancelOrderAsync ▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* +*Defined in [coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* Cancels an order on-chain by submitting an Ethereum transaction. @@ -537,11 +492,11 @@ Transaction hash. ___ -### hardCancelOrdersUpToAsync +## hardCancelOrdersUpToAsync ▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L603)* +*Defined in [coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -561,11 +516,11 @@ Transaction hash. ___ -### marketBuyOrdersAsync +## marketBuyOrdersAsync ▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L313)* +*Defined in [coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -589,11 +544,11 @@ Transaction hash. ___ -### marketBuyOrdersNoThrowAsync +## marketBuyOrdersNoThrowAsync ▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* +*Defined in [coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* No throw version of marketBuyOrdersAsync @@ -612,11 +567,11 @@ Transaction hash. ___ -### marketSellOrdersAsync +## marketSellOrdersAsync ▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L351)* +*Defined in [coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -640,11 +595,11 @@ Transaction hash. ___ -### marketSellOrdersNoThrowAsync +## marketSellOrdersNoThrowAsync ▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* -*Defined in [coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* +*Defined in [coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* No throw version of marketSellOrdersAsync @@ -663,11 +618,11 @@ Transaction hash. ___ -### softCancelOrderAsync +## softCancelOrderAsync ▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* -*Defined in [coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/coordinator_wrapper.ts#L447)* +*Defined in [coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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. @@ -685,19672 +640,24 @@ CoordinatorServerCancellationResponse. See [Cancellation Response](https://githu
-> # Class: AssetProxyOwnerContract +# Class: IWalletContract -## Hierarchy - -* `BaseContract` - - * **AssetProxyOwnerContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [MAX_OWNER_COUNT](#max_owner_count) -* [addOwner](#addowner) -* [changeRequirement](#changerequirement) -* [changeTimeLock](#changetimelock) -* [confirmTransaction](#confirmtransaction) -* [confirmationTimes](#confirmationtimes) -* [confirmations](#confirmations) -* [executeRemoveAuthorizedAddressAtIndex](#executeremoveauthorizedaddressatindex) -* [executeTransaction](#executetransaction) -* [getConfirmationCount](#getconfirmationcount) -* [getConfirmations](#getconfirmations) -* [getOwners](#getowners) -* [getTransactionCount](#gettransactioncount) -* [getTransactionIds](#gettransactionids) -* [isAssetProxyRegistered](#isassetproxyregistered) -* [isConfirmed](#isconfirmed) -* [isOwner](#isowner) -* [owners](#owners) -* [registerAssetProxy](#registerassetproxy) -* [removeOwner](#removeowner) -* [replaceOwner](#replaceowner) -* [required](#required) -* [revokeConfirmation](#revokeconfirmation) -* [secondsTimeLocked](#secondstimelocked) -* [submitTransaction](#submittransaction) -* [transactionCount](#transactioncount) -* [transactions](#transactions) - -## Constructors - -### constructor - -\+ **new AssetProxyOwnerContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[AssetProxyOwnerContract](#class-assetproxyownercontract)* - -*Overrides void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3959](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3959)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[AssetProxyOwnerContract](#class-assetproxyownercontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [AssetProxyOwnerEvents](#enumeration-assetproxyownerevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3943](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3943)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[AssetProxyOwnerEventArgs](#assetproxyownereventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`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>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [AssetProxyOwnerEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3901](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3901)* - -Subscribe to an event type emitted by the AssetProxyOwner contract. - -**Type parameters:** - -▪ **ArgsType**: *[AssetProxyOwnerEventArgs](#assetproxyownereventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3926](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3926)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3932](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3932)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3189](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3189)* - -**Returns:** *`ContractAbi`* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: `ContractAbi`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_owners`: string[], `_assetProxyContracts`: string[], `_required`: `BigNumber`, `_secondsTimeLocked`: `BigNumber`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3139](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3139)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | `ContractAbi` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_owners` | string[] | -`_assetProxyContracts` | string[] | -`_required` | `BigNumber` | -`_secondsTimeLocked` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: `SupportedProvider`, `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_owners`: string[], `_assetProxyContracts`: string[], `_required`: `BigNumber`, `_secondsTimeLocked`: `BigNumber`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3100](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3100)* - -**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* - -*Inherited from void* - - - -**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:2633](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2633)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2639](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2639)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:2687](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2687)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2680](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2680)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2675](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2675)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1145](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1145)* - -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:1181](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1181)* - -Sends an Ethereum transaction and waits 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 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, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1233](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1233)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`owner` | string | - | Address of new owner. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | `BlockParam` | - | - | - -**Returns:** *`Promise`* - -### estimateGasAsync - -▸ **estimateGasAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1208](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1208)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`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:1284](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1284)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1277](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1277)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`owner`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1271](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1271)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`owner` | string | Address of new owner. | - -**Returns:** *string* - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`owner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1153](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1153)* - -Sends an 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 - -___ - -### changeRequirement - -### ▪ **changeRequirement**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2048](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2048)* - -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:2084](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2084)* - -Sends an Ethereum transaction and waits 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:2136](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2136)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2111](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2111)* - -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:2191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2191)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2184](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2184)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_required`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2178](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2178)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2056](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2056)* - -Sends an 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 - -___ - -### changeTimeLock - -### ▪ **changeTimeLock**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1369](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1369)* - -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:1410](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1410)* - -Sends an Ethereum transaction and waits 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:1464](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1464)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1438](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1438)* - -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:1522](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1522)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1515](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1515)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_secondsTimeLocked`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1507](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1507)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1378](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1378)* - -Sends an 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 - -___ - -### confirmTransaction - -### ▪ **confirmTransaction**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2202](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2202)* - -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:2238](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2238)* - -Sends an Ethereum transaction and waits 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:2290](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2290)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2265](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2265)* - -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:2347](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2347)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2340](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2340)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2332](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2332)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2210](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2210)* - -Sends an 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 - -___ - -### confirmationTimes - -### ▪ **confirmationTimes**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2565](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2565)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2571](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2571)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:2625](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2625)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2618](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2618)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2612](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2612)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:564](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L564)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:570](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.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 | ------- | ------ | ------ | -`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:633](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L633)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:626](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L626)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`, `index_1`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:616](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L616)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:644](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L644)* - -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:682](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L682)* - -Sends an Ethereum transaction and waits 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:739](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L739)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:712](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L712)* - -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:799](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L799)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:792](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L792)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:783](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L783)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:652](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L652)* - -Sends an 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 - -___ - -### executeTransaction - -### ▪ **executeTransaction**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2946](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2946)* - -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:2982](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2982)* - -Sends an Ethereum transaction and waits 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:3034](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3034)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:3009](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3009)* - -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:3091](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3091)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3084](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3084)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:3076](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L3076)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2954](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2954)* - -Sends an 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 - -___ - -### getConfirmationCount - -### ▪ **getConfirmationCount**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1603](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1603)* - -Returns number of confirmations of a transaction. - -### callAsync - -▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1611](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1611)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1668](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1668)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1661](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1661)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1653](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1653)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1912](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1912)* - -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:1920](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1920)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1975](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1975)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1968](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1968)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1962](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1962)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1749](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1749)* - -Returns list of owners. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1756](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1756)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:1804](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1804)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1797](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1797)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1792](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1792)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:872](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L872)* - -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:881](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L881)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:943](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L943)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:936](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L936)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`pending`: boolean, `executed`: boolean): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:926](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L926)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`pending` | boolean | Include pending transactions. | -`executed` | boolean | Include executed transactions. | - -**Returns:** *string* - -___ - -### getTransactionIds - -### ▪ **getTransactionIds**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1815](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1815)* - -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:1826](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1826)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1901](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1901)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1894](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1894)* - -**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:1882](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1882)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1530](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1530)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1536](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1536)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1592](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1592)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1585](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1585)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1577](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1577)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1295](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1295)* - -Returns the confirmation status of a transaction. - -### callAsync - -▸ **callAsync**(`transactionId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1303](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1303)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1358](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1358)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1351](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1351)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1345)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:496](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L496)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:502](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L502)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:556](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L556)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:549](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L549)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:543](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L543)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:955](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L955)* - -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:1001](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1001)* - -Sends an Ethereum transaction and waits 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:1069](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1069)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1035](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1035)* - -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:1134](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1134)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1127](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1127)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxyContract`: string, `isRegistered`: boolean): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1117](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1117)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:964](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L964)* - -Sends an 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 - -___ - -### removeOwner - -### ▪ **removeOwner**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### replaceOwner - -### ▪ **replaceOwner**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2760](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2760)* - -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:2806](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2806)* - -Sends an Ethereum transaction and waits 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:2870](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2870)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2840](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2840)* - -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:2935](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2935)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2928](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2928)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`owner`: string, `newOwner`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2918](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2918)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2769](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2769)* - -Sends an 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 - -___ - -### required - -### ▪ **required**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2695](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2695)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2701](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2701)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:2749](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2749)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2742](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2742)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2737](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2737)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:343](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L343)* - -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:379](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L379)* - -Sends an Ethereum transaction and waits 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:431](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L431)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:406](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L406)* - -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:488](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L488)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:481](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L481)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactionId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:473](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L473)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:351](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L351)* - -Sends an 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 - -___ - -### secondsTimeLocked - -### ▪ **secondsTimeLocked**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:807](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L807)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:813](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L813)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:861](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L861)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:854](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L854)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:849](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L849)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:2358](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2358)* - -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:2409](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2409)* - -Sends an Ethereum transaction and waits 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:2486](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2486)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:2447](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2447)* - -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:2557](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2557)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2550](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2550)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`destination`: string, `value`: `BigNumber`, `data`: string): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2538](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2538)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2368](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2368)* - -Sends an 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 - -___ - -### transactionCount - -### ▪ **transactionCount**: *object* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1983](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1983)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1989](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1989)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:2037](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2037)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2030](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2030)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:2025](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L2025)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1676](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1676)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise<[string, BigNumber, string, boolean]>`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1682](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1682)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1736](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1736)* - -**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:1729](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1729)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *[string, `BigNumber`, string, boolean]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:1723](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L1723)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [EIP712_COORDINATOR_DOMAIN_HASH](#eip712_coordinator_domain_hash) -* [EIP712_EXCHANGE_DOMAIN_HASH](#eip712_exchange_domain_hash) -* [assertValidCoordinatorApprovals](#assertvalidcoordinatorapprovals) -* [decodeOrdersFromFillData](#decodeordersfromfilldata) -* [executeTransaction](#executetransaction) -* [getCoordinatorApprovalHash](#getcoordinatorapprovalhash) -* [getSignerAddress](#getsigneraddress) -* [getTransactionHash](#gettransactionhash) - -## Constructors - -### constructor - -\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorContract](#class-coordinatorcontract)* - -*Overrides void* - -*Defined in [generated-wrappers/coordinator.ts:1363](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1363)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/coordinator.ts:1069](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1069)* - -**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:1022](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L1022)* - -**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:989](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L989)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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:927](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L927)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/coordinator.ts:933](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L933)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:981](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L981)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/coordinator.ts:974](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L974)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/coordinator.ts:969](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L969)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:571](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L571)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/coordinator.ts:577](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L577)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:625](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L625)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/coordinator.ts:618](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L618)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/coordinator.ts:613](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L613)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:637](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.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. - -### callAsync - -▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/coordinator.ts:652](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L652)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L753)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/coordinator.ts:744](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L744)* - -**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:720](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L720)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:766](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L766)* - -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:774](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L774)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:889](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L889)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`Array`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* - -*Defined in [generated-wrappers/coordinator.ts:852](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L852)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`Array`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`data`: string): *string* - -*Defined in [generated-wrappers/coordinator.ts:846](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L846)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### getCoordinatorApprovalHash - -### ▪ **getCoordinatorApprovalHash**: *object* - -*Defined in [generated-wrappers/coordinator.ts:191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [getCoordinatorEndpoint](#getcoordinatorendpoint) -* [setCoordinatorEndpoint](#setcoordinatorendpoint) - -## Constructors - -### constructor - -\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* - -*Overrides void* - -*Defined in [generated-wrappers/coordinator_registry.ts:486](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L486)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/coordinator_registry.ts:470](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L470)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | The CoordinatorRegistry contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [generated-wrappers/coordinator_registry.ts:428](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L428)* - -Subscribe to an event type emitted by the CoordinatorRegistry contract. - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/coordinator_registry.ts:453](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L453)* - -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:459](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L459)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/coordinator_registry.ts:356](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L356)* - -**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:314](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L314)* - -**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:283](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L283)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### getCoordinatorEndpoint - -### ▪ **getCoordinatorEndpoint**: *object* - -*Defined in [generated-wrappers/coordinator_registry.ts:208](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L208)* - -Gets the endpoint for a Coordinator. - -### callAsync - -▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/coordinator_registry.ts:215](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L215)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | 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:274](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L274)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/coordinator_registry.ts:267](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L267)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`coordinatorOperator`: string): *string* - -*Defined in [generated-wrappers/coordinator_registry.ts:259](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L259)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -
- -> # Class: DummyERC20TokenContract - -## Hierarchy - -* `BaseContract` - - * **DummyERC20TokenContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [MAX_MINT_AMOUNT](#max_mint_amount) -* [allowance](#allowance) -* [approve](#approve) -* [balanceOf](#balanceof) -* [decimals](#decimals) -* [mint](#mint) -* [name](#name) -* [owner](#owner) -* [setBalance](#setbalance) -* [symbol](#symbol) -* [totalSupply](#totalsupply) -* [transfer](#transfer) -* [transferFrom](#transferfrom) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -*Overrides void* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:2117](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2117)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:2101](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2101)* - -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:2059](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2059)* - -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:2084](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2084)* - -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:2090](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2090)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1730](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1730)* - -**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:1680](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1680)* - -**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:1641](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1641)* - -**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* - -*Inherited from void* - - - -**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:1578](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1578)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1584](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1584)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:1632](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1632)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1625](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1625)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1620](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1620)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1166](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1166)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1175](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1175)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | 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:1240](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1240)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1233](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1233)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1223](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1223)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:647](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L647)* - -Query the balance of owner - -### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:655](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L655)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:710](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L710)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:703](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L703)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:697](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L697)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:582](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L582)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:588](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L588)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:636](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L636)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:629](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L629)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:624](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L624)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:845](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L845)* - -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:881](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L881)* - -Sends an Ethereum transaction and waits 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:933](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L933)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:908](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L908)* - -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:984](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L984)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:977](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L977)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:971](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L971)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:853](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L853)* - -Sends an 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 - -___ - -### name - -### ▪ **name**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:718](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L718)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:724](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L724)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L772)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:765](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L765)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:760](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L760)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -___ - -### setBalance - -### ▪ **setBalance**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1251](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1251)* - -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:1297](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1297)* - -Sends an Ethereum transaction and waits 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:1361](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1361)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1327](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1327)* - -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:1426](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1426)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1419](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1419)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1409](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1409)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1260](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1260)* - -Sends an 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 - -___ - -### symbol - -### ▪ **symbol**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:780](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L780)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:786](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L786)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:834](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L834)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:827](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L827)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:822](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L822)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -___ - -### totalSupply - -### ▪ **totalSupply**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:309](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L309)* - -Query total supply of token - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:316](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L316)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:364](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L364)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:357](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L357)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:352](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L352)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:995](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L995)* - -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:1038](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1038)* - -Sends an Ethereum transaction and waits 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:1096](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1096)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1068](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1068)* - -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:1158](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1158)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1151](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1151)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1141](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.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 | ------- | ------ | ------ | -`_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:1004](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1004)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:375](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L375)* - -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:426](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L426)* - -Sends an Ethereum transaction and waits 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:503](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L503)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | 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:464](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L464)* - -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:574](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L574)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:567](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L567)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:555](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L555)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:385](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L385)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1434](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1434)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1468](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1468)* - -Sends an Ethereum transaction and waits 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:1518](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1518)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1494](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1494)* - -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:1570](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1570)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1563](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1563)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/dummy_erc20_token.ts:1555](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1555)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1441](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1441)* - -Sends an 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 - -
- -> # Class: DummyERC721TokenContract - -## Hierarchy - -* `BaseContract` - - * **DummyERC721TokenContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [approve](#approve) -* [balanceOf](#balanceof) -* [burn](#burn) -* [getApproved](#getapproved) -* [isApprovedForAll](#isapprovedforall) -* [mint](#mint) -* [name](#name) -* [owner](#owner) -* [ownerOf](#ownerof) -* [safeTransferFrom1](#safetransferfrom1) -* [safeTransferFrom2](#safetransferfrom2) -* [setApprovalForAll](#setapprovalforall) -* [symbol](#symbol) -* [transferFrom](#transferfrom) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -*Overrides void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:2617](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2617)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:2601](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2601)* - -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:2559](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2559)* - -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:2584](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2584)* - -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:2590](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2590)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:2182](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2182)* - -**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:2134](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2134)* - -**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:2099](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2099)* - -**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* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1070](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1070)* - -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:1078](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1078)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1133](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1133)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1126](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1126)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1120](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1120)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | An address for whom to query the balance | - -**Returns:** *string* - -___ - -### burn - -### ▪ **burn**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1269](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1269)* - -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:1312](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1312)* - -Sends an Ethereum transaction and waits 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:1373](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1373)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1342](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1342)* - -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:1435](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1435)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1428](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1428)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1418](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1418)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1278](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1278)* - -Sends an 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 - -___ - -### getApproved - -### ▪ **getApproved**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:1872](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1872)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1881](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1881)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1946](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1946)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1939](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1939)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1929](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1929)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:607](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L607)* - -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:650](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L650)* - -Sends an Ethereum transaction and waits 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:711](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L711)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:680](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L680)* - -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:773](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L773)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L766)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:756](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L756)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:616](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L616)* - -Sends an 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 - -___ - -### name - -### ▪ **name**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:1141](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1141)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1147](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1147)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:1195](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1195)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1188](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1188)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1183](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1183)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:995](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L995)* - -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:1003](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1003)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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/dummy_erc721_token.ts:1058](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1058)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1051](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1051)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1045](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1045)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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/dummy_erc721_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L785)* - -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/dummy_erc721_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L836)* - -Sends an Ethereum transaction and waits 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:912](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L912)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:874](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L874)* - -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:983](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L983)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L976)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:964](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L964)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:795](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L795)* - -Sends an 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 - -___ - -### safeTransferFrom2 - -### ▪ **safeTransferFrom2**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1643](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1643)* - -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:1705](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1705)* - -Sends an Ethereum transaction and waits 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:1789](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1789)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1747](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1747)* - -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:1864](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1864)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1857](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1857)* - -**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:1845](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1845)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1654](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1654)* - -Sends an 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 - -___ - -### setApprovalForAll - -### ▪ **setApprovalForAll**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1447](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1447)* - -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:1493](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1493)* - -Sends an Ethereum transaction and waits 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:1561](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1561)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1527](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1527)* - -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:1626](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1626)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1619](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1619)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1609](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1609)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1456](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1456)* - -Sends an 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 - -___ - -### symbol - -### ▪ **symbol**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1203](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1203)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1209](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1209)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:1257](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1257)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1250](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1250)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1245](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1245)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:397](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L397)* - -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:448](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L448)* - -Sends an Ethereum transaction and waits 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:524](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L524)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**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:486](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L486)* - -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:595](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L595)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:588](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L588)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:576](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L576)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:407](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L407)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1954](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1954)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1988](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1988)* - -Sends an Ethereum transaction and waits 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:2038](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2038)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:2014](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2014)* - -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:2090](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2090)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:2083](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2083)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:2075](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.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). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/dummy_erc721_token.ts:1961](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.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 | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -> # Class: DutchAuctionContract - -## Hierarchy - -* `BaseContract` - - * **DutchAuctionContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [getAuctionDetails](#getauctiondetails) -* [matchOrders](#matchorders) - -## Constructors - -### constructor - -\+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DutchAuctionContract](#class-dutchauctioncontract)* - -*Overrides void* - -*Defined in [generated-wrappers/dutch_auction.ts:1151](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L1151)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/dutch_auction.ts:859](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L859)* - -**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:812](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L812)* - -**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/dutch_auction.ts:779](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L779)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### getAuctionDetails - -### ▪ **getAuctionDetails**: *object* - -*Defined in [generated-wrappers/dutch_auction.ts:33](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L33)* - -Calculates the Auction Details for the given order - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/dutch_auction.ts:87](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L87)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The sell order | -`txData?` | `Partial` | Additional data for transaction | -`pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | -`timeoutMs?` | undefined \| number | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -### callAsync - -▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/dutch_auction.ts:170](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### matchOrders - -### ▪ **matchOrders**: *object* - -*Defined in [generated-wrappers/dutch_auction.ts:332](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L332)* - -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:414](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L414)* - -Sends an Ethereum transaction and waits 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:549](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L549)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:482](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L482)* - -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:739](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L739)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/dutch_auction.ts:700](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L700)* - -**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:659](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L659)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/dutch_auction.ts#L345)* - -Sends an 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 - -
- -> # Class: ERC20ProxyContract - -## Hierarchy - -* `BaseContract` - - * **ERC20ProxyContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [addAuthorizedAddress](#addauthorizedaddress) -* [authorities](#authorities) -* [authorized](#authorized) -* [getAuthorizedAddresses](#getauthorizedaddresses) -* [getProxyId](#getproxyid) -* [owner](#owner) -* [removeAuthorizedAddress](#removeauthorizedaddress) -* [removeAuthorizedAddressAtIndex](#removeauthorizedaddressatindex) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20ProxyContract](#class-erc20proxycontract)* - -*Overrides void* - -*Defined in [generated-wrappers/erc20_proxy.ts:1350](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1350)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/erc20_proxy.ts:1334](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1334)* - -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | The ERC20Proxy contract event you would like to subscribe to. | -`blockRange` | `BlockRange` | Block range to get logs from. | -`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` | - -**Returns:** *`Promise>>`* - -Array of logs that match the parameters - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:1292](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1292)* - -Subscribe to an event type emitted by the ERC20Proxy contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | - | The ERC20Proxy contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/erc20_proxy.ts:1317](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1317)* - -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:1323](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1323)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/erc20_proxy.ts:1095](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1095)* - -**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:1053](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1053)* - -**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:1028](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1028)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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 | ------- | ------ | ------ | ------ | -`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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### authorities - -### ▪ **authorities**: *object* - -*Defined in [generated-wrappers/erc20_proxy.ts:209](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L209)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:215](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L215)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:269](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L269)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:262](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L262)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:256](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L256)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:747](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L747)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L753)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/erc20_proxy.ts:809](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L809)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/erc20_proxy.ts:802](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L802)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:794](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L794)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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* - -___ - -### getAuthorizedAddresses - -### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [generated-wrappers/erc20_proxy.ts:820](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L820)* - -Gets all authorized addresses. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:827](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L827)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Array of authorized addresses. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* - -*Defined in [generated-wrappers/erc20_proxy.ts:875](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L875)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/erc20_proxy.ts:868](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L868)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:863](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L863)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:684](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L684)* - -Gets the proxy id associated with the proxy address. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:691](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Proxy id. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L739)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:732](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L732)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:727](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.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). - -**Returns:** *string* - -___ - -### owner - -### ▪ **owner**: *object* - -*Defined in [generated-wrappers/erc20_proxy.ts:429](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L429)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:435](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L435)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:483](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L483)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:476](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L476)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:471](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L471)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:280](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L280)* - -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:316](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L316)* - -Sends an Ethereum transaction and waits 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:368](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L368)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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/erc20_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L343)* - -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:421](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L421)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc20_proxy.ts:414](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L414)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:406](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_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 | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | - -**Returns:** *string* - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/erc20_proxy.ts:288](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L288)* - -Sends an 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 - -___ - -### removeAuthorizedAddressAtIndex - -### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [generated-wrappers/erc20_proxy.ts:494](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L494)* - -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:540](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L540)* - -Sends an Ethereum transaction and waits 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:608](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L608)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | 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:574](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L574)* - -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:673](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L673)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc20_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L666)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:656](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L656)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:503](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L503)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/erc20_proxy.ts:883](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L883)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/erc20_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L917)* - -Sends an Ethereum transaction and waits 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:967](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L967)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:943](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L943)* - -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:1019](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1019)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc20_proxy.ts:1012](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1012)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/erc20_proxy.ts:1004](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L1004)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:890](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L890)* - -Sends an 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 - -
- -> # Class: ERC20TokenContract - -## Hierarchy - -* `BaseContract` - - * **ERC20TokenContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [allowance](#allowance) -* [approve](#approve) -* [balanceOf](#balanceof) -* [totalSupply](#totalsupply) -* [transfer](#transfer) -* [transferFrom](#transferfrom) - -## Constructors - -### constructor - -\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20TokenContract](#class-erc20tokencontract)* - -*Overrides void* - -*Defined in [generated-wrappers/erc20_token.ts:1165](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1165)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/erc20_token.ts:1149](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1149)* - -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:1107](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1107)* - -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:1132](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1132)* - -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:1138](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L1138)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/erc20_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L918)* - -**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:876](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L876)* - -**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:851](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L851)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### allowance - -### ▪ **allowance**: *object* - -*Defined in [generated-wrappers/erc20_token.ts:768](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L768)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_token.ts:777](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L777)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:842](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L842)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/erc20_token.ts:835](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L835)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* - -*Defined in [generated-wrappers/erc20_token.ts:825](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L825)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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/b834b7060/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/b834b7060/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/b834b7060/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`* - -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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/erc20_token.ts:523](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L523)* - -Query the balance of owner - -### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_token.ts:531](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L531)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_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:586](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L586)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/erc20_token.ts:579](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L579)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [generated-wrappers/erc20_token.ts:573](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L573)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:247](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L247)* - -Query total supply of token - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc20_token.ts:254](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L254)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:302](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L302)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/erc20_token.ts:295](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L295)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc20_token.ts:290](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L290)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:597](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L597)* - -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:640](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L640)* - -Sends an Ethereum transaction and waits 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:698](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L698)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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/erc20_token.ts:670](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L670)* - -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:760](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L760)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/erc20_token.ts:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L753)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc20_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_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 | ------- | ------ | ------ | -`_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:606](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L606)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/erc20_token.ts:313](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L313)* - -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:364](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L364)* - -Sends an Ethereum transaction and waits 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:441](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.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 | ------- | ------ | ------ | ------ | -`_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`* - -True if transfer was successful - -### estimateGasAsync - -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/erc20_token.ts:402](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L402)* - -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:512](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L512)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/erc20_token.ts:505](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L505)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc20_token.ts:493](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L493)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:323](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L323)* - -Sends an 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 - -
- -> # Class: ERC721ProxyContract - -## Hierarchy - -* `BaseContract` - - * **ERC721ProxyContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [addAuthorizedAddress](#addauthorizedaddress) -* [authorities](#authorities) -* [authorized](#authorized) -* [getAuthorizedAddresses](#getauthorizedaddresses) -* [getProxyId](#getproxyid) -* [owner](#owner) -* [removeAuthorizedAddress](#removeauthorizedaddress) -* [removeAuthorizedAddressAtIndex](#removeauthorizedaddressatindex) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721ProxyContract](#class-erc721proxycontract)* - -*Overrides void* - -*Defined in [generated-wrappers/erc721_proxy.ts:1350](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1350)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/erc721_proxy.ts:1334](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1334)* - -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:1292](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1292)* - -Subscribe to an event type emitted by the ERC721Proxy contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC721ProxyEvents](#enumeration-erc721proxyevents) | - | The ERC721Proxy contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/erc721_proxy.ts:1317](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1317)* - -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:1323](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1323)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/erc721_proxy.ts:1095](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1095)* - -**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:1053](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1053)* - -**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:1028](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1028)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### authorities - -### ▪ **authorities**: *object* - -*Defined in [generated-wrappers/erc721_proxy.ts:209](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L209)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:215](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L215)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:269](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L269)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:262](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L262)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:256](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L256)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:747](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L747)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L753)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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/erc721_proxy.ts:809](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L809)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/erc721_proxy.ts:802](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L802)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:794](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L794)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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* - -___ - -### getAuthorizedAddresses - -### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [generated-wrappers/erc721_proxy.ts:820](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L820)* - -Gets all authorized addresses. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:827](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L827)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Array of authorized addresses. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* - -*Defined in [generated-wrappers/erc721_proxy.ts:875](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L875)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/erc721_proxy.ts:868](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L868)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:863](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L863)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:684](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L684)* - -Gets the proxy id associated with the proxy address. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:691](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Proxy id. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L739)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:732](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L732)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:727](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.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). - -**Returns:** *string* - -___ - -### owner - -### ▪ **owner**: *object* - -*Defined in [generated-wrappers/erc721_proxy.ts:429](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L429)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:435](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L435)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:483](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L483)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:476](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L476)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:471](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L471)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:280](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L280)* - -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:316](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L316)* - -Sends an Ethereum transaction and waits 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:368](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L368)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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/erc721_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L343)* - -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:421](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L421)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_proxy.ts:414](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L414)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:406](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_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 | ------- | ------ | ------ | -`target` | string | Address to remove authorization from. | - -**Returns:** *string* - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/erc721_proxy.ts:288](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L288)* - -Sends an 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 - -___ - -### removeAuthorizedAddressAtIndex - -### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [generated-wrappers/erc721_proxy.ts:494](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L494)* - -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:540](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L540)* - -Sends an Ethereum transaction and waits 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:608](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L608)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | 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/erc721_proxy.ts:574](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L574)* - -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:673](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L673)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L666)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:656](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L656)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:503](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L503)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/erc721_proxy.ts:883](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L883)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/erc721_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L917)* - -Sends an Ethereum transaction and waits 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:967](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L967)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:943](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L943)* - -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:1019](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1019)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_proxy.ts:1012](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1012)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/erc721_proxy.ts:1004](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L1004)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:890](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L890)* - -Sends an 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 - -
- -> # Class: ERC721TokenContract - -## Hierarchy - -* `BaseContract` - - * **ERC721TokenContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [approve](#approve) -* [balanceOf](#balanceof) -* [getApproved](#getapproved) -* [isApprovedForAll](#isapprovedforall) -* [ownerOf](#ownerof) -* [safeTransferFrom1](#safetransferfrom1) -* [safeTransferFrom2](#safetransferfrom2) -* [setApprovalForAll](#setapprovalforall) -* [transferFrom](#transferfrom) - -## Constructors - -### constructor - -\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721TokenContract](#class-erc721tokencontract)* - -*Overrides void* - -*Defined in [generated-wrappers/erc721_token.ts:1807](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1807)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/erc721_token.ts:1791](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1791)* - -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:1749](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1749)* - -Subscribe to an event type emitted by the ERC721Token contract. - -**Type parameters:** - -▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | - | The ERC721Token contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/erc721_token.ts:1774](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1774)* - -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:1780](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1780)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/erc721_token.ts:1480](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1480)* - -**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:1438](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1438)* - -**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:1413](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1413)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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 | ------- | ------ | ------ | ------ | -`_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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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`* - -The hash of the transaction - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:830](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L830)* - -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:838](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L838)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | 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/erc721_token.ts:893](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L893)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/erc721_token.ts:886](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L886)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [generated-wrappers/erc721_token.ts:880](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L880)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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* - -___ - -### getApproved - -### ▪ **getApproved**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:70](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L70)* - -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/b834b7060/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 | ------- | ------ | ------ | ------ | -`_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/erc721_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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* - -___ - -### isApprovedForAll - -### ▪ **isApprovedForAll**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:1330](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1330)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/erc721_token.ts:1339](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1339)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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/erc721_token.ts:1404](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1404)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/erc721_token.ts:1397](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1397)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* - -*Defined in [generated-wrappers/erc721_token.ts:1387](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.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 | ------- | ------ | ------ | -`_owner` | string | The address that owns the NFTs | -`_operator` | string | The address that acts on behalf of the owner | - -**Returns:** *string* - -___ - -### ownerOf - -### ▪ **ownerOf**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:755](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L755)* - -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:763](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.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 | ------- | ------ | ------ | ------ | -`_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:818](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L818)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/erc721_token.ts:811](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L811)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc721_token.ts:805](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L805)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:545](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L545)* - -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:596](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L596)* - -Sends an Ethereum transaction and waits 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:672](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L672)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_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:634](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L634)* - -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:743](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L743)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_token.ts:736](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L736)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc721_token.ts:724](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L724)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_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:555](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L555)* - -Sends an 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 - -___ - -### safeTransferFrom2 - -### ▪ **safeTransferFrom2**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:1101](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1101)* - -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:1163](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1163)* - -Sends an Ethereum transaction and waits 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:1247](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/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 | 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:1205](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1205)* - -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:1322](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1322)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_token.ts:1315](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1315)* - -**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:1303](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1303)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1112](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1112)* - -Sends an 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 - -___ - -### setApprovalForAll - -### ▪ **setApprovalForAll**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:905](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L905)* - -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:951](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L951)* - -Sends an Ethereum transaction and waits 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:1019](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1019)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:985](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L985)* - -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:1084](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1084)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_token.ts:1077](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1077)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* - -*Defined in [generated-wrappers/erc721_token.ts:1067](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L1067)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:914](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L914)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/erc721_token.ts:335](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L335)* - -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:386](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L386)* - -Sends an Ethereum transaction and waits 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:462](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L462)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_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:424](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L424)* - -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:533](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L533)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/erc721_token.ts:526](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L526)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [generated-wrappers/erc721_token.ts:514](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L514)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L345)* - -Sends an 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 - -
- -> # Class: EthBalanceCheckerContract - -## Hierarchy - -* `BaseContract` - - * **EthBalanceCheckerContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [getEthBalances](#getethbalances) - -## Constructors - -### constructor - -\+ **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/b834b7060/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`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/eth_balance_checker.ts:171](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [EIP712_DOMAIN_HASH](#eip712_domain_hash) -* [VERSION](#version) -* [ZRX_ASSET_DATA](#zrx_asset_data) -* [allowedValidators](#allowedvalidators) -* [assetProxies](#assetproxies) -* [batchCancelOrders](#batchcancelorders) -* [batchFillOrKillOrders](#batchfillorkillorders) -* [batchFillOrders](#batchfillorders) -* [batchFillOrdersNoThrow](#batchfillordersnothrow) -* [cancelOrder](#cancelorder) -* [cancelOrdersUpTo](#cancelordersupto) -* [cancelled](#cancelled) -* [currentContextAddress](#currentcontextaddress) -* [executeTransaction](#executetransaction) -* [fillOrKillOrder](#fillorkillorder) -* [fillOrder](#fillorder) -* [fillOrderNoThrow](#fillordernothrow) -* [filled](#filled) -* [getAssetProxy](#getassetproxy) -* [getOrderInfo](#getorderinfo) -* [getOrdersInfo](#getordersinfo) -* [isValidSignature](#isvalidsignature) -* [marketBuyOrders](#marketbuyorders) -* [marketBuyOrdersNoThrow](#marketbuyordersnothrow) -* [marketSellOrders](#marketsellorders) -* [marketSellOrdersNoThrow](#marketsellordersnothrow) -* [matchOrders](#matchorders) -* [orderEpoch](#orderepoch) -* [owner](#owner) -* [preSign](#presign) -* [preSigned](#presigned) -* [registerAssetProxy](#registerassetproxy) -* [setSignatureValidatorApproval](#setsignaturevalidatorapproval) -* [transactions](#transactions) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new ExchangeContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ExchangeContract](#class-exchangecontract)* - -*Overrides void* - -*Defined in [generated-wrappers/exchange.ts:8605](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8605)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ExchangeContract](#class-exchangecontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/exchange.ts:8589](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8589)* - -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:8547](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8547)* - -Subscribe to an event type emitted by the Exchange contract. - -**Type parameters:** - -▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [ExchangeEvents](#enumeration-exchangeevents) | - | The Exchange contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:8572](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8572)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [generated-wrappers/exchange.ts:8578](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L8578)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/exchange.ts:6562](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6562)* - -**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:6515](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6515)* - -**Parameters:** - -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:6482](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6482)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_zrxAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### EIP712_DOMAIN_HASH - -### ▪ **EIP712_DOMAIN_HASH**: *object* - -*Defined in [generated-wrappers/exchange.ts:5836](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5836)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:5842](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5842)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:5890](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5890)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:5883](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5883)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/exchange.ts:5878](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5878)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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* - -___ - -### VERSION - -### ▪ **VERSION**: *object* - -*Defined in [generated-wrappers/exchange.ts:6419](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6419)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:6425](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6425)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:6473](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6473)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:6466](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6466)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/exchange.ts:6461](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6461)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:5458](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5458)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:5464](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5464)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:5512](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5512)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:5505](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5505)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/exchange.ts:5500](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5500)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:3265](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3265)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:3271](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3271)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:3334](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3334)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:3327](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3327)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:3317](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3317)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1508](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1508)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:1514](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1514)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1564](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1564)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:1557](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1557)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:1551](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1551)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1575](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1575)* - -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:1630](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1630)* - -Sends an Ethereum transaction and waits 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:1714](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1714)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1670](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1670)* - -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:1807](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1807)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:1798](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1798)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* - -*Defined in [generated-wrappers/exchange.ts:1774](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1774)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1583](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1583)* - -Sends an 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 - -___ - -### batchFillOrKillOrders - -### ▪ **batchFillOrKillOrders**: *object* - -*Defined in [generated-wrappers/exchange.ts:1820](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1820)* - -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:1885](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1885)* - -Sends an Ethereum transaction and waits 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:1989](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1989)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1937](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1937)* - -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:2115](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2115)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:2094](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2094)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:2066](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2066)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1831](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1831)* - -Sends an 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 - -___ - -### batchFillOrders - -### ▪ **batchFillOrders**: *object* - -*Defined in [generated-wrappers/exchange.ts:164](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### batchFillOrdersNoThrow - -### ▪ **batchFillOrdersNoThrow**: *object* - -*Defined in [generated-wrappers/exchange.ts:2303](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2303)* - -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:2368](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2368)* - -Sends an Ethereum transaction and waits 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:2472](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2472)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2420](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2420)* - -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:2598](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2598)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:2577](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2577)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:2549](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2549)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2314](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2314)* - -Sends an 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 - -___ - -### cancelOrder - -### ▪ **cancelOrder**: *object* - -*Defined in [generated-wrappers/exchange.ts:5146](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5146)* - -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:5200](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5200)* - -Sends an Ethereum transaction and waits 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:5282](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5282)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:5239](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5239)* - -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:5371](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5371)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:5362](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5362)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [generated-wrappers/exchange.ts:5341](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5341)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:5154](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5154)* - -Sends an 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 - -___ - -### cancelOrdersUpTo - -### ▪ **cancelOrdersUpTo**: *object* - -*Defined in [generated-wrappers/exchange.ts:2141](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2141)* - -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:2179](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2179)* - -Sends an Ethereum transaction and waits 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:2233](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2233)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2207](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2207)* - -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:2291](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2291)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:2284](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2284)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* - -*Defined in [generated-wrappers/exchange.ts:2276](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2276)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2150](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2150)* - -Sends an 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 - -___ - -### cancelled - -### ▪ **cancelled**: *object* - -*Defined in [generated-wrappers/exchange.ts:481](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L481)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:487](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L487)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:541](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L541)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:534](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L534)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:528](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.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 | ------- | ------ | -`index_0` | string | - -**Returns:** *string* - -___ - -### currentContextAddress - -### ▪ **currentContextAddress**: *object* - -*Defined in [generated-wrappers/exchange.ts:6213](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6213)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:6219](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6219)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:6267](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6267)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:6260](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6260)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/exchange.ts:6255](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6255)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:4636](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4636)* - -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:4692](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4692)* - -Sends an Ethereum transaction and waits 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:4776](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4776)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:4734](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4734)* - -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:4851](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4851)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:4844](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4844)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:4832](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4832)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:4647](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4647)* - -Sends an 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 - -___ - -### fillOrKillOrder - -### ▪ **fillOrKillOrder**: *object* - -*Defined in [generated-wrappers/exchange.ts:2765](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2765)* - -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:2827](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2827)* - -Sends an Ethereum transaction and waits 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:2926](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2926)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2877](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2877)* - -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:3049](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3049)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:3028](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3028)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:3001](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3001)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:2775](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2775)* - -Sends an 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 - -___ - -### fillOrder - -### ▪ **fillOrder**: *object* - -*Defined in [generated-wrappers/exchange.ts:4331](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4331)* - -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:4393](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4393)* - -Sends an Ethereum transaction and waits 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:4488](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4488)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:4438](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4438)* - -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:4611](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4611)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:4590](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4590)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:4563](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4563)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:4341](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4341)* - -Sends an 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 - -___ - -### fillOrderNoThrow - -### ▪ **fillOrderNoThrow**: *object* - -*Defined in [generated-wrappers/exchange.ts:1201](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1201)* - -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:1263](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1263)* - -Sends an Ethereum transaction and waits 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:1363](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1363)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:1313](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1313)* - -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:1486](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1486)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:1465](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1465)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:1438](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1438)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1211](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1211)* - -Sends an 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 - -___ - -### filled - -### ▪ **filled**: *object* - -*Defined in [generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:2623](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2623)* - -Gets an asset proxy. - -### callAsync - -▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:2631](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2631)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:2686](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2686)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:2679](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2679)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:2673](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2673)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:5019](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5019)* - -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:5027](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5027)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:5126](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5126)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:5111](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5111)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [generated-wrappers/exchange.ts:5090](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5090)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:3660](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3660)* - -Fetches information for all passed in orders. - -### callAsync - -▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise>`* - -*Defined in [generated-wrappers/exchange.ts:3668](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3668)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:3767](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3767)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`Array`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* - -*Defined in [generated-wrappers/exchange.ts:3754](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3754)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`Array`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* - -*Defined in [generated-wrappers/exchange.ts:3730](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3730)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:3923](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3923)* - -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:3933](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3933)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:4004](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4004)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:3997](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3997)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:3985](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3985)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:5901](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5901)* - -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:5964](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5964)* - -Sends an Ethereum transaction and waits 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:6066](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6066)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:6015](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6015)* - -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:6191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6191)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:6170](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6170)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:6142](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6142)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:5911](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5911)* - -Sends an 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 - -___ - -### marketBuyOrdersNoThrow - -### ▪ **marketBuyOrdersNoThrow**: *object* - -*Defined in [generated-wrappers/exchange.ts:4016](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4016)* - -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:4079](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4079)* - -Sends an Ethereum transaction and waits 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:4181](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4181)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:4130](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4130)* - -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:4306](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4306)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:4285](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4285)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:4257](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4257)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:4026](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4026)* - -Sends an 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 - -___ - -### marketSellOrders - -### ▪ **marketSellOrders**: *object* - -*Defined in [generated-wrappers/exchange.ts:3345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3345)* - -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:3408](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3408)* - -Sends an Ethereum transaction and waits 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:3510](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3510)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:3459](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3459)* - -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:3635](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3635)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:3614](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3614)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:3586](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3586)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:3355](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3355)* - -Sends an 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 - -___ - -### marketSellOrdersNoThrow - -### ▪ **marketSellOrdersNoThrow**: *object* - -*Defined in [generated-wrappers/exchange.ts:5524](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5524)* - -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:5587](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5587)* - -Sends an Ethereum transaction and waits 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:5689](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5689)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:5638](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5638)* - -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:5814](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5814)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:5793](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5793)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [generated-wrappers/exchange.ts:5765](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5765)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:5534](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5534)* - -Sends an 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 - -___ - -### matchOrders - -### ▪ **matchOrders**: *object* - -*Defined in [generated-wrappers/exchange.ts:760](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L760)* - -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:838](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L838)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | 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:969](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L969)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:904](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L904)* - -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:1157](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1157)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *object* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *object* - -*Defined in [generated-wrappers/exchange.ts:1118](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1118)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *object* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:1077](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L1077)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:771](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L771)* - -Sends an 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 - -___ - -### orderEpoch - -### ▪ **orderEpoch**: *object* - -*Defined in [generated-wrappers/exchange.ts:5381](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5381)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:5387](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5387)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:5450](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5450)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/exchange.ts:5443](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5443)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:5433](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5433)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:3858](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3858)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:3864](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3864)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:3912](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3912)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:3905](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3905)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/exchange.ts:3900](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3900)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:553](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L553)* - -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:602](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L602)* - -Sends an Ethereum transaction and waits 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:676](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L676)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:639](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L639)* - -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:746](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L746)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:739](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L739)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:727](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.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 | 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:562](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L562)* - -Sends an 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 - -___ - -### preSigned - -### ▪ **preSigned**: *object* - -*Defined in [generated-wrappers/exchange.ts:3781](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3781)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:3787](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3787)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:3850](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3850)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:3843](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3843)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:3833](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3833)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:4863](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4863)* - -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:4899](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4899)* - -Sends an Ethereum transaction and waits 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:4951](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4951)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:4926](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4926)* - -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:5008](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5008)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:5001](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5001)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:4993](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4993)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:4871](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4871)* - -Sends an 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 - -___ - -### setSignatureValidatorApproval - -### ▪ **setSignatureValidatorApproval**: *object* - -*Defined in [generated-wrappers/exchange.ts:3074](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3074)* - -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:3124](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3124)* - -Sends an Ethereum transaction and waits 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:3192](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3192)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:3158](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3158)* - -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:3257](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3257)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:3250](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3250)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* - -*Defined in [generated-wrappers/exchange.ts:3240](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3240)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:3083](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3083)* - -Sends an 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 - -___ - -### transactions - -### ▪ **transactions**: *object* - -*Defined in [generated-wrappers/exchange.ts:2694](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2694)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/exchange.ts:2700](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2700)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:2754](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2754)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/exchange.ts:2747](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2747)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:2741](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L2741)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:6275](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6275)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/exchange.ts:6309](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6309)* - -Sends an Ethereum transaction and waits 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:6359](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6359)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:6335](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6335)* - -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:6411](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6411)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/exchange.ts:6404](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6404)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/exchange.ts:6396](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6396)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:6282](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6282)* - -Sends an 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 - -
- -> # Class: ForwarderContract - -## Hierarchy - -* `BaseContract` - - * **ForwarderContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [marketBuyOrdersWithEth](#marketbuyorderswitheth) -* [marketSellOrdersWithEth](#marketsellorderswitheth) -* [owner](#owner) -* [transferOwnership](#transferownership) -* [withdrawAsset](#withdrawasset) - -## Constructors - -### constructor - -\+ **new ForwarderContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ForwarderContract](#class-forwardercontract)* - -*Overrides void* - -*Defined in [generated-wrappers/forwarder.ts:2008](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L2008)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ForwarderContract](#class-forwardercontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/forwarder.ts:1569](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1569)* - -**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:1520](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1520)* - -**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:1483](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1483)* - -**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* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### marketSellOrdersWithEth - -### ▪ **marketSellOrdersWithEth**: *object* - -*Defined in [generated-wrappers/forwarder.ts:835](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L835)* - -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:937](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L937)* - -Sends an Ethereum transaction and waits 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:1092](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1092)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:1016](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1016)* - -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:1299](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1299)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *[object, object]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *[object, object]* - -*Defined in [generated-wrappers/forwarder.ts:1260](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1260)* - -**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:1213](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1213)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:851](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L851)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | -`feeSignatures` | string[] | Proofs that feeOrders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### owner - -### ▪ **owner**: *object* - -*Defined in [generated-wrappers/forwarder.ts:767](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L767)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/forwarder.ts:773](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L773)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:821](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L821)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/forwarder.ts:814](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L814)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/forwarder.ts:809](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L809)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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* - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/forwarder.ts:1339](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1339)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/forwarder.ts:1373](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1373)* - -Sends an Ethereum transaction and waits 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:1423](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1423)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1399](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1399)* - -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:1475](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1475)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/forwarder.ts:1468](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1468)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/forwarder.ts:1460](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1460)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1346](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1346)* - -Sends an 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 - -___ - -### withdrawAsset - -### ▪ **withdrawAsset**: *object* - -*Defined in [generated-wrappers/forwarder.ts:593](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L593)* - -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:636](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L636)* - -Sends an Ethereum transaction and waits 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:697](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L697)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:666](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L666)* - -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:759](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L759)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/forwarder.ts:752](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L752)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* - -*Defined in [generated-wrappers/forwarder.ts:742](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L742)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`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:602](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L602)* - -Sends an 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 - -
- -> # Class: IAssetProxyContract - -## Hierarchy - -* `BaseContract` - - * **IAssetProxyContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [addAuthorizedAddress](#addauthorizedaddress) -* [getAuthorizedAddresses](#getauthorizedaddresses) -* [getProxyId](#getproxyid) -* [removeAuthorizedAddress](#removeauthorizedaddress) -* [removeAuthorizedAddressAtIndex](#removeauthorizedaddressatindex) -* [transferFrom](#transferfrom) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new IAssetProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IAssetProxyContract](#class-iassetproxycontract)* - -*Overrides void* - -*Defined in [generated-wrappers/i_asset_proxy.ts:1211](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1211)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[IAssetProxyContract](#class-iassetproxycontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/i_asset_proxy.ts:1093](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1093)* - -**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:1051](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1051)* - -**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:1026](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1026)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### getAuthorizedAddresses - -### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [generated-wrappers/i_asset_proxy.ts:819](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L819)* - -Gets all authorized addresses. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/i_asset_proxy.ts:826](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L826)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:874](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L874)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/i_asset_proxy.ts:867](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L867)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:862](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L862)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L753)* - -Gets the proxy id associated with the proxy address. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/i_asset_proxy.ts:760](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L760)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Proxy id. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:808](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L808)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:801](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L801)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:796](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L796)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Returns:** *string* - -___ - -### removeAuthorizedAddress - -### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [generated-wrappers/i_asset_proxy.ts:185](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L185)* - -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:221](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L221)* - -Sends an Ethereum transaction and waits 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:273](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L273)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:248](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L248)* - -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:326](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L326)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/i_asset_proxy.ts:319](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L319)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:311](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L311)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**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:193](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L193)* - -Sends an 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 - -___ - -### removeAuthorizedAddressAtIndex - -### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [generated-wrappers/i_asset_proxy.ts:337](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L337)* - -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:383](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L383)* - -Sends an Ethereum transaction and waits 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:451](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L451)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:417](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L417)* - -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:516](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L516)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/i_asset_proxy.ts:509](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L509)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:499](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L499)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`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:346](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L346)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/i_asset_proxy.ts:527](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L527)* - -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:583](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L583)* - -Sends an Ethereum transaction and waits 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:667](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L667)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:625](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L625)* - -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:742](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L742)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/i_asset_proxy.ts:735](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L735)* - -**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:723](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L723)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used -to create a 0x transaction (see protocol spec for more details). - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`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:538](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L538)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/i_asset_proxy.ts:882](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L882)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/i_asset_proxy.ts:916](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L916)* - -Sends an Ethereum transaction and waits 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:966](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L966)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:942](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L942)* - -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:1018](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1018)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/i_asset_proxy.ts:1011](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1011)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/i_asset_proxy.ts:1003](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L1003)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:889](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_asset_proxy.ts#L889)* - -Sends an 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 - -
- -> # Class: IValidatorContract - -## Hierarchy - -* `BaseContract` - - * **IValidatorContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [isValidSignature](#isvalidsignature) - -## Constructors - -### constructor - -\+ **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/b834b7060/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`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/i_validator.ts:189](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 +### Hierarchy * `BaseContract` * **IWalletContract** -## Index ### Constructors -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [isValidSignature](#isvalidsignature) - -## Constructors - -### constructor +## 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/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L206)* +*Defined in [generated-wrappers/i_wallet.ts:206](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L206)* **Parameters:** @@ -20363,53 +670,53 @@ Name | Type | **Returns:** *[IWalletContract](#class-iwalletcontract)* -## Properties +### Properties -### abi +## abi • **abi**: *`ContractAbi`* -*Inherited from void* + ___ -### address +## address • **address**: *string* -*Inherited from void* + ___ -### constructorArgs +## constructerArgs • **constructorArgs**: *any[]* -*Inherited from void* + ___ -### contractName +## contractName • **contractName**: *string* -*Inherited from void* -## Methods -### `Static` ABI +### Methods + +## `Static` ABI ▸ **ABI**(): *`ContractAbi`* -*Defined in [generated-wrappers/i_wallet.ts:179](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L179)* +*Defined in [generated-wrappers/i_wallet.ts:179](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L179)* **Returns:** *`ContractAbi`* @@ -20417,11 +724,11 @@ The contract ABI ___ -### `Static` deployAsync +## `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/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L137)* +*Defined in [generated-wrappers/i_wallet.ts:137](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L137)* **Parameters:** @@ -20437,11 +744,11 @@ Name | Type | ___ -### `Static` deployFrom0xArtifactAsync +## `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/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L112)* +*Defined in [generated-wrappers/i_wallet.ts:112](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L112)* **Parameters:** @@ -20456,11 +763,11 @@ Name | Type | ___ -### `Static` strictArgumentEncodingCheck +## `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -*Inherited from void* + @@ -20473,21 +780,21 @@ Name | Type | **Returns:** *string* -## Object literals +### Object literals -### isValidSignature +## isValidSignature -### ▪ **isValidSignature**: *object* +## ▪ **isValidSignature**: *object* -*Defined in [generated-wrappers/i_wallet.ts:33](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L33)* +*Defined in [generated-wrappers/i_wallet.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L33)* Verifies that a signature is valid. -### callAsync +## callAsync -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* +▸ **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/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L42)* +*Defined in [generated-wrappers/i_wallet.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -20502,15 +809,15 @@ Name | Type | Default | Description | `callData` | `Partial` | {} | - | `defaultBlock?` | `BlockParam` | - | - | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -Validity of order signature. +Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidWalletSignature(bytes32,address,bytes)")) -### getABIDecodedReturnData +## getABIDecodedReturnData -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* +▸ **getABIDecodedReturnData**(`returnData`: string): *string* -*Defined in [generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L104)* +*Defined in [generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L104)* **Parameters:** @@ -20518,13 +825,13 @@ Name | Type | ------ | ------ | `returnData` | string | -**Returns:** *boolean* +**Returns:** *string* -### getABIDecodedTransactionData +## getABIDecodedTransactionData -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* +▸ **getABIDecodedTransactionData**(`callData`: string): *string* -*Defined in [generated-wrappers/i_wallet.ts:97](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L97)* +*Defined in [generated-wrappers/i_wallet.ts:97](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L97)* **Parameters:** @@ -20532,13 +839,13 @@ Name | Type | ------ | ------ | `callData` | string | -**Returns:** *boolean* +**Returns:** *string* -### getABIEncodedTransactionData +## getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* -*Defined in [generated-wrappers/i_wallet.ts:87](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/i_wallet.ts#L87)* +*Defined in [generated-wrappers/i_wallet.ts:87](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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 @@ -20555,4680 +862,22 @@ Name | Type | Description |
-> # Class: MultiAssetProxyContract +# Class: CoordinatorServerError -## Hierarchy - -* `BaseContract` - - * **MultiAssetProxyContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [addAuthorizedAddress](#addauthorizedaddress) -* [assetProxies](#assetproxies) -* [authorities](#authorities) -* [authorized](#authorized) -* [getAssetProxy](#getassetproxy) -* [getAuthorizedAddresses](#getauthorizedaddresses) -* [getProxyId](#getproxyid) -* [owner](#owner) -* [registerAssetProxy](#registerassetproxy) -* [removeAuthorizedAddress](#removeauthorizedaddress) -* [removeAuthorizedAddressAtIndex](#removeauthorizedaddressatindex) -* [transferOwnership](#transferownership) - -## Constructors - -### constructor - -\+ **new MultiAssetProxyContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[MultiAssetProxyContract](#class-multiassetproxycontract)* - -*Overrides void* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1722](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1722)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[MultiAssetProxyContract](#class-multiassetproxycontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [MultiAssetProxyEvents](#enumeration-multiassetproxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1706](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1706)* - -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:1664](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1664)* - -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:1689](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1689)* - -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:1695](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1695)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1397](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1397)* - -**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:1355](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1355)* - -**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:1330](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1330)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### assetProxies - -### ▪ **assetProxies**: *object* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:280](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L280)* - -### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:286](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L286)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:340](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L340)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:333](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L333)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:327](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L327)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:892](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L892)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:898](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L898)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:954](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L954)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:947](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L947)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:939](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L939)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:351](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L351)* - -Gets an asset proxy. - -### callAsync - -▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:359](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L359)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:414](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L414)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:407](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L407)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:401](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L401)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:1122](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1122)* - -Gets all authorized addresses. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1129](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1129)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:1177](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1177)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string[]* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1170)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string[]* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1165](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1165)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:829](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L829)* - -Gets the proxy id associated with the proxy address. - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:836](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L836)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -Proxy id. - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:884](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L884)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:877](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L877)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:872](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.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). - -**Returns:** *string* - -___ - -### owner - -### ▪ **owner**: *object* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:574](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L574)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:580](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L580)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:628](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L628)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:621](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L621)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:616](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L616)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:966](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L966)* - -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:1002](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1002)* - -Sends an Ethereum transaction and waits 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:1054](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1054)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`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:1029](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1029)* - -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:1111](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1111)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1104](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1104)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1096](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.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 | ------- | ------ | ------ | -`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:974](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L974)* - -Sends an 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 - -___ - -### removeAuthorizedAddress - -### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:425](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L425)* - -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:461](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L461)* - -Sends an Ethereum transaction and waits 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:513](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L513)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:488](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L488)* - -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:566](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L566)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:559](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L559)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:551](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L551)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:433](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L433)* - -Sends an 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 - -___ - -### removeAuthorizedAddressAtIndex - -### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:639](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L639)* - -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:685](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L685)* - -Sends an Ethereum transaction and waits 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:753](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L753)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:719](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L719)* - -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:818](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L818)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:811](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L811)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:801](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L801)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:648](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L648)* - -Sends an 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 - -___ - -### transferOwnership - -### ▪ **transferOwnership**: *object* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1185](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1185)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1219](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1219)* - -Sends an Ethereum transaction and waits 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:1269](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1269)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1245](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1245)* - -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:1321](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1321)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1314](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1314)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [generated-wrappers/multi_asset_proxy.ts:1306](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1306)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:1192](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L1192)* - -Sends an 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 - -
- -> # Class: OrderValidatorContract - -## Hierarchy - -* `BaseContract` - - * **OrderValidatorContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [getBalanceAndAllowance](#getbalanceandallowance) -* [getBalancesAndAllowances](#getbalancesandallowances) -* [getERC721TokenOwner](#geterc721tokenowner) -* [getOrderAndTraderInfo](#getorderandtraderinfo) -* [getOrdersAndTradersInfo](#getordersandtradersinfo) -* [getTraderInfo](#gettraderinfo) -* [getTradersInfo](#gettradersinfo) - -## Constructors - -### constructor - -\+ **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/b834b7060/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`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/order_validator.ts:1080](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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* - -*Inherited from void* - - - -**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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [allowance](#allowance) -* [approve](#approve) -* [balanceOf](#balanceof) -* [decimals](#decimals) -* [deposit](#deposit) -* [name](#name) -* [symbol](#symbol) -* [totalSupply](#totalsupply) -* [transfer](#transfer) -* [transferFrom](#transferfrom) -* [withdraw](#withdraw) - -## Constructors - -### constructor - -\+ **new WETH9Contract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[WETH9Contract](#class-weth9contract)* - -*Overrides void* - -*Defined in [generated-wrappers/weth9.ts:1672](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1672)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[WETH9Contract](#class-weth9contract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/weth9.ts:1656](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1656)* - -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:1614](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1614)* - -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:1639](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1639)* - -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:1645](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1645)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/weth9.ts:1317](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1317)* - -**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:1275](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1275)* - -**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:1250](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1250)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### allowance - -### ▪ **allowance**: *object* - -*Defined in [generated-wrappers/weth9.ts:1172](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1172)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:1178](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1178)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:1241](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1241)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/weth9.ts:1234](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1234)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* - -*Defined in [generated-wrappers/weth9.ts:1224](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1224)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/weth9.ts:748](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L748)* - -### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:754](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L754)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:810](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L810)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/weth9.ts:803](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L803)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`index_0`: string): *string* - -*Defined in [generated-wrappers/weth9.ts:795](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L795)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:686](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L686)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:692](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L692)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:740](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L740)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *number* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *number* - -*Defined in [generated-wrappers/weth9.ts:733](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L733)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *number* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/weth9.ts:728](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L728)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1036](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1036)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/weth9.ts:1069](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1069)* - -Sends an Ethereum transaction and waits 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:1116](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### estimateGasAsync - -▸ **estimateGasAsync**(`txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:1093](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1093)* - -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:1164](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1164)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/weth9.ts:1157](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1157)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/weth9.ts:1152](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1152)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:1043](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1043)* - -Sends an 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 - -___ - -### name - -### ▪ **name**: *object* - -*Defined in [generated-wrappers/weth9.ts:73](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:818](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L818)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:824](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L824)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *string* - -*Defined in [generated-wrappers/weth9.ts:872](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L872)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/weth9.ts:865](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L865)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/weth9.ts:860](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L860)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:291](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L291)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/weth9.ts:297](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L297)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L345)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/weth9.ts:338](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L338)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/weth9.ts:333](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L333)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:880](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L880)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/weth9.ts:915](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L915)* - -Sends an Ethereum transaction and waits 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:968](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L968)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:943](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L943)* - -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:1028](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1028)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/weth9.ts:1021](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1021)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* - -*Defined in [generated-wrappers/weth9.ts:1011](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L1011)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:887](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L887)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/weth9.ts:353](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L353)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/weth9.ts:398](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L398)* - -Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. -If the transaction was mined, but reverted, an error is thrown. - -**Parameters:** - -Name | Type | 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:468](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L468)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:433](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L433)* - -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:536](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L536)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/weth9.ts:529](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L529)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* - -*Defined in [generated-wrappers/weth9.ts:517](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L517)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:360](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L360)* - -Sends an 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 - -___ - -### withdraw - -### ▪ **withdraw**: *object* - -*Defined in [generated-wrappers/weth9.ts:544](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L544)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/weth9.ts:578](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L578)* - -Sends an Ethereum transaction and waits 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:628](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L628)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:604](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L604)* - -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:678](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L678)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *void* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *void* - -*Defined in [generated-wrappers/weth9.ts:671](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L671)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *void* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* - -*Defined in [generated-wrappers/weth9.ts:665](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L665)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:551](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L551)* - -Sends an 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 - -
- -> # Class: ZRXTokenContract - -## Hierarchy - -* `BaseContract` - - * **ZRXTokenContract** - -## Index - -### Constructors - -* [constructor](#constructor) - -### Properties - -* [abi](#abi) -* [address](#address) -* [constructorArgs](#constructorargs) -* [contractName](#contractname) - -### Methods - -* [getLogsAsync](#getlogsasync) -* [subscribe](#subscribe) -* [unsubscribe](#unsubscribe) -* [unsubscribeAll](#unsubscribeall) -* [ABI](#static-abi) -* [deployAsync](#static-deployasync) -* [deployFrom0xArtifactAsync](#static-deployfrom0xartifactasync) -* [strictArgumentEncodingCheck](#static-strictargumentencodingcheck) - -### Object literals - -* [allowance](#allowance) -* [approve](#approve) -* [balanceOf](#balanceof) -* [decimals](#decimals) -* [name](#name) -* [symbol](#symbol) -* [totalSupply](#totalsupply) -* [transfer](#transfer) -* [transferFrom](#transferfrom) - -## Constructors - -### constructor - -\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: `SupportedProvider`, `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ZRXTokenContract](#class-zrxtokencontract)* - -*Overrides void* - -*Defined in [generated-wrappers/zrx_token.ts:1347](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1347)* - -**Parameters:** - -Name | Type | ------- | ------ | -`address` | string | -`supportedProvider` | `SupportedProvider` | -`txDefaults?` | `Partial` | -`logDecodeDependencies?` | undefined \| object | - -**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* - -## Properties - -### abi - -• **abi**: *`ContractAbi`* - -*Inherited from void* - - - -___ - -### address - -• **address**: *string* - -*Inherited from void* - - - -___ - -### constructorArgs - -• **constructorArgs**: *any[]* - -*Inherited from void* - - - -___ - -### contractName - -• **contractName**: *string* - -*Inherited from void* - - - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [generated-wrappers/zrx_token.ts:1331](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1331)* - -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:1289](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1289)* - -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:1314](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1314)* - -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:1320](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1320)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *`ContractAbi`* - -*Defined in [generated-wrappers/zrx_token.ts:1061](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1061)* - -**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:1019](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L1019)* - -**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:994](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L994)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | `SupportedProvider` | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - -*Inherited from void* - - - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### allowance - -### ▪ **allowance**: *object* - -*Defined in [generated-wrappers/zrx_token.ts:916](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L916)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/zrx_token.ts:922](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L922)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas -since they don't modify state. - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`_spender` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/zrx_token.ts:985](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L985)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/zrx_token.ts:978](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L978)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* - -*Defined in [generated-wrappers/zrx_token.ts:968](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L968)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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 - -___ - -### balanceOf - -### ▪ **balanceOf**: *object* - -*Defined in [generated-wrappers/zrx_token.ts:626](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L626)* - -### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/zrx_token.ts:632](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L632)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to 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:686](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L686)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/zrx_token.ts:679](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L679)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_owner`: string): *string* - -*Defined in [generated-wrappers/zrx_token.ts:673](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L673)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:564](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L564)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/zrx_token.ts:570](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | `BlockParam` | - | - -**Returns:** *`Promise`* - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**(`returnData`: string): *number* - -*Defined in [generated-wrappers/zrx_token.ts:618](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L618)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *number* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *number* - -*Defined in [generated-wrappers/zrx_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L611)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *number* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/zrx_token.ts:606](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L606)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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:694](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L694)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/zrx_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L700)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:748](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L748)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *string* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *string* - -*Defined in [generated-wrappers/zrx_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L741)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *string* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/zrx_token.ts:736](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L736)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:292](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L292)* - -### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: `BlockParam`): *`Promise`* - -*Defined in [generated-wrappers/zrx_token.ts:298](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L298)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this method, given the 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:346](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L346)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *`BigNumber`* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* - -*Defined in [generated-wrappers/zrx_token.ts:339](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L339)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *`BigNumber`* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [generated-wrappers/zrx_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L334)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data 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:756](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L756)* - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* - -*Defined in [generated-wrappers/zrx_token.ts:795](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L795)* - -Sends an Ethereum transaction and waits 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:848](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.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 | ------- | ------ | ------ | -`_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:823](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L823)* - -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:908](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L908)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/zrx_token.ts:901](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L901)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/zrx_token.ts:891](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L891)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be 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:763](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L763)* - -Sends an 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 - -___ - -### transferFrom - -### ▪ **transferFrom**: *object* - -*Defined in [generated-wrappers/zrx_token.ts:357](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L357)* - -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:408](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L408)* - -Sends an Ethereum transaction and waits 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:485](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L485)* - -Sends a read-only call to the contract method. Returns the result that would happen if one were to send an -Ethereum transaction to this 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:446](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L446)* - -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:556](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L556)* - -**Parameters:** - -Name | Type | ------- | ------ | -`returnData` | string | - -**Returns:** *boolean* - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**(`callData`: string): *boolean* - -*Defined in [generated-wrappers/zrx_token.ts:549](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L549)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData` | string | - -**Returns:** *boolean* - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L537)* - -Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before -sending the Ethereum tx, this encoded tx data can first be sent 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:367](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L367)* - -Sends an 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 - -
- -> # Class: CoordinatorServerError - -## Hierarchy +### 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 +## constructer \+ **new CoordinatorServerError**(`message`: [CoordinatorServerErrorMsg](#enumeration-coordinatorservererrormsg), `approvedOrders`: `SignedOrder`[], `cancellations`: [CoordinatorServerCancellationResponse](#interface-coordinatorservercancellationresponse)[], `errors`: [CoordinatorServerResponse](#interface-coordinatorserverresponse)[]): *[CoordinatorServerError](#class-coordinatorservererror)* -*Defined in [utils/coordinator_server_types.ts:43](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/bfbc78c95/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L43)* **Parameters:** @@ -25241,57 +890,57 @@ 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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L40)* ___ -### name +## name • **name**: *string* -*Inherited from void* + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* @@ -25299,7 +948,7 @@ ___ ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* @@ -25307,2996 +956,882 @@ ___
-> # Enumeration: AssetProxyOwnerEvents +# Enumeration: ContractError -## Index ### Enumeration members -* [AssetProxyRegistration](#assetproxyregistration) -* [Confirmation](#confirmation) -* [ConfirmationTimeSet](#confirmationtimeset) -* [Deposit](#deposit) -* [Execution](#execution) -* [ExecutionFailure](#executionfailure) -* [OwnerAddition](#owneraddition) -* [OwnerRemoval](#ownerremoval) -* [RequirementChange](#requirementchange) -* [Revocation](#revocation) -* [Submission](#submission) -* [TimeLockChange](#timelockchange) - -## Enumeration members - -### AssetProxyRegistration - -• **AssetProxyRegistration**: = "AssetProxyRegistration" - -*Defined in [generated-wrappers/asset_proxy_owner.ts:49](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L51)* - -
- -> # Enumeration: CoordinatorRegistryEvents - -## Index - -### Enumeration members - -* [CoordinatorEndpointSet](#coordinatorendpointset) - -## Enumeration members - -### CoordinatorEndpointSet - -• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" - -*Defined in [generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* - -
- -> # Enumeration: DummyERC20TokenEvents - -## Index - -### Enumeration members - -* [Approval](#approval) -* [Transfer](#transfer) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* - -
- -> # Enumeration: DummyERC721TokenEvents - -## Index - -### Enumeration members - -* [Approval](#approval) -* [ApprovalForAll](#approvalforall) -* [Transfer](#transfer) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* - -
- -> # Enumeration: ERC20ProxyEvents - -## Index - -### Enumeration members - -* [AuthorizedAddressAdded](#authorizedaddressadded) -* [AuthorizedAddressRemoved](#authorizedaddressremoved) - -## Enumeration members - -### AuthorizedAddressAdded - -• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" - -*Defined in [generated-wrappers/erc20_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)* - -
- -> # Enumeration: ERC20TokenEvents - -## Index - -### Enumeration members - -* [Approval](#approval) -* [Transfer](#transfer) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L37)* - -
- -> # Enumeration: ERC721ProxyEvents - -## Index - -### Enumeration members - -* [AuthorizedAddressAdded](#authorizedaddressadded) -* [AuthorizedAddressRemoved](#authorizedaddressremoved) - -## Enumeration members - -### AuthorizedAddressAdded - -• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" - -*Defined in [generated-wrappers/erc721_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)* - -
- -> # Enumeration: ERC721TokenEvents - -## Index - -### Enumeration members - -* [Approval](#approval) -* [ApprovalForAll](#approvalforall) -* [Transfer](#transfer) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L40)* - -
- -> # Enumeration: ExchangeEvents - -## Index - -### Enumeration members - -* [AssetProxyRegistered](#assetproxyregistered) -* [Cancel](#cancel) -* [CancelUpTo](#cancelupto) -* [Fill](#fill) -* [SignatureValidatorApproval](#signaturevalidatorapproval) - -## Enumeration members - -### AssetProxyRegistered - -• **AssetProxyRegistered**: = "AssetProxyRegistered" - -*Defined in [generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L42)* - -
- -> # Enumeration: MultiAssetProxyEvents - -## Index - -### Enumeration members - -* [AssetProxyRegistered](#assetproxyregistered) -* [AuthorizedAddressAdded](#authorizedaddressadded) -* [AuthorizedAddressRemoved](#authorizedaddressremoved) - -## Enumeration members - -### AssetProxyRegistered - -• **AssetProxyRegistered**: = "AssetProxyRegistered" - -*Defined in [generated-wrappers/multi_asset_proxy.ts:42](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L41)* - -
- -> # Enumeration: WETH9Events - -## Index - -### Enumeration members - -* [Approval](#approval) -* [Deposit](#deposit) -* [Transfer](#transfer) -* [Withdrawal](#withdrawal) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L44)* - -
- -> # Enumeration: ZRXTokenEvents - -## Index - -### Enumeration members - -* [Approval](#approval) -* [Transfer](#transfer) - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L37)* - -
- -> # 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:72](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L72)* - -___ - -### Expired - -• **Expired**: - -*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L70)* - -___ - -### Fillable - -• **Fillable**: - -*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L69)* - -___ - -### FullyFilled - -• **FullyFilled**: - -*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L71)* - -___ - -### Invalid - -• **Invalid**: = 0 - -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L66)* - -___ - -### InvalidMakerAssetAmount - -• **InvalidMakerAssetAmount**: - -*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L67)* - -___ - -### InvalidTakerAssetAmount - -• **InvalidTakerAssetAmount**: - -*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L68)* - -
- -> # 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)* - -
- -> # 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 • **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" -*Defined in [utils/decorators.ts:4](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L4)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L32)* ___ -### ERC721NoApproval +## ERC721NoApproval • **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [utils/decorators.ts:14](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L14)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L42)* ___ -### ERC721OwnerNotFound +## ERC721OwnerNotFound • **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" -*Defined in [utils/decorators.ts:13](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L13)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L41)* ___ -### InsufficientAllowanceForTransfer +## InsufficientAllowanceForTransfer • **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" -*Defined in [utils/decorators.ts:5](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L5)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L33)* ___ -### InsufficientBalanceForTransfer +## InsufficientBalanceForTransfer • **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" -*Defined in [utils/decorators.ts:6](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L6)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L34)* ___ -### InsufficientEthBalanceForDeposit +## InsufficientEthBalanceForDeposit • **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" -*Defined in [utils/decorators.ts:7](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L7)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L35)* ___ -### InsufficientWEthBalanceForWithdrawal +## InsufficientWEthBalanceForWithdrawal • **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" -*Defined in [utils/decorators.ts:8](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L8)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L36)* ___ -### InvalidJump +## InvalidJump • **InvalidJump**: = "INVALID_JUMP" -*Defined in [utils/decorators.ts:9](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L9)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L37)* ___ -### OutOfGas +## OutOfGas • **OutOfGas**: = "OUT_OF_GAS" -*Defined in [utils/decorators.ts:10](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L10)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L38)* ___ -### SignatureRequestDenied +## SignatureRequestDenied • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [utils/decorators.ts:15](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L15)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L43)* ___ -### SubscriptionAlreadyPresent +## SubscriptionAlreadyPresent • **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [utils/decorators.ts:12](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L12)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L40)* ___ -### SubscriptionNotFound +## SubscriptionNotFound • **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [utils/decorators.ts:11](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/utils/decorators.ts#L11)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L39)*
-> # Interface: AssetProxyOwnerAssetProxyRegistrationEventArgs +# Enumeration: ForwarderError -## Hierarchy -* `DecodedLogArgs` +### Enumeration members - * **AssetProxyOwnerAssetProxyRegistrationEventArgs** +## CompleteFillFailed -## Indexable +• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [assetProxyContract](#assetproxycontract) -* [isRegistered](#isregistered) - -## Properties - -### assetProxyContract - -• **assetProxyContract**: *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:64](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L64)* - -___ - -### isRegistered - -• **isRegistered**: *boolean* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:65](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L65)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L28)*
-> # Interface: AssetProxyOwnerConfirmationEventArgs +# Enumeration: OrderStatus -## Hierarchy -* `DecodedLogArgs` +### Enumeration members - * **AssetProxyOwnerConfirmationEventArgs** +## Cancelled -## Indexable +• **Cancelled**: -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [sender](#sender) -* [transactionId](#transactionid) - -## Properties - -### sender - -• **sender**: *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:78](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L78)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L91)* ___ -### transactionId +## Expired -• **transactionId**: *`BigNumber`* +• **Expired**: -*Defined in [generated-wrappers/asset_proxy_owner.ts:79](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L79)* +*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L89)* + +___ + +## Fillable + +• **Fillable**: + +*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L88)* + +___ + +## FullyFilled + +• **FullyFilled**: + +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L90)* + +___ + +## Invalid + +• **Invalid**: = 0 + +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L85)* + +___ + +## InvalidMakerAssetAmount + +• **InvalidMakerAssetAmount**: + +*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L86)* + +___ + +## InvalidTakerAssetAmount + +• **InvalidTakerAssetAmount**: + +*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L87)*
-> # Interface: AssetProxyOwnerConfirmationTimeSetEventArgs +# Enumeration: CoordinatorServerErrorMsg -## Hierarchy -* `DecodedLogArgs` +### Enumeration members - * **AssetProxyOwnerConfirmationTimeSetEventArgs** +## CancellationFailed -## Indexable +• **CancellationFailed**: = "Failed to cancel with some coordinator server(s). See errors for more info. See cancellations for successful cancellations." -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L70)* +*Defined in [utils/coordinator_server_types.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L59)* ___ -### transactionId +## FillFailed -• **transactionId**: *`BigNumber`* +• **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 [generated-wrappers/asset_proxy_owner.ts:69](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L69)* +*Defined in [utils/coordinator_server_types.ts:60](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L60)*
-> # Interface: AssetProxyOwnerDepositEventArgs +# Enumeration: ContractError -## Hierarchy -* `DecodedLogArgs` +### Enumeration members - * **AssetProxyOwnerDepositEventArgs** +## ContractNotDeployedOnNetwork -## Indexable +• **ContractNotDeployedOnNetwork**: = "CONTRACT_NOT_DEPLOYED_ON_NETWORK" -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L100)* +*Defined in [utils/decorators.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/utils/decorators.ts#L4)* ___ -### value +## ERC721NoApproval -• **value**: *`BigNumber`* +• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [generated-wrappers/asset_proxy_owner.ts:101](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L101)* +*Defined in [utils/decorators.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/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/bfbc78c95/packages/contract-wrappers/src/utils/decorators.ts#L11)*
-> # Interface: AssetProxyOwnerExecutionEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerExecutionEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [transactionId](#transactionid) - -## Properties - -### transactionId - -• **transactionId**: *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:92](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L92)* - -
- -> # Interface: AssetProxyOwnerExecutionFailureEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerExecutionFailureEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [transactionId](#transactionid) - -## Properties - -### transactionId - -• **transactionId**: *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:96](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L96)* - -
- -> # Interface: AssetProxyOwnerOwnerAdditionEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerOwnerAdditionEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [owner](#owner) - -## Properties - -### owner - -• **owner**: *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:105](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L105)* - -
- -> # Interface: AssetProxyOwnerOwnerRemovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerOwnerRemovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [owner](#owner) - -## Properties - -### owner - -• **owner**: *string* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:109](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L109)* - -
- -> # Interface: AssetProxyOwnerRequirementChangeEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerRequirementChangeEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [required](#required) - -## Properties - -### required - -• **required**: *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:113](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L113)* - -
- -> # Interface: AssetProxyOwnerRevocationEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerRevocationEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L84)* - -
- -> # Interface: AssetProxyOwnerSubmissionEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerSubmissionEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [transactionId](#transactionid) - -## Properties - -### transactionId - -• **transactionId**: *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:88](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L88)* - -
- -> # Interface: AssetProxyOwnerTimeLockChangeEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **AssetProxyOwnerTimeLockChangeEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [secondsTimeLocked](#secondstimelocked) - -## Properties - -### secondsTimeLocked - -• **secondsTimeLocked**: *`BigNumber`* - -*Defined in [generated-wrappers/asset_proxy_owner.ts:74](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/generated-wrappers/asset_proxy_owner.ts#L74)* - -
- -> # Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **CoordinatorRegistryCoordinatorEndpointSetEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)* - -
- -> # Interface: DummyERC20TokenApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **DummyERC20TokenApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)* - -
- -> # Interface: DummyERC20TokenTransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **DummyERC20TokenTransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* - -
- -> # Interface: DummyERC721TokenApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **DummyERC721TokenApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* - -
- -> # Interface: DummyERC721TokenApprovalForAllEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **DummyERC721TokenApprovalForAllEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)* - -
- -> # Interface: DummyERC721TokenTransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **DummyERC721TokenTransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* - -
- -> # Interface: ERC20ProxyAuthorizedAddressAddedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC20ProxyAuthorizedAddressAddedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L44)* - -
- -> # Interface: ERC20ProxyAuthorizedAddressRemovedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC20ProxyAuthorizedAddressRemovedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)* - -
- -> # Interface: ERC20TokenApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC20TokenApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L50)* - -
- -> # Interface: ERC20TokenTransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC20TokenTransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L44)* - -
- -> # Interface: ERC721ProxyAuthorizedAddressAddedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC721ProxyAuthorizedAddressAddedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L44)* - -
- -> # Interface: ERC721ProxyAuthorizedAddressRemovedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC721ProxyAuthorizedAddressRemovedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)* - -
- -> # Interface: ERC721TokenApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC721TokenApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L54)* - -
- -> # Interface: ERC721TokenApprovalForAllEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC721TokenApprovalForAllEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L58)* - -
- -> # Interface: ERC721TokenTransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ERC721TokenTransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L48)* - -
- -> # Interface: ExchangeAssetProxyRegisteredEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ExchangeAssetProxyRegisteredEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [assetProxy](#assetproxy) -* [id](#id) - -## Properties - -### assetProxy - -• **assetProxy**: *string* - -*Defined in [generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L85)* - -
- -> # Interface: ExchangeCancelEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ExchangeCancelEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L75)* - -
- -> # Interface: ExchangeCancelUpToEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ExchangeCancelUpToEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L80)* - -
- -> # Interface: ExchangeFillEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ExchangeFillEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L63)* - -
- -> # Interface: ExchangeSignatureValidatorApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ExchangeSignatureValidatorApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L51)* - -
- -> # Interface: MultiAssetProxyAssetProxyRegisteredEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **MultiAssetProxyAssetProxyRegisteredEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L56)* - -
- -> # Interface: MultiAssetProxyAuthorizedAddressAddedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **MultiAssetProxyAuthorizedAddressAddedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L46)* - -
- -> # Interface: MultiAssetProxyAuthorizedAddressRemovedEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **MultiAssetProxyAuthorizedAddressRemovedEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/multi_asset_proxy.ts#L51)* - -
- -> # Interface: WETH9ApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **WETH9ApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L50)* - -
- -> # Interface: WETH9DepositEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **WETH9DepositEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L61)* - -
- -> # Interface: WETH9TransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **WETH9TransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L56)* - -
- -> # Interface: WETH9WithdrawalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **WETH9WithdrawalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## Index - -### Properties - -* [_owner](#_owner) -* [_value](#_value) - -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L66)* - -
- -> # Interface: ZRXTokenApprovalEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ZRXTokenApprovalEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L50)* - -
- -> # Interface: ZRXTokenTransferEventArgs - -## Hierarchy - -* `DecodedLogArgs` - - * **ZRXTokenTransferEventArgs** - -## Indexable - -● \[▪ **argName**: *string*\]: `ContractEventArg` - -## 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/b834b7060/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/b834b7060/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/b834b7060/packages/contract-wrappers/src/generated-wrappers/zrx_token.ts#L44)* - -
- -> # Interface: ContractWrappersConfig +# 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:37](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L37)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L56)* ___ -### `Optional` contractAddresses +## `Optional` contractAddresses • **contractAddresses**? : *`ContractAddresses`* -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L36)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L55)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L35)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L54)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L34)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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:80](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L80)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L115)* ___ -### salt +## salt • **salt**: *`BigNumber`* -*Defined in [types.ts:78](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L78)* +*Defined in [types.ts:113](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L113)* ___ -### signerAddress +## signerAddress • **signerAddress**: *string* -*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L79)* +*Defined in [types.ts:114](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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:7](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L7)* ___ -### log +## log • **log**: *`LogWithDecodedArgs`* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L8)*
-> # Interface: IndexedFilterValues +# Interface: IndexedFilterValues -## Hierarchy +### Hierarchy * **IndexedFilterValues** -## Indexable -● \[▪ **index**: *string*\]: `ContractEventArg` +### Hierarchy -
+* **OrderAndTraderInfo** -> # Interface: OrderInfo - -## Hierarchy - -* **OrderInfo** - -## Index ### Properties -* [orderHash](#orderhash) -* [orderStatus](#orderstatus) -* [orderTakerAssetFilledAmount](#ordertakerassetfilledamount) +## orderInfo -## Properties +• **orderInfo**: *[OrderInfo](#interface-orderinfo)* -### orderHash - -• **orderHash**: *string* - -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L61)* +*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L106)* ___ -### orderStatus +## traderInfo -• **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* +• **traderInfo**: *[TraderInfo](#interface-traderinfo)* -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L60)* - -___ - -### orderTakerAssetFilledAmount - -• **orderTakerAssetFilledAmount**: *`BigNumber`* - -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L62)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L107)*
-> # Interface: OrderTransactionOpts +# Interface: OrderInfo + +### Hierarchy + +* **OrderInfo** + + +### Properties + +## orderHash + +• **orderHash**: *string* + +*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L80)* + +___ + +## orderStatus + +• **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* + +*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L79)* + +___ + +## orderTakerAssetFilledAmount + +• **orderTakerAssetFilledAmount**: *`BigNumber`* + +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L81)* + +
+ +# Interface: OrderTransactionOpts shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true. -## 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:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L47)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L66)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Inherited from [TransactionOpts](#optional-gasprice)* -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L46)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L65)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [TransactionOpts](#optional-nonce)* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L48)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L67)* ___ -### `Optional` shouldValidate +## `Optional` shouldValidate • **shouldValidate**? : *undefined | false | true* -*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L56)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L75)*
-> # Interface: TransactionOpts +# Interface: TraderInfo + +### Hierarchy + +* **TraderInfo** + + +### Properties + +## makerAllowance + +• **makerAllowance**: *`BigNumber`* + +*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L96)* + +___ + +## makerBalance + +• **makerBalance**: *`BigNumber`* + +*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L95)* + +___ + +## makerZrxAllowance + +• **makerZrxAllowance**: *`BigNumber`* + +*Defined in [types.ts:100](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L100)* + +___ + +## makerZrxBalance + +• **makerZrxBalance**: *`BigNumber`* + +*Defined in [types.ts:99](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L99)* + +___ + +## takerAllowance + +• **takerAllowance**: *`BigNumber`* + +*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L98)* + +___ + +## takerBalance + +• **takerBalance**: *`BigNumber`* + +*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L97)* + +___ + +## takerZrxAllowance + +• **takerZrxAllowance**: *`BigNumber`* + +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L102)* + +___ + +## takerZrxBalance + +• **takerZrxBalance**: *`BigNumber`* + +*Defined in [types.ts:101](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L101)* + +
+ +# 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:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L47)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L66)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L46)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L65)* ___ -### `Optional` nonce +## `Optional` nonce • **nonce**? : *undefined | number* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L48)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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:17](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L17)* ___ -### `Optional` gas +## `Optional` gas • **gas**? : *undefined | number* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L18)* ___ -### `Optional` gasPrice +## `Optional` gasPrice • **gasPrice**? : *`BigNumber`* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L20)* ___ -### `Optional` value +## `Optional` value • **value**? : *`BigNumber`* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/contract-wrappers/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/types.ts#L19)*
-> # Interface: CoordinatorOutstandingFillSignatures +# 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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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) - -## Properties - -### `Optional` body +## `Optional` body • **body**? : *[CoordinatorServerCancellationResponse](_utils_coordinator_server_types_.coordinatorservercancellationresponse.md) | [CoordinatorServerApprovalRawResponse](#class-coordinatorserverapprovalrawresponse)* -*Defined in [utils/coordinator_server_types.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)* +*Defined in [utils/coordinator_server_types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/contract-wrappers/src/utils/coordinator_server_types.ts#L26)*
diff --git a/packages/ethereum-types/docs/reference.mdx b/packages/ethereum-types/docs/reference.mdx index 7376afd39c..5cf5c69b3a 100644 --- a/packages/ethereum-types/docs/reference.mdx +++ b/packages/ethereum-types/docs/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/b834b7060/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L455)* ___ -### Event +## Event • **Event**: = "event" -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L456)* ___ -### Fallback +## Fallback • **Fallback**: = "fallback" -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L457)* ___ -### Function +## Function • **Function**: = "function" -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L470)* +*Defined in [index.ts:470](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L470)* ___ -### Latest +## Latest • **Latest**: = "latest" -*Defined in [index.ts:471](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L471)* +*Defined in [index.ts:471](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L471)* ___ -### Pending +## Pending • **Pending**: = "pending" -*Defined in [index.ts:472](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L472)* +*Defined in [index.ts:472](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L141)* +*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L141)* ___ -### AddMod +## AddMod • **AddMod**: = "ADDMOD" -*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L148)* +*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L148)* ___ -### Address +## Address • **Address**: = "ADDRESS" -*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L167)* +*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L167)* ___ -### And +## And • **And**: = "AND" -*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L159)* +*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L159)* ___ -### Balance +## Balance • **Balance**: = "BALANCE" -*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L168)* +*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L168)* ___ -### BlockHash +## BlockHash • **BlockHash**: = "BLOCKHASH" -*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L183)* +*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L183)* ___ -### Byte +## Byte • **Byte**: = "BYTE" -*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L163)* +*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L163)* ___ -### Call +## Call • **Call**: = "CALL" -*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L276)* +*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L276)* ___ -### CallCode +## CallCode • **CallCode**: = "CALLCODE" -*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L277)* +*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L277)* ___ -### CallDataCopy +## CallDataCopy • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L174)* +*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L174)* ___ -### CallDataLoad +## CallDataLoad • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [index.ts:172](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L172)* +*Defined in [index.ts:172](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L172)* ___ -### CallDataSize +## CallDataSize • **CallDataSize**: = "CALLDATASIZE" -*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L173)* +*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L173)* ___ -### CallValue +## CallValue • **CallValue**: = "CALLVALUE" -*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L171)* +*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L171)* ___ -### Caller +## Caller • **Caller**: = "CALLER" -*Defined in [index.ts:170](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L170)* +*Defined in [index.ts:170](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L170)* ___ -### CodeCopy +## CodeCopy • **CodeCopy**: = "CODECOPY" -*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L176)* +*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L176)* ___ -### CodeSize +## CodeSize • **CodeSize**: = "CODESIZE" -*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L175)* +*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L175)* ___ -### Coinbase +## Coinbase • **Coinbase**: = "COINBASE" -*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L184)* +*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L184)* ___ -### Create +## Create • **Create**: = "CREATE" -*Defined in [index.ts:275](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L275)* +*Defined in [index.ts:275](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L275)* ___ -### DelegateCall +## DelegateCall • **DelegateCall**: = "DELEGATECALL" -*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L279)* +*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L279)* ___ -### Difficulty +## Difficulty • **Difficulty**: = "DIFFICULTY" -*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L187)* +*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L187)* ___ -### Div +## Div • **Div**: = "DIV" -*Defined in [index.ts:144](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L144)* +*Defined in [index.ts:144](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L144)* ___ -### Dup1 +## Dup1 • **Dup1**: = "DUP1" -*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L236)* +*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L236)* ___ -### Dup10 +## Dup10 • **Dup10**: = "DUP10" -*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L245)* +*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L245)* ___ -### Dup11 +## Dup11 • **Dup11**: = "DUP11" -*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L246)* +*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L246)* ___ -### Dup12 +## Dup12 • **Dup12**: = "DUP12" -*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L247)* +*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L247)* ___ -### Dup13 +## Dup13 • **Dup13**: = "DUP13" -*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L248)* +*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L248)* ___ -### Dup14 +## Dup14 • **Dup14**: = "DUP14" -*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L249)* +*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L249)* ___ -### Dup15 +## Dup15 • **Dup15**: = "DUP15" -*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L250)* +*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L250)* ___ -### Dup16 +## Dup16 • **Dup16**: = "DUP16" -*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L251)* +*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L251)* ___ -### Dup2 +## Dup2 • **Dup2**: = "DUP2" -*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L237)* +*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L237)* ___ -### Dup3 +## Dup3 • **Dup3**: = "DUP3" -*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L238)* +*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L238)* ___ -### Dup4 +## Dup4 • **Dup4**: = "DUP4" -*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L239)* +*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L239)* ___ -### Dup5 +## Dup5 • **Dup5**: = "DUP5" -*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L240)* +*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L240)* ___ -### Dup6 +## Dup6 • **Dup6**: = "DUP6" -*Defined in [index.ts:241](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L241)* +*Defined in [index.ts:241](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L241)* ___ -### Dup7 +## Dup7 • **Dup7**: = "DUP7" -*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L242)* +*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L242)* ___ -### Dup8 +## Dup8 • **Dup8**: = "DUP8" -*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L243)* +*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L243)* ___ -### Dup9 +## Dup9 • **Dup9**: = "DUP9" -*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L244)* +*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L244)* ___ -### Eq +## Eq • **Eq**: = "EQ" -*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L157)* +*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L157)* ___ -### Exp +## Exp • **Exp**: = "EXP" -*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L150)* +*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L150)* ___ -### ExtCodeCopy +## ExtCodeCopy • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L179)* +*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L179)* ___ -### ExtCodeSize +## ExtCodeSize • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L178)* +*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L178)* ___ -### Gas +## Gas • **Gas**: = "GAS" -*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L200)* +*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L200)* ___ -### GasPrice +## GasPrice • **GasPrice**: = "GASPRICE" -*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L177)* +*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L177)* ___ -### Gaslimit +## Gaslimit • **Gaslimit**: = "GASLIMIT" -*Defined in [index.ts:188](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L188)* +*Defined in [index.ts:188](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L188)* ___ -### Gt +## Gt • **Gt**: = "GT" -*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L154)* +*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L154)* ___ -### Invalid +## Invalid • **Invalid**: = "INVALID" -*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L282)* +*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L282)* ___ -### IsZero +## IsZero • **IsZero**: = "ISZERO" -*Defined in [index.ts:158](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L158)* +*Defined in [index.ts:158](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L158)* ___ -### Jump +## Jump • **Jump**: = "JUMP" -*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L196)* +*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L196)* ___ -### JumpDest +## JumpDest • **JumpDest**: = "JUMPDEST" -*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L201)* +*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L201)* ___ -### Jumpi +## Jumpi • **Jumpi**: = "JUMPI" -*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L197)* +*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L197)* ___ -### Log1 +## Log1 • **Log1**: = "LOG1" -*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L270)* +*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L270)* ___ -### Log2 +## Log2 • **Log2**: = "LOG2" -*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L271)* +*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L271)* ___ -### Log3 +## Log3 • **Log3**: = "LOG3" -*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L272)* +*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L272)* ___ -### Log4 +## Log4 • **Log4**: = "LOG4" -*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L273)* +*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L273)* ___ -### Lt +## Lt • **Lt**: = "LT" -*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L153)* +*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L153)* ___ -### MLoad +## MLoad • **MLoad**: = "MLOAD" -*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L191)* +*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L191)* ___ -### MSize +## MSize • **MSize**: = "MSIZE" -*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L199)* +*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L199)* ___ -### MStore +## MStore • **MStore**: = "MSTORE" -*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L192)* +*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L192)* ___ -### MStore8 +## MStore8 • **MStore8**: = "MSTORE8" -*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L193)* +*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L193)* ___ -### Mod +## Mod • **Mod**: = "MOD" -*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L146)* +*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L146)* ___ -### Mul +## Mul • **Mul**: = "MUL" -*Defined in [index.ts:142](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L142)* +*Defined in [index.ts:142](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L142)* ___ -### MulMod +## MulMod • **MulMod**: = "MULMOD" -*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L149)* +*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L149)* ___ -### Not +## Not • **Not**: = "NOT" -*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L162)* +*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L162)* ___ -### Number +## Number • **Number**: = "NUMBER" -*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L186)* +*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L186)* ___ -### Or +## Or • **Or**: = "OR" -*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L160)* +*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L160)* ___ -### Origin +## Origin • **Origin**: = "ORIGIN" -*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L169)* +*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L169)* ___ -### Pc +## Pc • **Pc**: = "PC" -*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L198)* +*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L198)* ___ -### Pop +## Pop • **Pop**: = "POP" -*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L190)* +*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L190)* ___ -### Push1 +## Push1 • **Push1**: = "PUSH1" -*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L203)* +*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L203)* ___ -### Push10 +## Push10 • **Push10**: = "PUSH10" -*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L212)* +*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L212)* ___ -### Push11 +## Push11 • **Push11**: = "PUSH11" -*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L213)* +*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L213)* ___ -### Push12 +## Push12 • **Push12**: = "PUSH12" -*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L214)* +*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L214)* ___ -### Push13 +## Push13 • **Push13**: = "PUSH13" -*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L215)* +*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L215)* ___ -### Push14 +## Push14 • **Push14**: = "PUSH14" -*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L216)* +*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L216)* ___ -### Push15 +## Push15 • **Push15**: = "PUSH15" -*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L217)* +*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L217)* ___ -### Push16 +## Push16 • **Push16**: = "PUSH16" -*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L218)* +*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L218)* ___ -### Push17 +## Push17 • **Push17**: = "PUSH17" -*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L219)* +*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L219)* ___ -### Push18 +## Push18 • **Push18**: = "PUSH18" -*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L220)* +*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L220)* ___ -### Push19 +## Push19 • **Push19**: = "PUSH19" -*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L221)* +*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L221)* ___ -### Push2 +## Push2 • **Push2**: = "PUSH2" -*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L204)* +*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L204)* ___ -### Push20 +## Push20 • **Push20**: = "PUSH20" -*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L222)* +*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L222)* ___ -### Push21 +## Push21 • **Push21**: = "PUSH21" -*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L223)* +*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L223)* ___ -### Push22 +## Push22 • **Push22**: = "PUSH22" -*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L224)* +*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L224)* ___ -### Push23 +## Push23 • **Push23**: = "PUSH23" -*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L225)* +*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L225)* ___ -### Push24 +## Push24 • **Push24**: = "PUSH24" -*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L226)* +*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L226)* ___ -### Push25 +## Push25 • **Push25**: = "PUSH25" -*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L227)* +*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L227)* ___ -### Push26 +## Push26 • **Push26**: = "PUSH26" -*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L228)* +*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L228)* ___ -### Push27 +## Push27 • **Push27**: = "PUSH27" -*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L229)* +*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L229)* ___ -### Push28 +## Push28 • **Push28**: = "PUSH28" -*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L230)* +*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L230)* ___ -### Push29 +## Push29 • **Push29**: = "PUSH29" -*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L231)* +*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L231)* ___ -### Push3 +## Push3 • **Push3**: = "PUSH3" -*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L205)* +*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L205)* ___ -### Push30 +## Push30 • **Push30**: = "PUSH30" -*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L232)* +*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L232)* ___ -### Push31 +## Push31 • **Push31**: = "PUSH31" -*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L233)* +*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L233)* ___ -### Push32 +## Push32 • **Push32**: = "PUSH32" -*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L234)* +*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L234)* ___ -### Push4 +## Push4 • **Push4**: = "PUSH4" -*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L206)* +*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L206)* ___ -### Push5 +## Push5 • **Push5**: = "PUSH5" -*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L207)* +*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L207)* ___ -### Push6 +## Push6 • **Push6**: = "PUSH6" -*Defined in [index.ts:208](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L208)* +*Defined in [index.ts:208](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L208)* ___ -### Push7 +## Push7 • **Push7**: = "PUSH7" -*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L209)* +*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L209)* ___ -### Push8 +## Push8 • **Push8**: = "PUSH8" -*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L210)* +*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L210)* ___ -### Push9 +## Push9 • **Push9**: = "PUSH9" -*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L211)* +*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L211)* ___ -### Return +## Return • **Return**: = "RETURN" -*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L278)* +*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L278)* ___ -### ReturnDataCopy +## ReturnDataCopy • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L181)* +*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L181)* ___ -### ReturnDataSize +## ReturnDataSize • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L180)* +*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L180)* ___ -### Revert +## Revert • **Revert**: = "REVERT" -*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L281)* +*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L281)* ___ -### SDiv +## SDiv • **SDiv**: = "SDIV" -*Defined in [index.ts:145](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L145)* +*Defined in [index.ts:145](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L145)* ___ -### SGt +## SGt • **SGt**: = "SGT" -*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L156)* +*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L156)* ___ -### SLoad +## SLoad • **SLoad**: = "SLOAD" -*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L194)* +*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L194)* ___ -### SLt +## SLt • **SLt**: = "SLT" -*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L155)* +*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L155)* ___ -### SMod +## SMod • **SMod**: = "SMOD" -*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L147)* +*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L147)* ___ -### SStore +## SStore • **SStore**: = "SSTORE" -*Defined in [index.ts:195](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L195)* +*Defined in [index.ts:195](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L195)* ___ -### SelfDestruct +## SelfDestruct • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L283)* +*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L283)* ___ -### Sha3 +## Sha3 • **Sha3**: = "SHA3" -*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L165)* +*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L165)* ___ -### SignExtend +## SignExtend • **SignExtend**: = "SIGNEXTEND" -*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L151)* +*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L151)* ___ -### StaticCall +## StaticCall • **StaticCall**: = "STATICCALL" -*Defined in [index.ts:280](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L280)* +*Defined in [index.ts:280](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L280)* ___ -### Stop +## Stop • **Stop**: = "STOP" -*Defined in [index.ts:140](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L140)* +*Defined in [index.ts:140](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L140)* ___ -### Sub +## Sub • **Sub**: = "SUB" -*Defined in [index.ts:143](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L143)* +*Defined in [index.ts:143](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L143)* ___ -### Swap1 +## Swap1 • **Swap1**: = "SWAP1" -*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L253)* +*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L253)* ___ -### Swap10 +## Swap10 • **Swap10**: = "SWAP10" -*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L262)* +*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L262)* ___ -### Swap11 +## Swap11 • **Swap11**: = "SWAP11" -*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L263)* +*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L263)* ___ -### Swap12 +## Swap12 • **Swap12**: = "SWAP12" -*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L264)* +*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L264)* ___ -### Swap13 +## Swap13 • **Swap13**: = "SWAP13" -*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L265)* +*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L265)* ___ -### Swap14 +## Swap14 • **Swap14**: = "SWAP14" -*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L266)* +*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L266)* ___ -### Swap15 +## Swap15 • **Swap15**: = "SWAP15" -*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L267)* +*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L267)* ___ -### Swap16 +## Swap16 • **Swap16**: = "SWAP16" -*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L268)* +*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L268)* ___ -### Swap2 +## Swap2 • **Swap2**: = "SWAP2" -*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L254)* +*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L254)* ___ -### Swap3 +## Swap3 • **Swap3**: = "SWAP3" -*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L255)* +*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L255)* ___ -### Swap4 +## Swap4 • **Swap4**: = "SWAP4" -*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L256)* +*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L256)* ___ -### Swap5 +## Swap5 • **Swap5**: = "SWAP5" -*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L257)* +*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L257)* ___ -### Swap6 +## Swap6 • **Swap6**: = "SWAP6" -*Defined in [index.ts:258](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L258)* +*Defined in [index.ts:258](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L258)* ___ -### Swap7 +## Swap7 • **Swap7**: = "SWAP7" -*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L259)* +*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L259)* ___ -### Swap8 +## Swap8 • **Swap8**: = "SWAP8" -*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L260)* +*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L260)* ___ -### Swap9 +## Swap9 • **Swap9**: = "SWAP9" -*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L261)* +*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L261)* ___ -### TimeStamp +## TimeStamp • **TimeStamp**: = "TimeStamp" -*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L185)* +*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L185)* ___ -### Xor +## Xor • **Xor**: = "XOR" -*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L161)* +*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L489)* +*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L489)* ___ -### Bool +## Bool • **Bool**: = "bool" -*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L490)* +*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L490)* ___ -### Bytes +## Bytes • **Bytes**: = "bytes" -*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L491)* +*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L491)* ___ -### Int +## Int • **Int**: = "int" -*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L492)* +*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L492)* ___ -### String +## String • **String**: = "string" -*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L493)* +*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L493)* ___ -### Tuple +## Tuple • **Tuple**: = "tuple" -*Defined in [index.ts:494](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L494)* +*Defined in [index.ts:494](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L494)* ___ -### Uint +## Uint • **Uint**: = "uint" -*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L497)* +*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L497)* ___ -### Uint256 +## Uint256 • **Uint256**: = "uint256" -*Defined in [index.ts:495](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L495)* +*Defined in [index.ts:495](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L495)* ___ -### Uint8 +## Uint8 • **Uint8**: = "uint8" -*Defined in [index.ts:496](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L496)* +*Defined in [index.ts:496](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L350)* ___ -### extraData +## extraData • **extraData**: *string* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L352)* ___ -### gasLimit +## gasLimit • **gasLimit**: *number* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L354)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L355)* ___ -### hash +## hash • **hash**: *string | null* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L342)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* -*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L346)* ___ -### miner +## miner • **miner**: *string* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L349)* ___ -### nonce +## nonce • **nonce**: *string | null* -*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L344)* ___ -### number +## number • **number**: *number | null* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L341)* ___ -### parentHash +## parentHash • **parentHash**: *string* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L343)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* -*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L345)* ___ -### size +## size • **size**: *number* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L353)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L348)* ___ -### timestamp +## timestamp • **timestamp**: *number* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L356)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *`BigNumber`* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L351)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L347)* ___ -### uncles +## uncles • **uncles**: *string[]* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L351)* ___ -### transactions +## transactions • **transactions**: *string[]* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L346)* +*Defined in [index.ts:346](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L344)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L345)* +*Defined in [index.ts:345](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L365)* +*Defined in [index.ts:365](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L396)* +*Defined in [index.ts:396](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L723)* +*Defined in [index.ts:723](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L724)* +*Defined in [index.ts:724](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L725)* +*Defined in [index.ts:725](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L722)* +*Defined in [index.ts:722](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L727)* +*Defined in [index.ts:727](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L728)* +*Defined in [index.ts:728](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L726)* +*Defined in [index.ts:726](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L649)* +*Defined in [index.ts:649](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L649)* ___ -### version +## version • **version**: *string* -*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L648)* +*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L681)* +*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L683)* +*Defined in [index.ts:683](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L682)* +*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L680)* +*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L680)* ___ -### outputSelection +## outputSelection • **outputSelection**: *object* -*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L688)* +*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L679)* +*Defined in [index.ts:679](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L696)* +*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L103)* +*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L103)* ___ -### payable +## payable • **payable**: *boolean* -*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L104)* +*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L104)* ___ -### stateMutability +## stateMutability • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L105)* +*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L105)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L633)* +*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L643)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L643)* ___ -### contractName +## contractName • **contractName**: *string* -*Defined in [index.ts:667](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L667)* +*Defined in [index.ts:667](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L668)* +*Defined in [index.ts:668](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L668)* ___ -### schemaVersion +## schemaVersion • **schemaVersion**: *string* -*Defined in [index.ts:666](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L666)* +*Defined in [index.ts:666](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L639)* +*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L634)* +*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L546)* +*Defined in [index.ts:546](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L546)* ___ -### constructorArgs +## constructerArgs • **constructorArgs**: *string* -*Defined in [index.ts:550](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L550)* +*Defined in [index.ts:550](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L550)* ___ -### links +## links • **links**: *object* -*Defined in [index.ts:547](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L547)* +*Defined in [index.ts:547](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L633)* +*Defined in [index.ts:633](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L643)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L643)* ___ -### sourceCodes +## sourceCodes • **sourceCodes**: *object* -*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L639)* +*Defined in [index.ts:639](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L642)* ___ -### sources +## sources • **sources**: *object* -*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L634)* +*Defined in [index.ts:634](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L131)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L129)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L428)* ___ -### args +## args • **args**: *`A`* -*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L429)* ___ -### event +## event • **event**: *string* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L423)* ___ -### removed +## removed • **removed**: *boolean* -*Defined in [index.ts:415](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L415)* +*Defined in [index.ts:415](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L620)* +*Defined in [index.ts:620](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L620)* ___ -### methods +## methods • **methods**: *object* -*Defined in [index.ts:621](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L621)* +*Defined in [index.ts:621](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L619)* +*Defined in [index.ts:619](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L73)* +*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L75)* +*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L125)* +*Defined in [index.ts:125](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L124)* +*Defined in [index.ts:124](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L124)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:123](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L123)* +*Defined in [index.ts:123](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L123)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L122)* +*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L131)* ___ -### indexed +## indexed • **indexed**: *boolean* -*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L116)* +*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L614)* +*Defined in [index.ts:614](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L614)* ___ -### sourceMap +## sourceMap • **sourceMap**: *string* -*Defined in [index.ts:615](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L615)* +*Defined in [index.ts:615](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L609)* +*Defined in [index.ts:609](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L610)* +*Defined in [index.ts:610](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L112)* +*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L112)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L111)* +*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L403)* +*Defined in [index.ts:403](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L402)* +*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L400)* +*Defined in [index.ts:400](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L401)* +*Defined in [index.ts:401](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L404)* +*Defined in [index.ts:404](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L14)* +*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L672)* +*Defined in [index.ts:672](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L674)* +*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L674)* ___ -### version +## version • **version**: *string* -*Defined in [index.ts:673](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L673)* +*Defined in [index.ts:673](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L324)* +*Defined in [index.ts:324](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L324)* ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Defined in [index.ts:325](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L325)* +*Defined in [index.ts:325](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L325)* ___ -### method +## method • **method**: *string* -*Defined in [index.ts:323](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L323)* +*Defined in [index.ts:323](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L323)* ___ -### params +## params • **params**: *any[]* -*Defined in [index.ts:322](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L322)* +*Defined in [index.ts:322](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L330)* +*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L330)* ___ -### message +## message • **message**: *string* -*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L329)* +*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L337)* +*Defined in [index.ts:337](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L337)* ___ -### id +## id • **id**: *number* -*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L335)* +*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L335)* ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L336)* +*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L336)* ___ -### result +## result • **result**: *any* -*Defined in [index.ts:334](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L334)* +*Defined in [index.ts:334](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L428)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L426)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* -*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L427)* ___ -### data +## data • **data**: *string* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L429)* ___ -### logIndex +## logIndex • **logIndex**: *number | null* -*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L423)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L430)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L425)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* -*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L423)* ___ -### removed +## removed • **removed**: *boolean* -*Defined in [index.ts:419](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L419)* +*Defined in [index.ts:419](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L428)* +*Defined in [index.ts:428](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L411)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L426)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L427)* +*Defined in [index.ts:427](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L423)* +*Defined in [index.ts:423](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L424)* +*Defined in [index.ts:424](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L94)* +*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L92)* +*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L92)* ___ -### name +## name • **name**: *string* -*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L91)* +*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L93)* ___ -### payable +## payable • **payable**: *boolean* -*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L96)* +*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L96)* ___ -### stateMutability +## stateMutability • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L95)* +*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L95)* ___ -### type +## type • **type**: *string* -*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L90)* +*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L700)* +*Defined in [index.ts:700](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L701)* +*Defined in [index.ts:701](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L20)* +*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L483)* +*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L483)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [index.ts:481](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L481)* +*Defined in [index.ts:481](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L481)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [index.ts:482](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L482)* +*Defined in [index.ts:482](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L482)* ___ -### data +## data • **data**: *string* -*Defined in [index.ts:484](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L484)* +*Defined in [index.ts:484](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L484)* ___ -### logIndex +## logIndex • **logIndex**: *string | null* -*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L478)* +*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L478)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [index.ts:485](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L485)* +*Defined in [index.ts:485](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L485)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L480)* +*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L480)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L479)* +*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L596)* +*Defined in [index.ts:596](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L599)* +*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L599)* ___ -### message +## message • **message**: *string* -*Defined in [index.ts:598](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L598)* +*Defined in [index.ts:598](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L598)* ___ -### severity +## severity • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [index.ts:597](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L597)* +*Defined in [index.ts:597](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L594)* +*Defined in [index.ts:594](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L594)* ___ -### type +## type • **type**: *[ErrorType](#errortype)* -*Defined in [index.ts:595](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L595)* +*Defined in [index.ts:595](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L705)* +*Defined in [index.ts:705](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L605)* +*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L605)* ___ -### file +## file • **file**: *string* -*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L603)* +*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L603)* ___ -### start +## start • **start**: *number* -*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L604)* +*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L556)* +*Defined in [index.ts:556](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L558)* +*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L557)* +*Defined in [index.ts:557](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L570)* +*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L562)* +*Defined in [index.ts:562](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L562)* ___ -### sources +## sources • **sources**: *object* -*Defined in [index.ts:563](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L563)* +*Defined in [index.ts:563](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L287)* +*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L287)* ___ -### error +## error • **error**: *string* -*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L288)* +*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L288)* ___ -### gas +## gas • **gas**: *number* -*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L289)* +*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L289)* ___ -### gasCost +## gasCost • **gasCost**: *number* -*Defined in [index.ts:290](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L290)* +*Defined in [index.ts:290](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L290)* ___ -### memory +## memory • **memory**: *string[]* -*Defined in [index.ts:291](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L291)* +*Defined in [index.ts:291](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L292)* +*Defined in [index.ts:292](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L292)* ___ -### pc +## pc • **pc**: *number* -*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L293)* +*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L293)* ___ -### stack +## stack • **stack**: *string[]* -*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L294)* +*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L294)* ___ -### storage +## storage • **storage**: *object* -*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L295)* +*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L510)* +*Defined in [index.ts:510](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L511)* +*Defined in [index.ts:511](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L512)* +*Defined in [index.ts:512](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L514)* +*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L513)* +*Defined in [index.ts:513](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L371)* +*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L371)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number | null* -*Defined in [index.ts:372](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L372)* +*Defined in [index.ts:372](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L372)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:374](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L374)* +*Defined in [index.ts:374](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L374)* ___ -### gas +## gas • **gas**: *number* -*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L378)* +*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L378)* ___ -### gasPrice +## gasPrice • **gasPrice**: *`BigNumber`* -*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L377)* +*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L377)* ___ -### hash +## hash • **hash**: *string* -*Defined in [index.ts:369](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L369)* +*Defined in [index.ts:369](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L369)* ___ -### input +## input • **input**: *string* -*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L379)* +*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L379)* ___ -### nonce +## nonce • **nonce**: *number* -*Defined in [index.ts:370](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L370)* +*Defined in [index.ts:370](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L370)* ___ -### to +## to • **to**: *string | null* -*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L375)* +*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L375)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number | null* -*Defined in [index.ts:373](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L373)* +*Defined in [index.ts:373](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L373)* ___ -### value +## value • **value**: *`BigNumber`* -*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L376)* +*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L440)* +*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L440)* ___ -### blockNumber +## blockNumber • **blockNumber**: *number* -*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L441)* +*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L441)* ___ -### contractAddress +## contractAddress • **contractAddress**: *string | null* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L449)* ___ -### cumulativeGasUsed +## cumulativeGasUsed • **cumulativeGasUsed**: *number* -*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L447)* +*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L447)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L444)* +*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L444)* ___ -### gasUsed +## gasUsed • **gasUsed**: *number* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L450)* ___ -### status +## status • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L446)* +*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L446)* ___ -### to +## to • **to**: *string* -*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L445)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L442)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *number* -*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L443)* +*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L440)* +*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L441)* +*Defined in [index.ts:441](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L447)* +*Defined in [index.ts:447](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L444)* +*Defined in [index.ts:444](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L506)* +*Defined in [index.ts:506](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L446)* +*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L443)* +*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L299)* +*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L299)* ___ -### returnValue +## returnValue • **returnValue**: *any* -*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L300)* +*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L301)* +*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L387)* ___ -### from +## from • **from**: *string* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L387)* +*Defined in [index.ts:387](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L386)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L388)* +*Defined in [index.ts:388](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -## Methods - -### send +## send ▸ **send**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L30)* +*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/ethereum-types/src/index.ts#L35)* +*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -5307,11 +4601,11 @@ Name | Type | ___ -### `Optional` stop +## `Optional` stop ▸ **stop**(): *void* -*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/ethereum-types/src/index.ts#L33)* +*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* diff --git a/packages/json-schemas/docs/reference.mdx b/packages/json-schemas/docs/reference.mdx index 1b7b1edf3a..2dff638921 100644 --- a/packages/json-schemas/docs/reference.mdx +++ b/packages/json-schemas/docs/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/b834b7060/packages/json-schemas/src/schema_validator.ts#L15)* +*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/json-schemas/src/schema_validator.ts#L32)* +*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/json-schemas/src/schema_validator.ts#L57)* +*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/json-schemas/src/schema_validator.ts#L46)* +*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L46)* Validate the JS object conforms to a specific JSON schema diff --git a/packages/migrations/docs/reference.mdx b/packages/migrations/docs/reference.mdx index 840ffdb5de..81fc131e24 100644 --- a/packages/migrations/docs/reference.mdx +++ b/packages/migrations/docs/reference.mdx @@ -1,206 +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/b834b7060/packages/migrations/src/types.ts#L26)* +*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L26)* ___ -### Arbitrage +## Arbitrage • **Arbitrage**: = "Arbitrage" -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L28)* ___ -### DummyToken +## DummyToken • **DummyToken**: = "DummyToken" -*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L23)* ___ -### EtherDelta +## EtherDelta • **EtherDelta**: = "EtherDelta" -*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L27)* +*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L27)* ___ -### Exchange +## Exchange • **Exchange**: = "Exchange" -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L21)* ___ -### MultiSigWalletWithTimeLock +## MultiSigWalletWithTimeLock • **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock" -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L20)* ___ -### MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress +## MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress • **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress" -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L25)* ___ -### TokenRegistry +## TokenRegistry • **TokenRegistry**: = "TokenRegistry" -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L19)* ___ -### TokenTransferProxy +## TokenTransferProxy • **TokenTransferProxy**: = "TokenTransferProxy" -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L18)* ___ -### WETH9 +## WETH9 • **WETH9**: = "WETH9" -*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L24)* ___ -### ZRXToken +## ZRXToken • **ZRXToken**: = "ZRXToken" -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/migrations/src/types.ts#L4)* +*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L4)* ___ -### decimals +## decimals • **decimals**: *`BigNumber`* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L7)* ___ -### ipfsHash +## ipfsHash • **ipfsHash**: *string* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L8)* ___ -### name +## name • **name**: *string* -*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L5)* ___ -### swarmHash +## swarmHash • **swarmHash**: *string* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L9)* ___ -### symbol +## symbol • **symbol**: *string* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/migrations/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L13)* ___ -### symbol +## symbol • **symbol**: *string* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/migrations/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L14)*
diff --git a/packages/order-utils/docs/reference.mdx b/packages/order-utils/docs/reference.mdx index d2ef5ed7ea..8501c878cb 100644 --- a/packages/order-utils/docs/reference.mdx +++ b/packages/order-utils/docs/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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) - -### Methods - -* [transferFromAsync](#transferfromasync) - -## Constructors - -### constructor +## constructer \+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](_abstract_abstract_balance_and_proxy_allowance_lazy_store_.abstractbalanceandproxyallowancelazystore.md)): *[ExchangeTransferSimulator](#class-exchangetransfersimulator)* -*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* +*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* +*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [getMaxFillableTakerAssetAmountAsync](#getmaxfillabletakerassetamountasync) -* [getOpenOrderRelevantStateAsync](#getopenorderrelevantstateasync) -* [getOpenOrderStateAsync](#getopenorderstateasync) - -## Constructors - -### constructor +## constructer \+ **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)* -*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/order_state_utils.ts#L98)* +*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_state_utils.ts#L192)* +*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_state_utils.ts#L162)* +*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_state_utils.ts#L122)* +*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [validateFillOrderThrowIfInvalidAsync](#validatefillorderthrowifinvalidasync) -* [validateOrderFillableOrThrowAsync](#validateorderfillableorthrowasync) -* [isRoundingErrorFloor](#static-isroundingerrorfloor) -* [validateFillOrderBalancesAllowancesThrowIfInvalidAsync](#static-validatefillorderbalancesallowancesthrowifinvalidasync) -* [validateMakerTransferThrowIfInvalidAsync](#static-validatemakertransferthrowifinvalidasync) - -## Constructors - -### constructor +## constructer \+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md), `supportedProvider`: `SupportedProvider`): *[OrderValidationUtils](#class-ordervalidationutils)* -*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/order_validation_utils.ts#L159)* +*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_validation_utils.ts#L236)* +*Defined in [order_validation_utils.ts:237](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L237)* 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/b834b7060/packages/order-utils/src/order_validation_utils.ts#L185)* +*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_validation_utils.ts#L34)* +*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_validation_utils.ts#L61)* +*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/order_validation_utils.ts#L127)* +*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/remaining_fillable_calculator.ts#L11)* +*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/remaining_fillable_calculator.ts#L30)* +*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [deleteAll](#deleteall) -* [deleteAllERC721ProxyAllowance](#deleteallerc721proxyallowance) -* [deleteBalance](#deletebalance) -* [deleteProxyAllowance](#deleteproxyallowance) -* [getBalanceAsync](#getbalanceasync) -* [getProxyAllowanceAsync](#getproxyallowanceasync) -* [setBalance](#setbalance) -* [setProxyAllowance](#setproxyallowance) - -## Constructors - -### constructor +## constructer \+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md)): *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)* -*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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) - -### Methods - -* [deleteAll](#deleteall) -* [deleteAllFilled](#deleteallfilled) -* [deleteAllIsCancelled](#deletealliscancelled) -* [deleteFilledTakerAmount](#deletefilledtakeramount) -* [deleteIsCancelled](#deleteiscancelled) -* [getFilledTakerAmountAsync](#getfilledtakeramountasync) -* [getIsCancelledAsync](#getiscancelledasync) -* [getZRXAssetData](#getzrxassetdata) -* [setFilledTakerAmount](#setfilledtakeramount) -* [setIsCancelled](#setiscancelled) - -## Constructors - -### constructor +## constructer \+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)* -*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L9)* ___ -### Taker +## Taker • **Taker**: = "taker" -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L15)* ___ -### Trade +## Trade • **Trade**: = "trade" -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L5)* ___ -### InvalidSignature +## InvalidSignature • **InvalidSignature**: = "INVALID_SIGNATURE" -*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L4)* +*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L70)* +*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L70)* ___ -### remainingFeeAmount +## remainingFeeAmount • **remainingFeeAmount**: *`BigNumber`* -*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L71)* +*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L71)* ___ -### resultFeeOrders +## resultFeeOrders • **resultFeeOrders**: *`T`[]* -*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L69)* +*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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,120 +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/b834b7060/packages/order-utils/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L76)* ___ -### remainingFillAmount +## remainingFillAmount • **remainingFillAmount**: *`BigNumber`* -*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L77)* ___ -### resultOrders +## resultOrders • **resultOrders**: *`T`[]* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/order-utils/src/types.ts#L82)* +*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L82)* ___ -### remainingFillAmount +## remainingFillAmount • **remainingFillAmount**: *`BigNumber`* -*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L83)* +*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L83)* ___ -### resultOrders +## resultOrders • **resultOrders**: *`T`[]* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/order-utils/src/types.ts#L81)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L81)*
diff --git a/packages/sol-compiler/docs/reference.mdx b/packages/sol-compiler/docs/reference.mdx index d7e14ee553..c52cd121e3 100644 --- a/packages/sol-compiler/docs/reference.mdx +++ b/packages/sol-compiler/docs/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/b834b7060/packages/sol-compiler/src/compiler.ts#L94)* +*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/compiler.ts#L132)* +*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/compiler.ts#L145)* +*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/compiler.ts#L149)* +*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L39)* +*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)* **Parameters:** @@ -119,41 +94,41 @@ 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/b834b7060/packages/sol-compiler/src/utils/types.ts#L38)* +*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L38)* ___ -### message +## message • **message**: *string* -*Inherited from void* + ___ -### name +## name • **name**: *string* -*Inherited from void* + ___ -### `Optional` stack +## `Optional` stack • **stack**? : *undefined | string* -*Inherited from void* + *Overrides void* @@ -161,15 +136,15 @@ ___ ___ -### typeName +## typeName • **typeName**: *string* = "CompilationError" -*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-compiler/src/utils/types.ts#L39)* +*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)* ___ -### `Static` Error +## `Static` Error ▪ **Error**: *`ErrorConstructor`* @@ -177,191 +152,145 @@ ___
-> # 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/b834b7060/packages/sol-compiler/src/utils/types.ts#L3)* +*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L4)* +*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L5)* +*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L2)* +*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L21)* +*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L22)* +*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L23)* +*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L27)* +*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L30)* +*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L31)* +*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L28)* +*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L32)* +*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-compiler/src/utils/types.ts#L29)* +*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L29)*
diff --git a/packages/sol-coverage/docs/reference.mdx b/packages/sol-coverage/docs/reference.mdx index dc44f07940..d80f07ec9c 100644 --- a/packages/sol-coverage/docs/reference.mdx +++ b/packages/sol-coverage/docs/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) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [start](#start) -* [stop](#stop) -* [writeCoverageAsync](#writecoverageasync) - -## Constructors - -### constructor +## constructer \+ **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/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L44)* +*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L44)* Instantiates a CoverageSubprovider instance @@ -46,13 +32,13 @@ Name | Type | Default | Description | **Returns:** *[CoverageSubprovider](#class-coveragesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* + @@ -72,11 +58,11 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* @@ -98,11 +84,11 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* @@ -122,11 +108,11 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* + @@ -136,11 +122,11 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* + @@ -150,11 +136,11 @@ Stops trace collection ___ -### writeCoverageAsync +## writeCoverageAsync ▸ **writeCoverageAsync**(): *`Promise`* -*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L78)* +*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L78)* Write the test coverage results to a file in Istanbul format. @@ -162,38 +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/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L28)* +*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/sol-coverage/src/coverage_subprovider.ts#L27)* +*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
diff --git a/packages/sol-profiler/docs/reference.mdx b/packages/sol-profiler/docs/reference.mdx index 86910bb22c..60dc5215e7 100644 --- a/packages/sol-profiler/docs/reference.mdx +++ b/packages/sol-profiler/docs/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/b834b7060/packages/sol-profiler/src/profiler_subprovider.ts#L30)* +*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L30)* Instantiates a ProfilerSubprovider instance @@ -46,13 +32,13 @@ Name | Type | Default | Description | **Returns:** *[ProfilerSubprovider](#class-profilersubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* + @@ -72,11 +58,11 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* @@ -98,11 +84,11 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* @@ -122,11 +108,11 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* + @@ -136,11 +122,11 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* + @@ -150,11 +136,11 @@ Stops trace collection ___ -### writeProfilerOutputAsync +## writeProfilerOutputAsync ▸ **writeProfilerOutputAsync**(): *`Promise`* -*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/sol-profiler/src/profiler_subprovider.ts#L104)* +*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L104)* Write the test profiler results to a file in Istanbul format. diff --git a/packages/sol-trace/docs/reference.mdx b/packages/sol-trace/docs/reference.mdx index 12b573bf6d..f4376f182b 100644 --- a/packages/sol-trace/docs/reference.mdx +++ b/packages/sol-trace/docs/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/b834b7060/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* +*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* Instantiates a RevertTraceSubprovider instance @@ -45,13 +32,13 @@ Name | Type | Default | Description | **Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)* -## Methods +### Methods -### emitPayloadAsync +## emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Inherited from void* + @@ -71,11 +58,11 @@ JSON RPC response payload ___ -### handleRequest +## handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: `NextCallback`, `_end`: `ErrorCallback`): *`Promise`* -*Inherited from void* + *Overrides void* @@ -97,11 +84,11 @@ Name | Type | Description | ___ -### setEngine +## setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Inherited from void* + *Overrides void* @@ -121,11 +108,11 @@ Name | Type | Description | ___ -### start +## start ▸ **start**(): *void* -*Inherited from void* + @@ -135,11 +122,11 @@ Starts trace collection ___ -### stop +## stop ▸ **stop**(): *void* -*Inherited from void* + diff --git a/packages/subproviders/docs/reference.mdx b/packages/subproviders/docs/reference.mdx index ad4058f042..ee01f86f1d 100644 --- a/packages/subproviders/docs/reference.mdx +++ b/packages/subproviders/docs/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L23)* +*Defined in [subproviders/base_wallet_subprovider.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L25)* +*Defined in [subproviders/base_wallet_subprovider.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L24)* +*Defined in [subproviders/base_wallet_subprovider.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L26)* +*Defined in [subproviders/base_wallet_subprovider.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* +*Defined in [subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/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/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ganache.ts#L13)* +*Defined in [subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ganache.ts#L31)* +*Defined in [subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor +## constructer \+ **new LedgerSubprovider**(`config`: [LedgerSubproviderConfigs](#interface-ledgersubproviderconfigs)): *[LedgerSubprovider](#class-ledgersubprovider)* -*Defined in [subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L41)* +*Defined in [subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L87)* +*Defined in [subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L68)* +*Defined in [subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L75)* +*Defined in [subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L158)* +*Defined in [subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L101)* +*Defined in [subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/ledger.ts#L196)* +*Defined in [subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/metamask_subprovider.ts#L20)* +*Defined in [subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/metamask_subprovider.ts#L40)* +*Defined in [subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/metamask_subprovider.ts#L114)* +*Defined in [subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [getPath](#getpath) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [setPath](#setpath) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor +## constructer \+ **new MnemonicWalletSubprovider**(`config`: [MnemonicWalletSubproviderConfigs](#interface-mnemonicwalletsubproviderconfigs)): *[MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider)* -*Defined in [subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* +*Defined in [subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* +*Defined in [subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* +*Defined in [subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* +*Defined in [subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* +*Defined in [subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* +*Defined in [subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* +*Defined in [subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* +*Defined in [subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* +*Defined in [subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* +*Defined in [subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* +*Defined in [subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* +*Defined in [subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* +*Defined in [subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) - -## Constructors - -### constructor +## constructer \+ **new RedundantSubprovider**(`subproviders`: [Subprovider](_subproviders_subprovider_.subprovider.md)[]): *[RedundantSubprovider](#class-redundantsubprovider)* -*Defined in [subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* +*Defined in [subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* +*Defined in [subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* +*Defined in [subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +*Defined in [subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/signer.ts#L15)* +*Defined in [subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/signer.ts#L33)* +*Defined in [subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L42)* +*Defined in [subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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) - -### Methods - -* [emitPayloadAsync](#emitpayloadasync) -* [getAccountsAsync](#getaccountsasync) -* [handleRequest](#handlerequest) -* [setEngine](#setengine) -* [signPersonalMessageAsync](#signpersonalmessageasync) -* [signTransactionAsync](#signtransactionasync) -* [signTypedDataAsync](#signtypeddataasync) - -## Constructors - -### constructor +## constructer \+ **new TrezorSubprovider**(`config`: [TrezorSubproviderConfig](#interface-trezorsubproviderconfig)): *[TrezorSubprovider](#class-trezorsubprovider)* -*Defined in [subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/subproviders/trezor.ts#L32)* +*Defined in [subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/trezor.ts#L56)* +*Defined in [subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/trezor.ts#L129)* +*Defined in [subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/trezor.ts#L70)* +*Defined in [subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/subproviders/trezor.ts#L161)* +*Defined in [subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L116)* +*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L115)* +*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L121)* +*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L121)* ___ -### EmptyParametersFound +## EmptyParametersFound • **EmptyParametersFound**: = "EMPTY_PARAMETERS_FOUND" -*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L120)* +*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L107)* +*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L108)* +*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L109)* +*Defined in [types.ts:109](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L111)* +*Defined in [types.ts:111](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L111)* ___ -### MethodNotSupported +## MethodNotSupported • **MethodNotSupported**: = "METHOD_NOT_SUPPORTED" -*Defined in [types.ts:112](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L112)* +*Defined in [types.ts:112](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L110)* +*Defined in [types.ts:110](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L56)* +*Defined in [types.ts:56](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L57)* +*Defined in [types.ts:57](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L124)* +*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L124)* ___ -### baseDerivationPath +## baseDerivationPath • **baseDerivationPath**: *string* -*Defined in [types.ts:125](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L125)* +*Defined in [types.ts:125](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L125)* ___ -### derivationPath +## derivationPath • **derivationPath**: *string* -*Defined in [types.ts:126](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L126)* +*Defined in [types.ts:126](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L126)* ___ -### hdKey +## hdKey • **hdKey**: *`HDNode`* -*Defined in [types.ts:127](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L127)* +*Defined in [types.ts:127](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L29)* +*Defined in [types.ts:29](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L29)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L30)* +*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L30)* ___ -### v +## v • **v**: *string* -*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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* + ___ -### jsonrpc +## jsonrpc • **jsonrpc**: *string* -*Inherited from void* + ___ -### method +## method • **method**: *string* *Overrides void* -*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L136)* +*Defined in [types.ts:136](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L136)* ___ -### params +## params • **params**: *any[]* -*Inherited from void* +
-> # 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/b834b7060/packages/subproviders/src/types.ts#L98)* +*Defined in [types.ts:98](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L98)* #### Type declaration: @@ -2453,25 +2233,20 @@ ___
-> # 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/b834b7060/packages/subproviders/src/types.ts#L5)* +*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L5)* #### Type declaration: @@ -2479,33 +2254,25 @@ ___
-> # 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/b834b7060/packages/subproviders/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L23)* +*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L24)* +*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L79)* +*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L79)* ___ -### chainCode +## chainCode • **chainCode**: *string* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L81)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L81)* ___ -### publicKey +## publicKey • **publicKey**: *string* -*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L80)* +*Defined in [types.ts:80](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L44)* +*Defined in [types.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L44)* ___ -### ledgerEthereumClientFactoryAsync +## ledgerEthereumClientFactoryAsync • **ledgerEthereumClientFactoryAsync**: *[LedgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync)* -*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L43)* +*Defined in [types.ts:43](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L43)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L42)* +*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L67)* +*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L68)* +*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L68)* ___ -### mnemonic +## mnemonic • **mnemonic**: *string* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L92)* +*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L91)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L89)* +*Defined in [types.ts:89](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L89)* ___ -### gas +## gas • **gas**: *string* -*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L87)* +*Defined in [types.ts:87](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L86)* +*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L86)* ___ -### nonce +## nonce • **nonce**: *string* -*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L85)* ___ -### to +## to • **to**: *string* -*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L88)* +*Defined in [types.ts:88](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L90)* +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L102)* +*Defined in [types.ts:102](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L102)* ___ -### tx +## tx • **tx**: *[PartialTxParams](#interface-partialtxparams)* -*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L103)* +*Defined in [types.ts:103](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L72)* ___ -### r +## r • **r**: *string* -*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L73)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L74)* ___ -### v +## v • **v**: *number* -*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L175)* +*Defined in [types.ts:175](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L175)* ___ -### payload +## payload • **payload**: *any* -*Defined in [types.ts:174](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L174)* +*Defined in [types.ts:174](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L174)* ___ -### success +## success • **success**: *boolean* -*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L176)* +*Defined in [types.ts:176](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L152)* +*Defined in [types.ts:152](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L152)* ___ -### childNumb +## childNumb • **childNumb**: *number* -*Defined in [types.ts:150](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L150)* +*Defined in [types.ts:150](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L150)* ___ -### depth +## depth • **depth**: *number* -*Defined in [types.ts:155](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L155)* +*Defined in [types.ts:155](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L155)* ___ -### fingerprint +## fingerprint • **fingerprint**: *number* -*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L154)* +*Defined in [types.ts:154](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L154)* ___ -### path +## path • **path**: *object* -*Defined in [types.ts:146](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L146)* +*Defined in [types.ts:146](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L146)* #### Type declaration: @@ -2975,160 +2675,135 @@ ___ ___ -### publicKey +## publicKey • **publicKey**: *string* -*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L153)* +*Defined in [types.ts:153](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L153)* ___ -### serializedPath +## serializedPath • **serializedPath**: *string* -*Defined in [types.ts:149](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L149)* +*Defined in [types.ts:149](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L149)* ___ -### xpub +## xpub • **xpub**: *string* -*Defined in [types.ts:151](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L151)* +*Defined in [types.ts:151](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L170)* +*Defined in [types.ts:170](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L165)* +*Defined in [types.ts:165](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L165)* ___ -### signature +## signature • **signature**: *string* -*Defined in [types.ts:166](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L166)* +*Defined in [types.ts:166](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L160)* +*Defined in [types.ts:160](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L160)* ___ -### s +## s • **s**: *string* -*Defined in [types.ts:161](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L161)* +*Defined in [types.ts:161](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L161)* ___ -### v +## v • **v**: *string* -*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L159)* +*Defined in [types.ts:159](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/subproviders/src/types.ts#L140)* +*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L140)* ___ -### networkId +## networkId • **networkId**: *number* -*Defined in [types.ts:142](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L142)* +*Defined in [types.ts:142](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L142)* ___ -### trezorConnectClientApi +## trezorConnectClientApi • **trezorConnectClientApi**: *any* -*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/subproviders/src/types.ts#L141)* +*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/subproviders/src/types.ts#L141)*
diff --git a/packages/web3-wrapper/docs/reference.mdx b/packages/web3-wrapper/docs/reference.mdx index 93da7491d4..85bbfb9071 100644 --- a/packages/web3-wrapper/docs/reference.mdx +++ b/packages/web3-wrapper/docs/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L145)* +*Defined in [web3_wrapper.ts:145](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L54)* +*Defined in [web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L53)* +*Defined in [web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L568)* +*Defined in [web3_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L643)* +*Defined in [web3_wrapper.ts:643](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L525)* +*Defined in [web3_wrapper.ts:525](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L273)* +*Defined in [web3_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L508)* +*Defined in [web3_wrapper.ts:508](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L421)* +*Defined in [web3_wrapper.ts:421](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L254)* +*Defined in [web3_wrapper.ts:254](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L361)* +*Defined in [web3_wrapper.ts:361](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L347)* +*Defined in [web3_wrapper.ts:347](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L409)* +*Defined in [web3_wrapper.ts:409](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L387)* +*Defined in [web3_wrapper.ts:387](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L286)* +*Defined in [web3_wrapper.ts:286](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L164)* +*Defined in [web3_wrapper.ts:164](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L475)* +*Defined in [web3_wrapper.ts:475](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L207)* +*Defined in [web3_wrapper.ts:207](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L690)* +*Defined in [web3_wrapper.ts:690](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L199)* +*Defined in [web3_wrapper.ts:199](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L171)* +*Defined in [web3_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L239)* +*Defined in [web3_wrapper.ts:239](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L217)* +*Defined in [web3_wrapper.ts:217](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L305)* +*Defined in [web3_wrapper.ts:305](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L458)* +*Defined in [web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L189)* +*Defined in [web3_wrapper.ts:189](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L450)* +*Defined in [web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L442)* +*Defined in [web3_wrapper.ts:442](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L671)* +*Defined in [web3_wrapper.ts:671](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L547)* +*Defined in [web3_wrapper.ts:547](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L662)* +*Defined in [web3_wrapper.ts:662](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L178)* +*Defined in [web3_wrapper.ts:178](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L319)* +*Defined in [web3_wrapper.ts:319](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L334)* +*Defined in [web3_wrapper.ts:334](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L433)* +*Defined in [web3_wrapper.ts:433](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L65)* +*Defined in [web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L91)* +*Defined in [web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L76)* +*Defined in [web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/web3_wrapper.ts#L107)* +*Defined in [web3_wrapper.ts:107](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L91)* +*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L91)* ___ -### Geth +## Geth • **Geth**: = "GETH" -*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L90)* +*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L2)* +*Defined in [types.ts:2](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L15)* ___ -### extraData +## extraData • **extraData**: *string* -*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L17)* ___ -### gasLimit +## gasLimit • **gasLimit**: *string* -*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L19)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* -*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L20)* ___ -### hash +## hash • **hash**: *string | null* -*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L7)* ___ -### logsBloom +## logsBloom • **logsBloom**: *string | null* -*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L11)* ___ -### miner +## miner • **miner**: *string* -*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L14)* ___ -### nonce +## nonce • **nonce**: *string | null* -*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L9)* ___ -### number +## number • **number**: *string | null* -*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L6)* ___ -### parentHash +## parentHash • **parentHash**: *string* -*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L8)* ___ -### sha3Uncles +## sha3Uncles • **sha3Uncles**: *string* -*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L10)* ___ -### size +## size • **size**: *string* -*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L18)* ___ -### stateRoot +## stateRoot • **stateRoot**: *string* -*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L13)* ___ -### timestamp +## timestamp • **timestamp**: *string* -*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L21)* ___ -### totalDifficulty +## totalDifficulty • **totalDifficulty**: *string* -*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L16)* ___ -### transactionsRoot +## transactionsRoot • **transactionsRoot**: *string* -*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L12)* ___ -### uncles +## uncles • **uncles**: *string[]* -*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L16)* ___ -### transactions +## transactions • **transactions**: *string[]* -*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L25)* +*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [types.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [types.ts:16](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L28)* +*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [types.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L85)* +*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L73)*
-> # Interface: CallTxDataBaseRPC +# Interface: CallTxDataBaseRPC -## Hierarchy +### Hierarchy * **CallTxDataBaseRPC** @@ -1527,463 +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/b834b7060/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L64)* +*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L64)* ___ -### blockHash +## blockHash • **blockHash**: *string | null* -*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L62)* +*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L62)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L63)* +*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L63)* ___ -### data +## data • **data**: *string* -*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L65)* +*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L65)* ___ -### logIndex +## logIndex • **logIndex**: *string | null* -*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L59)* +*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L59)* ___ -### topics +## topics • **topics**: *string[]* -*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L66)* +*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L66)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L61)* +*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L61)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L60)* +*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L45)* +*Defined in [types.ts:45](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L45)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string* -*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L46)* +*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L46)* ___ -### contractAddress +## contractAddress • **contractAddress**: *string | null* -*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L54)* +*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L54)* ___ -### cumulativeGasUsed +## cumulativeGasUsed • **cumulativeGasUsed**: *string* -*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L52)* +*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L52)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L49)* +*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L49)* ___ -### gasUsed +## gasUsed • **gasUsed**: *string* -*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L53)* +*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L55)* +*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L55)* ___ -### status +## status • **status**: *[TransactionReceiptStatusRPC](#transactionreceiptstatusrpc)* -*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L51)* +*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L51)* ___ -### to +## to • **to**: *string* -*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L50)* +*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L50)* ___ -### transactionHash +## transactionHash • **transactionHash**: *string* -*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L47)* +*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L47)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string* -*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L48)* +*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L33)* +*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L33)* ___ -### blockNumber +## blockNumber • **blockNumber**: *string | null* -*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L34)* +*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L34)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L36)* +*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L36)* ___ -### gas +## gas • **gas**: *string* -*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L40)* +*Defined in [types.ts:40](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L40)* ___ -### gasPrice +## gasPrice • **gasPrice**: *string* -*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L39)* +*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L39)* ___ -### hash +## hash • **hash**: *string* -*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L31)* +*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L31)* ___ -### input +## input • **input**: *string* -*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L41)* +*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L41)* ___ -### nonce +## nonce • **nonce**: *string* -*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L32)* +*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L32)* ___ -### to +## to • **to**: *string | null* -*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L37)* +*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L37)* ___ -### transactionIndex +## transactionIndex • **transactionIndex**: *string | null* -*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L35)* +*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L35)* ___ -### value +## value • **value**: *string* -*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L38)* +*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L76)* ___ -### from +## from • **from**: *string* -*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/b834b7060/packages/web3-wrapper/src/types.ts#L81)* +*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [types.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/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/b834b7060/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/web3-wrapper/src/types.ts#L73)*