diff --git a/packages/contract-wrappers/docs/reference.mdx b/packages/contract-wrappers/docs/reference.mdx index f8c14220ac..9b02ea5121 100644 --- a/packages/contract-wrappers/docs/reference.mdx +++ b/packages/contract-wrappers/docs/reference.mdx @@ -1,17 +1,154 @@ +# Class: ContractWrappers - -# Class: CoordinatorRegistryContract +The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. ## Constructors -\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:53](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L53)* + +Instantiates a new ContractWrappers instance. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. | +`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. | + +**Returns:** *[ContractWrappers](#class-contractwrappers)* + +An instance of the ContractWrappers class. + +## Properties + +### contractAddresses + +• **contractAddresses**: *`ContractAddresses`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:26](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L26)* + +An index of the default contract addresses for this chain. + +___ + +### coordinator + +• **coordinator**: *[CoordinatorContract](#class-coordinatorcontract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L47)* + +An instance of the CoordinatorContract class containing methods for interacting with the Coordinator extension contract. + +___ + +### devUtils + +• **devUtils**: *[DevUtilsContract](#class-devutilscontract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L43)* + +An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. + +___ + +### exchange + +• **exchange**: *[ExchangeContract](#class-exchangecontract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L30)* + +An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. + +___ + +### forwarder + +• **forwarder**: *[ForwarderContract](#class-forwardercontract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:39](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L39)* + +An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. + +___ + +### staking + +• **staking**: *[StakingContract](#class-stakingcontract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:51](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L51)* + +An instance of the StakingContract class containing methods for interacting with the Staking contracts. + +___ + +### weth9 + +• **weth9**: *[WETH9Contract](#class-weth9contract)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:35](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L35)* + +An instance of the WETH9Contract class containing methods for interacting with the +WETH9 smart contract. + +## Methods + +### getAbiDecoder + +▸ **getAbiDecoder**(): *`AbiDecoder`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:110](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L110)* + +Get the abi decoder instance currently used by contract-wrappers + +**Returns:** *`AbiDecoder`* + +AbiDecoder instance + +___ + +### getProvider + +▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:103](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L103)* + +Get the provider instance currently used by contract-wrappers + +**Returns:** *[SupportedProvider](#supportedprovider)* + +Web3 provider instance + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/contract_wrappers.ts#L95)* + +Unsubscribes from all subscriptions for all contracts. + +**Returns:** *void* + +
+ +# Class: CoordinatorContract + + +## Constructors + + + +\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L465)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:962](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L962)* **Parameters:** @@ -21,9 +158,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode | +`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode | -**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* ## Properties @@ -33,7 +170,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -43,7 +180,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -53,7 +190,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -63,7 +200,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -73,15 +210,137 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "Coordinator" + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L46)* ## Methods +### EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH + +▸ **EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:580](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L580)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### EIP712_COORDINATOR_DOMAIN_HASH + +▸ **EIP712_COORDINATOR_DOMAIN_HASH**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:600](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L600)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### EIP712_COORDINATOR_DOMAIN_NAME + +▸ **EIP712_COORDINATOR_DOMAIN_NAME**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:620](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L620)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### EIP712_COORDINATOR_DOMAIN_VERSION + +▸ **EIP712_COORDINATOR_DOMAIN_VERSION**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:640](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L640)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### EIP712_EXCHANGE_DOMAIN_HASH + +▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:660](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L660)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### assertValidCoordinatorApprovals + +▸ **assertValidCoordinatorApprovals**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:692](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L692)* + +Validates that the 0x transaction has been approved by all of the feeRecipients +that correspond to each order in the transaction's Exchange calldata. + +**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. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | + +**Returns:** *`ContractFunctionObj`* + +___ + +### decodeOrdersFromFillData + +▸ **decodeOrdersFromFillData**(`data`: string): *`ContractFunctionObj>`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:738](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L738)* + +Decodes the orders from Exchange calldata representing any fill method. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`data` | string | Exchange calldata representing a fill method. | + +**Returns:** *`ContractFunctionObj>`* + +orders The orders from the Exchange calldata. + +___ + +### executeTransaction + +▸ **executeTransaction**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:832](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L832)* + +Executes a 0x transaction that has been signed by the feeRecipients that correspond to +each order in the transaction's Exchange calldata. + +**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. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### getABIDecodedReturnData ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L208)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:565](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L565)* **Type parameters:** @@ -102,7 +361,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:201](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L201)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:557](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L557)* **Type parameters:** @@ -119,23 +378,24 @@ Name | Type | ___ -### getCoordinatorEndpoint +### getCoordinatorApprovalHash -▸ **getCoordinatorEndpoint**(`coordinatorOperator`: string): *`ContractFunctionObj`* +▸ **getCoordinatorApprovalHash**(`approval`: object): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L227)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:905](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L905)* -Gets the endpoint for a Coordinator. +Calculates the EIP712 hash of the Coordinator approval mesasage using the domain +separator of this contract. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`coordinatorOperator` | string | Operator of the Coordinator endpoint. | +`approval` | object | Coordinator approval message containing the transaction hash, and transaction signature. | **Returns:** *`ContractFunctionObj`* -coordinatorEndpoint Endpoint of the Coordinator as a string. +approvalHash EIP712 hash of the Coordinator approval message with the domain separator of this contract. ___ @@ -143,7 +403,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:195](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L195)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:550](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L550)* **Parameters:** @@ -155,37 +415,11 @@ Name | Type | ___ -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L449)* - -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 - -___ - ### getSelector ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L215)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:573](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L573)* **Parameters:** @@ -197,79 +431,24 @@ Name | Type | ___ -### setCoordinatorEndpoint +### getSignerAddress -▸ **setCoordinatorEndpoint**(`coordinatorEndpoint`: string): *`ContractTxFunctionObj`* +▸ **getSignerAddress**(`hash`: string, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:283](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L283)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:936](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L936)* -Called by a Coordinator operator to set the endpoint of their Coordinator. +Recovers the address of a signer given a hash and signature. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`coordinatorEndpoint` | string | Endpoint of the Coordinator as a string. | +`hash` | string | Any 32 byte hash. | +`signature` | string | Proof that the hash has been signed by signer. | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L407)* - -Subscribe to an event type emitted by the CoordinatorRegistry contract. - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* - -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. | -`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` | -`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed | -`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) | -`blockPollingIntervalMs?` | undefined \| number | - | - | - -**Returns:** *string* - -Subscription token used later to unsubscribe - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L432)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L438)* - -Cancels all existing subscriptions - -**Returns:** *void* +signerAddress Address of the signer. ___ @@ -277,7 +456,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L131)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:177](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L177)* **Returns:** *[ContractAbi](#contractabi)* @@ -287,9 +466,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L89)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:127](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L127)* **Parameters:** @@ -300,16 +479,18 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`exchange` | string | +`chainId` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L58)* +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:48](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L48)* **Parameters:** @@ -319,8 +500,32 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`exchange` | string | +`chainId` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/coordinator.ts:84](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L84)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`exchange` | string | +`chainId` | `BigNumber` | + +**Returns:** *`Promise`* ___ @@ -330,7 +535,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -354,7 +559,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3929](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3929)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3257](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3257)* **Parameters:** @@ -376,7 +581,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -386,7 +591,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -396,7 +601,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -406,7 +611,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -416,47 +621,35 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 - -## Methods - -### decodeAssetProxyDispatchError - -▸ **decodeAssetProxyDispatchError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1516](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1516)* - -Decompose an ABI-encoded AssetProxyDispatchError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, string, string]>`* - -errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. +Defined in base-contract/lib/src/index.d.ts:32 ___ -### decodeAssetProxyExistsError +### `Static` contractName -▸ **decodeAssetProxyExistsError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* +▪ **contractName**: *string* = "DevUtils" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L46)* -Decompose an ABI-encoded AssetProxyExistsError. +## Methods -**Parameters:** +### EIP712_EXCHANGE_DOMAIN_HASH -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | +▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* -**Returns:** *`ContractFunctionObj<[string, string]>`* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1597](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1597)* -assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. +**Returns:** *`ContractFunctionObj`* + +___ + +### chaiBridgeAddress + +▸ **chaiBridgeAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1617](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1617)* + +**Returns:** *`ContractFunctionObj`* ___ @@ -464,7 +657,7 @@ ___ ▸ **decodeAssetProxyId**(`assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1643](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1643)* Decode AssetProxy identifier @@ -480,51 +673,11 @@ The AssetProxy identifier ___ -### decodeAssetProxyTransferError - -▸ **decodeAssetProxyTransferError**(`encoded`: string): *`ContractFunctionObj<[string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1653)* - -Decompose an ABI-encoded AssetProxyTransferError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string, string]>`* - -orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. - -___ - -### decodeEIP1271SignatureError - -▸ **decodeEIP1271SignatureError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)* - -Decompose an ABI-encoded SignatureValidatorError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* - -signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. - -___ - ### decodeERC1155AssetData ▸ **decodeERC1155AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1750)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1675](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1675)* Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. @@ -544,7 +697,7 @@ ___ ▸ **decodeERC20AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1713](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1713)* Decode ERC-20 asset data from the format described in the AssetProxy contract specification. @@ -556,7 +709,27 @@ Name | Type | Description | **Returns:** *`ContractFunctionObj<[string, string]>`* -The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. +The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. + +___ + +### decodeERC20BridgeAssetData + +▸ **decodeERC20BridgeAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1745](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1745)* + +Decode ERC20Bridge asset data from the format described in the AssetProxy contract specification. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC20Bridge asset | + +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* + +The ERC20BridgeProxy identifier, the address of the ERC20 token to transfer, the address of the bridge contract, and extra data to be passed to the bridge contract. ___ @@ -564,7 +737,7 @@ ___ ▸ **decodeERC721AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1848)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1780](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1780)* Decode ERC-721 asset data from the format described in the AssetProxy contract specification. @@ -580,71 +753,11 @@ The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting t ___ -### decodeExchangeInvalidContextError - -▸ **decodeExchangeInvalidContextError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)* - -Decompose an ABI-encoded OrderStatusError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, string, string]>`* - -errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address - -___ - -### decodeFillError - -▸ **decodeFillError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1945](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)* - -Decompose an ABI-encoded FillError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, string]>`* - -errorCode The error code.orderHash The order hash. - -___ - -### decodeIncompleteFillError - -▸ **decodeIncompleteFillError**(`encoded`: string): *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1988](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1988)* - -Decompose an ABI-encoded IncompleteFillError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* - -orderHash Hash of the order being filled. - -___ - ### decodeMultiAssetData ▸ **decodeMultiAssetData**(`assetData`: string): *`ContractFunctionObj<[string, BigNumber[], string[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2036](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2036)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1814](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1814)* Decode multi-asset data from the format described in the AssetProxy contract specification. @@ -660,131 +773,11 @@ The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to ___ -### decodeNegativeSpreadError - -▸ **decodeNegativeSpreadError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2084](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2084)* - -Decompose an ABI-encoded NegativeSpreadError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string]>`* - -leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. - -___ - -### decodeOrderEpochError - -▸ **decodeOrderEpochError**(`encoded`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2129)* - -Decompose an ABI-encoded OrderEpochError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`* - -makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. - -___ - -### decodeOrderStatusError - -▸ **decodeOrderStatusError**(`encoded`: string): *`ContractFunctionObj<[string, number]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2177)* - -Decompose an ABI-encoded OrderStatusError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, number]>`* - -orderHash The order hash.orderStatus The order status. - -___ - -### decodeSignatureError - -▸ **decodeSignatureError**(`encoded`: string): *`ContractFunctionObj<[number, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)* - -Decompose an ABI-encoded SignatureError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, string, string, string]>`* - -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. - -___ - -### decodeSignatureValidatorNotApprovedError - -▸ **decodeSignatureValidatorNotApprovedError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2268)* - -Decompose an ABI-encoded SignatureValidatorNotApprovedError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string]>`* - -signerAddress The expected signer of the hash.validatorAddress The expected validator. - -___ - -### decodeSignatureWalletError - -▸ **decodeSignatureWalletError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)* - -Decompose an ABI-encoded SignatureWalletError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* - -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. - -___ - ### decodeStaticCallAssetData ▸ **decodeStaticCallAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1849](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1849)* Decode StaticCall asset data from the format described in the AssetProxy contract specification. @@ -800,51 +793,11 @@ The StaticCall AssetProxy identifier, the target address of the StaticCAll, the ___ -### decodeTransactionError - -▸ **decodeTransactionError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)* - -Decompose an ABI-encoded TransactionError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[number, string]>`* - -errorCode The error code.transactionHash Hash of the transaction. - -___ - -### decodeTransactionExecutionError - -▸ **decodeTransactionExecutionError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)* - -Decompose an ABI-encoded TransactionExecutionError. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`encoded` | string | ABI-encoded revert error. | - -**Returns:** *`ContractFunctionObj<[string, string]>`* - -transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). - -___ - ### decodeZeroExTransactionData ▸ **decodeZeroExTransactionData**(`transactionData`: string): *`ContractFunctionObj<[string, Array, BigNumber[], string[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2505](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2505)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1884](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1884)* Decodes the call data for an Exchange contract method call. @@ -860,11 +813,21 @@ The name of the function called, and the parameters it was given. For singl ___ +### dydxBridgeAddress + +▸ **dydxBridgeAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1981](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1981)* + +**Returns:** *`ContractFunctionObj`* + +___ + ### encodeERC1155AssetData ▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2628)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2011](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2011)* Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. @@ -887,7 +850,7 @@ ___ ▸ **encodeERC20AssetData**(`tokenAddress`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2686)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2056](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2056)* Encode ERC-20 asset data into the format described in the AssetProxy contract specification. @@ -907,7 +870,7 @@ ___ ▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2735)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2089](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2089)* Encode ERC-721 asset data into the format described in the AssetProxy specification. @@ -928,7 +891,7 @@ ___ ▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2787](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2787)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2123](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2123)* Encode data for multiple assets, per the AssetProxy contract specification. @@ -949,7 +912,7 @@ ___ ▸ **encodeStaticCallAssetData**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2841](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2841)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2159](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2159)* Encode StaticCall asset data into the format described in the AssetProxy contract specification. @@ -967,11 +930,51 @@ AssetProxy-compliant asset data describing the set of assets. ___ +### erc1155ProxyAddress + +▸ **erc1155ProxyAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2195](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2195)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### erc20ProxyAddress + +▸ **erc20ProxyAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2215](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2215)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### erc721ProxyAddress + +▸ **erc721ProxyAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2235](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2235)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### exchangeAddress + +▸ **exchangeAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2255](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2255)* + +**Returns:** *`ContractFunctionObj`* + +___ + ### getABIDecodedReturnData ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1497](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1497)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1582](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1582)* **Type parameters:** @@ -992,7 +995,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1490)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1574](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1574)* **Type parameters:** @@ -1011,9 +1014,9 @@ ___ ### getAssetProxyAllowance -▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* +▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2899)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2282](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2282)* Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts. @@ -1024,7 +1027,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractTxFunctionObj`* Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. @@ -1032,9 +1035,9 @@ ___ ### getBalance -▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* +▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2961](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2961)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2337](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2337)* Returns the owner's balance of the assets(s) specified in assetData. When the asset data contains multiple assets (eg in ERC1155 or Multi-Asset), the return value indicates how many complete "baskets" of those assets are owned by owner. @@ -1045,7 +1048,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractTxFunctionObj`* Number of assets (or asset baskets) held by owner. @@ -1053,9 +1056,9 @@ ___ ### getBalanceAndAssetProxyAllowance -▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`* +▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3023](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3023)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2392)* Calls getBalance() and getAllowance() for assetData. @@ -1066,7 +1069,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`* +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. @@ -1074,9 +1077,9 @@ ___ ### getBatchAssetProxyAllowances -▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* +▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3091](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3091)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2453](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2453)* Calls getAssetProxyAllowance() for each element of assetData. @@ -1087,7 +1090,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractTxFunctionObj`* An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. @@ -1095,9 +1098,9 @@ ___ ### getBatchBalances -▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* +▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3153)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2508](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2508)* Calls getBalance() for each element of assetData. @@ -1108,7 +1111,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractTxFunctionObj`* Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. @@ -1116,9 +1119,9 @@ ___ ### getBatchBalancesAndAssetProxyAllowances -▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* +▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj<[BigNumber[], BigNumber[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3215)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2563](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2563)* Calls getBatchBalances() and getBatchAllowances() for each element of assetData. @@ -1129,7 +1132,7 @@ Name | Type | Description | `ownerAddress` | string | Owner of the assets specified by assetData. | `assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* +**Returns:** *`ContractTxFunctionObj<[BigNumber[], BigNumber[]]>`* An array of asset balances from getBalance(), and an array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. @@ -1139,7 +1142,7 @@ ___ ▸ **getEthBalances**(`addresses`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3281](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3281)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2622](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2622)* Batch fetches ETH balances @@ -1159,7 +1162,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1484)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1567](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1567)* **Parameters:** @@ -1171,11 +1174,29 @@ Name | Type | ___ +### getOrderHash + +▸ **getOrderHash**(`order`: object, `chainId`: `BigNumber`, `exchange`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2643](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2643)* + +**Parameters:** + +Name | Type | +------ | ------ | +`order` | object | +`chainId` | `BigNumber` | +`exchange` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + ### getOrderRelevantState -▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractFunctionObj<[object, BigNumber, boolean]>`* +▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractTxFunctionObj<[object, BigNumber, boolean]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3337)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2699](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2699)* Fetches all order-relevant information needed to validate if the supplied order is fillable. @@ -1186,7 +1207,7 @@ Name | Type | Description | `order` | object | The order structure. | `signature` | string | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. | -**Returns:** *`ContractFunctionObj<[object, BigNumber, boolean]>`* +**Returns:** *`ContractTxFunctionObj<[object, BigNumber, boolean]>`* The orderInfo (hash, status, and `takerAssetAmount` already filled for the given order), fillableTakerAssetAmount (amount of the order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, `fillableTakerAssetAmount` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. @@ -1194,9 +1215,9 @@ ___ ### getOrderRelevantStates -▸ **getOrderRelevantStates**(`orders`: `Array`, `signatures`: string[]): *`ContractFunctionObj<[Array, BigNumber[], boolean[]]>`* +▸ **getOrderRelevantStates**(`orders`: `Array`, `signatures`: string[]): *`ContractTxFunctionObj<[Array, BigNumber[], boolean[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3433)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2787](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2787)* Fetches all order-relevant information needed to validate if the supplied orders are fillable. @@ -1207,7 +1228,7 @@ Name | Type | Description | `orders` | `Array` | Array of order structures. | `signatures` | string[] | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. | -**Returns:** *`ContractFunctionObj<[Array, BigNumber[], boolean[]]>`* +**Returns:** *`ContractTxFunctionObj<[Array, BigNumber[], boolean[]]>`* The ordersInfo (array of the hash, status, and `takerAssetAmount` already filled for each order), fillableTakerAssetAmounts (array of amounts for each order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, each element of `fillableTakerAssetAmounts` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. @@ -1217,7 +1238,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1504](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1504)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:1590](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1590)* **Parameters:** @@ -1229,11 +1250,33 @@ Name | Type | ___ +### getSimulatedOrderMakerTransferResults + +▸ **getSimulatedOrderMakerTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2883](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2883)* + +Simulates the maker transfers within an order and returns the index of the first failed transfer. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order to simulate transfers for. | +`takerAddress` | string | The address of the taker that will fill the order. | +`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | + +**Returns:** *`ContractTxFunctionObj`* + +The index of the first failed transfer (or 4 if all transfers are successful). + +___ + ### getSimulatedOrderTransferResults ▸ **getSimulatedOrderTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3537](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3537)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:2964](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L2964)* Simulates all of the transfers within an order and returns the index of the first failed transfer. @@ -1255,7 +1298,7 @@ ___ ▸ **getSimulatedOrdersTransferResults**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3687)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3046](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3046)* Simulates all of the transfers for each given order and returns the indices of each first failed transfer. @@ -1273,13 +1316,31 @@ The indices of the first failed transfer (or 4 if all transfers are successful) ___ +### getTransactionHash + +▸ **getTransactionHash**(`transaction`: object, `chainId`: `BigNumber`, `exchange`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3115](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3115)* + +**Parameters:** + +Name | Type | +------ | ------ | +`transaction` | object | +`chainId` | `BigNumber` | +`exchange` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + ### getTransferableAssetAmount -▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* +▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3835)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3160](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3160)* -Gets the amount of an asset transferable by the owner. +Gets the amount of an asset transferable by the maker of an order. **Parameters:** @@ -1288,7 +1349,7 @@ Name | Type | Description | `ownerAddress` | string | Address of the owner of the asset. | `assetData` | string | Description of tokens, per the AssetProxy contract specification. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractTxFunctionObj`* The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. @@ -1298,23 +1359,35 @@ ___ ▸ **revertIfInvalidAssetData**(`assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3890)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3212](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3212)* + +Reverts if assetData is not of a valid format for its given proxy id. **Parameters:** -Name | Type | ------- | ------ | -`assetData` | string | +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy compliant asset data. | **Returns:** *`ContractFunctionObj`* ___ +### staticCallProxyAddress + +▸ **staticCallProxyAddress**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:3238](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L3238)* + +**Returns:** *`ContractFunctionObj`* + +___ + ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L125)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:182](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L182)* **Returns:** *[ContractAbi](#contractabi)* @@ -1324,9 +1397,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L78)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:131](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L131)* **Parameters:** @@ -1337,7 +1410,9 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_exchange` | string | +`exchange_` | string | +`chaiBridge_` | string | +`dydxBridge_` | string | **Returns:** *`Promise`* @@ -1345,9 +1420,9 @@ ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:48](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L48)* **Parameters:** @@ -1357,7 +1432,32 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_exchange` | string | +`exchange_` | string | +`chaiBridge_` | string | +`dydxBridge_` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/dev_utils.ts:86](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L86)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`exchange_` | string | +`chaiBridge_` | string | +`dydxBridge_` | string | **Returns:** *`Promise`* @@ -1369,7 +1469,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -1382,18 +1482,18 @@ Name | Type |
-# Class: DummyERC20TokenContract +# Class: ERC20BridgeSamplerContract ## Constructors -\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* +\+ **new ERC20BridgeSamplerContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20BridgeSamplerContract](#class-erc20bridgesamplercontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1690)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1610](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1610)* **Parameters:** @@ -1403,9 +1503,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode | +`deployedBytecode` | string \| undefined | ERC20BridgeSamplerContract.deployedBytecode | -**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* +**Returns:** *[ERC20BridgeSamplerContract](#class-erc20bridgesamplercontract)* ## Properties @@ -1415,7 +1515,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -1425,7 +1525,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -1435,7 +1535,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -1445,7 +1545,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -1455,85 +1555,35 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "ERC20BridgeSampler" + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L45)* ## Methods -### MAX_MINT_AMOUNT +### batchCall -▸ **MAX_MINT_AMOUNT**(): *`ContractFunctionObj`* +▸ **batchCall**(`callDatas`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L503)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:890](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L890)* -**Returns:** *`ContractFunctionObj`* - -___ - -### allowance - -▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L550)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_owner` | string | -`_spender` | string | - -**Returns:** *`ContractFunctionObj`* - -___ - -### approve - -▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L611)* - -`msg.sender` approves `_spender` to spend `_value` tokens +Call multiple public functions on this contract in a single transaction. **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 | +`callDatas` | string[] | ABI-encoded call data for each function call. | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* -Always true if the call has enough gas to complete execution - -___ - -### balanceOf - -▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L735)* - -Query the balance of owner - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | The address from which the balance will be retrieved | - -**Returns:** *`ContractFunctionObj`* - -Balance of owner - -___ - -### decimals - -▸ **decimals**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L785)* - -**Returns:** *`ContractFunctionObj`* +callResults ABI-encoded results data for each call. ___ @@ -1541,7 +1591,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:489](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L489)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:870](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L870)* **Type parameters:** @@ -1562,7 +1612,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L482)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:862](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L862)* **Type parameters:** @@ -1583,7 +1633,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L476)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:855](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L855)* **Parameters:** @@ -1595,29 +1645,74 @@ Name | Type | ___ -### getLogsAsync +### getLiquidityProviderFromRegistry -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +▸ **getLiquidityProviderFromRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1674](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1674)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:919](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L919)* -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* +Returns the address of a liquidity provider for the given market +(takerToken, makerToken), from a registry of liquidity providers. +Returns address(0) if no such provider exists in the registry. **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}` | +`registryAddress` | string | - | +`takerToken` | string | Taker asset managed by liquidity provider. | +`makerToken` | string | Maker asset managed by liquidity provider. | -**Returns:** *`Promise>>`* +**Returns:** *`ContractFunctionObj`* -Array of logs that match the parameters +providerAddress Address of the liquidity provider. + +___ + +### getOrderFillableMakerAssetAmounts + +▸ **getOrderFillableMakerAssetAmounts**(`orders`: `Array`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:958](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L958)* + +Queries the fillable taker asset amounts of native orders. +Effectively ignores orders that have empty signatures or + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Native orders to query. | +`orderSignatures` | string[] | Signatures for each respective order in `orders`. | +`devUtilsAddress` | string | Address to the DevUtils contract. | + +**Returns:** *`ContractFunctionObj`* + +orderFillableMakerAssetAmounts How much maker asset can be filled by each order in `orders`. + +___ + +### getOrderFillableTakerAssetAmounts + +▸ **getOrderFillableTakerAssetAmounts**(`orders`: `Array`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1014](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1014)* + +Queries the fillable taker asset amounts of native orders. +Effectively ignores orders that have empty signatures or +maker/taker asset amounts (returning 0). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Native orders to query. | +`orderSignatures` | string[] | Signatures for each respective order in `orders`. | +`devUtilsAddress` | string | Address to the DevUtils contract. | + +**Returns:** *`ContractFunctionObj`* + +orderFillableTakerAssetAmounts How much taker asset can be filled by each order in `orders`. ___ @@ -1625,7 +1720,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:496](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L496)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:878](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L878)* **Parameters:** @@ -1637,201 +1732,319 @@ Name | Type | ___ -### mint +### sampleBuysFromCurve -▸ **mint**(`_value`: `BigNumber`): *`ContractTxFunctionObj`* +▸ **sampleBuysFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L836)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1069](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1069)* -Mints new tokens for sender +Sample buy quotes from Curve. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | +`curveAddress` | string | Address of the Curve contract. | +`fromTokenIdx` | `BigNumber` | Index of the taker token (what to sell). | +`toTokenIdx` | `BigNumber` | Index of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. ___ -### name +### sampleBuysFromEth2Dai -▸ **name**(): *`ContractFunctionObj`* +▸ **sampleBuysFromEth2Dai**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:942](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L942)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1109](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1109)* -**Returns:** *`ContractFunctionObj`* - -___ - -### owner - -▸ **owner**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:989](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L989)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### setBalance - -▸ **setBalance**(`_target`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1041](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1041)* - -Sets the balance of target address +Sample buy quotes from Eth2Dai/Oasis. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_target` | string | Address or which balance will be updated | -`_value` | `BigNumber` | New balance of target address | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | - | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. ___ -### subscribe +### sampleBuysFromKyberNetwork -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +▸ **sampleBuysFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1632](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1632)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1148](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1148)* -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 - -___ - -### symbol - -▸ **symbol**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1160)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### totalSupply - -▸ **totalSupply**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1211](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1211)* - -Query total supply of token - -**Returns:** *`ContractFunctionObj`* - -Total supply of token - -___ - -### transfer - -▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1264](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1264)* - -send `value` token to `to` from `msg.sender` +Sample buy quotes from Kyber. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | +`opts` | object | `FakeBuyOptions` specifying target slippage and max iterations. | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* -True if transfer was successful +takerTokenAmounts Taker amounts sold at each maker token amount. ___ -### transferFrom +### sampleBuysFromLiquidityProviderRegistry -▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* +▸ **sampleBuysFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1390)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1191](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1191)* -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 +Sample buy quotes from an arbitrary on-chain liquidity provider. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | +`registryAddress` | string | Address of the liquidity provider registry contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | +`opts` | object | `FakeBuyOptions` specifying target slippage and max iterations. | -**Returns:** *`ContractTxFunctionObj`* +**Returns:** *`ContractFunctionObj`* -Success of transfer. +takerTokenAmounts Taker amounts sold at each maker token amount. ___ -### transferOwnership +### sampleBuysFromUniswap -▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* +▸ **sampleBuysFromUniswap**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1514)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1236](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1236)* -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1657)* - -Cancel a subscription +Sample buy quotes from Uniswap. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token sell amount for each sample. | -**Returns:** *void* +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. ___ -### unsubscribeAll +### sampleBuysFromUniswapV2 -▸ **unsubscribeAll**(): *void* +▸ **sampleBuysFromUniswapV2**(`path`: string[], `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1663](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1663)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1273](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1273)* -Cancels all existing subscriptions +Sample buy quotes from UniswapV2. -**Returns:** *void* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`path` | string[] | Token route. Should be takerToken -> makerToken. | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleSellsFromCurve + +▸ **sampleSellsFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1303](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1303)* + +Sample sell quotes from Curve. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`curveAddress` | string | Address of the Curve contract. | +`fromTokenIdx` | `BigNumber` | Index of the taker token (what to sell). | +`toTokenIdx` | `BigNumber` | Index of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromEth2Dai + +▸ **sampleSellsFromEth2Dai**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1344](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1344)* + +Sample sell quotes from Eth2Dai/Oasis. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromEth2DaiHop + +▸ **sampleSellsFromEth2DaiHop**(`takerToken`: string, `makerToken`: string, `intermediateToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1384](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1384)* + +Sample sell quotes from Eth2Dai/Oasis using a hop to an intermediate token. +I.e WBTC/DAI via ETH or WBTC/ETH via DAI + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`intermediateToken` | string | Address of the token to hop to. | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromKyberNetwork + +▸ **sampleSellsFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1425](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1425)* + +Sample sell quotes from Kyber. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromLiquidityProviderRegistry + +▸ **sampleSellsFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1464](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1464)* + +Sample sell quotes from an arbitrary on-chain liquidity provider. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`registryAddress` | string | Address of the liquidity provider registry contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromMultiBridge + +▸ **sampleSellsFromMultiBridge**(`multibridge`: string, `takerToken`: string, `intermediateToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1508](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1508)* + +Sample sell quotes from MultiBridge. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`multibridge` | string | Address of the MultiBridge contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`intermediateToken` | string | The address of the intermediate token to use in an indirect route. | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromUniswap + +▸ **sampleSellsFromUniswap**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1552](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1552)* + +Sample sell quotes from Uniswap. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromUniswapV2 + +▸ **sampleSellsFromUniswapV2**(`path`: string[], `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:1589](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L1589)* + +Sample sell quotes from UniswapV2. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`path` | string[] | Token route. Should be takerToken -> makerToken | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. ___ @@ -1839,7 +2052,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L155)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:162](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L162)* **Returns:** *[ContractAbi](#contractabi)* @@ -1849,9 +2062,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L105)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:118](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L118)* **Parameters:** @@ -1862,20 +2075,16 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L66)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L47)* **Parameters:** @@ -1885,12 +2094,28 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts:79](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_bridge_sampler.ts#L79)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* ___ @@ -1900,593 +2125,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -
- -# Class: DummyERC721TokenContract - - -## Constructors - - - -\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1990](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1990)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode | - -**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* - -## Properties - -### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:32 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -## Methods - -### approve - -▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L562)* - -The zero address indicates there is no approved address. -Throws unless `msg.sender` is the current NFT owner, or an authorized -operator of the current owner. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### balanceOf - -▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L687)* - -NFTs assigned to the zero address are considered invalid, and this -function throws for queries about the zero address. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_owner` | string | An address for whom to query the balance | - -**Returns:** *`ContractFunctionObj`* - -The number of NFTs owned by `_owner`, possibly zero - -___ - -### burn - -▸ **burn**(`_owner`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L743)* - -Function to burn a token -Reverts if the given token ID doesn't exist or not called by contract owner - -**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:** *`ContractTxFunctionObj`* - -___ - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L541)* - -**Type parameters:** - -▪ **T** - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | -`callData` | string | - -**Returns:** *`T`* - -___ - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L534)* - -**Type parameters:** - -▪ **T** - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | -`callData` | string | - -**Returns:** *`T`* - -___ - -### getApproved - -▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L867)* - -Throws if `_tokenId` is not a valid NFT. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_tokenId` | `BigNumber` | The NFT to find the approved address for | - -**Returns:** *`ContractFunctionObj`* - -The approved address for this NFT, or the zero address if there is none - -___ - -### getFunctionSignature - -▸ **getFunctionSignature**(`methodName`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L528)* - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | - -**Returns:** *string* - -___ - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1974](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1974)* - -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 - -___ - -### getSelector - -▸ **getSelector**(`methodName`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:548](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L548)* - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | - -**Returns:** *string* - -___ - -### isApprovedForAll - -▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:915](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L915)* - -**Parameters:** - -Name | Type | ------- | ------ | -`_owner` | string | -`_operator` | string | - -**Returns:** *`ContractFunctionObj`* - -___ - -### mint - -▸ **mint**(`_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L976)* - -Function to mint a new token -Reverts if the given token ID already exists - -**Parameters:** - -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:** *`ContractTxFunctionObj`* - -___ - -### name - -▸ **name**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1086](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1086)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### owner - -▸ **owner**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1133)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### ownerOf - -▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1186)* - -NFTs assigned to zero address are considered invalid, and queries -about them do throw. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_tokenId` | `BigNumber` | The identifier for an NFT | - -**Returns:** *`ContractFunctionObj`* - -The address of the owner of the NFT - -___ - -### safeTransferFrom1 - -▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1241)* - -This works identically to the other function with an extra data parameter, -except this function just sets data to "". - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### safeTransferFrom2 - -▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1377](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1377)* - -Throws unless `msg.sender` is the current owner, an authorized -operator, or the approved address for this NFT. Throws if `_from` is -not the current owner. Throws if `_to` is the zero address. Throws if -`_tokenId` is not a valid NFT. When transfer is complete, this function -checks if `_to` is a smart contract (code size > 0). If so, it calls -`onERC721Received` on `_to` and throws if the return value is not -`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. - -**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:** *`ContractTxFunctionObj`* - -___ - -### setApprovalForAll - -▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1515](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1515)* - -Emits the ApprovalForAll event. The contract MUST allow -multiple operators per owner. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_operator` | string | Address to add to the set of authorized operators | -`_approved` | boolean | True if the operator is approved, false to revoke approval | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1932](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1932)* - -Subscribe to an event type emitted by the 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 - -___ - -### symbol - -▸ **symbol**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1634)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### transferFrom - -▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1690)* - -Throws unless `msg.sender` is the current owner, an authorized -operator, or the approved address for this NFT. Throws if `_from` is -not the current owner. Throws if `_to` is the zero address. Throws if -`_tokenId` is not a valid NFT. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### transferOwnership - -▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)* - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### unsubscribe - -▸ **unsubscribe**(`subscriptionToken`: string): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1957](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1957)* - -Cancel a subscription - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1963)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L159)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L111)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L76)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -2510,7 +2149,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:951](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L951)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:735](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L735)* **Parameters:** @@ -2532,7 +2171,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -2542,7 +2181,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -2552,7 +2191,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -2562,7 +2201,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -2572,7 +2211,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "ERC20Token" + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L66)* ## Methods @@ -2580,7 +2227,7 @@ Defined in base-contract/lib/src/index.d.ts:30 ▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L828)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:428](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L428)* **Parameters:** @@ -2597,7 +2244,7 @@ ___ ▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L347)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:456](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L456)* `msg.sender` approves `_spender` to spend `_value` tokens @@ -2618,7 +2265,7 @@ ___ ▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L653)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:509](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L509)* Query the balance of owner @@ -2638,7 +2285,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:327](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L327)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:413](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L413)* **Type parameters:** @@ -2659,7 +2306,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L320)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:405](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L405)* **Type parameters:** @@ -2680,7 +2327,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:314](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L314)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:398](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L398)* **Parameters:** @@ -2696,7 +2343,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:935](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L935)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:719](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L719)* Gets historical logs without creating a subscription @@ -2722,7 +2369,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L334)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:421](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L421)* **Parameters:** @@ -2738,7 +2385,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L893)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:674](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L674)* Subscribe to an event type emitted by the ERC20Token contract. @@ -2766,7 +2413,7 @@ ___ ▸ **totalSupply**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:470](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L470)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L534)* Query total supply of token @@ -2780,7 +2427,7 @@ ___ ▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L709)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:560](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L560)* send `value` token to `to` from `msg.sender` @@ -2801,7 +2448,7 @@ ___ ▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:524](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L524)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:615](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L615)* send `value` token to `to` from `from` on the condition it is approved by `from` @@ -2823,7 +2470,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L918)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L700)* Cancel a subscription @@ -2841,7 +2488,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:707](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L707)* Cancels all existing subscriptions @@ -2853,7 +2500,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L133)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L172)* **Returns:** *[ContractAbi](#contractabi)* @@ -2865,7 +2512,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L91)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:128](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L128)* **Parameters:** @@ -2885,7 +2532,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L66)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:69](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L69)* **Parameters:** @@ -2900,13 +2547,33 @@ Name | Type | ___ +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L95)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -2930,7 +2597,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1376)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:995](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L995)* **Parameters:** @@ -2952,7 +2619,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -2962,7 +2629,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -2972,7 +2639,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -2982,7 +2649,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -2992,7 +2659,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "ERC721Token" + +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L76)* ## Methods @@ -3000,7 +2675,7 @@ Defined in base-contract/lib/src/index.d.ts:30 ▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L438)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:525](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L525)* The zero address indicates there is no approved address. Throws unless `msg.sender` is the current NFT owner, or an authorized @@ -3021,7 +2696,7 @@ ___ ▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:563](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L563)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:579](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L579)* NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address. @@ -3042,7 +2717,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L503)* **Type parameters:** @@ -3063,7 +2738,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L410)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:495](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L495)* **Type parameters:** @@ -3084,7 +2759,7 @@ ___ ▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L618)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:605](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L605)* Throws if `_tokenId` is not a valid NFT. @@ -3104,7 +2779,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L404)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:488](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L488)* **Parameters:** @@ -3120,7 +2795,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1360)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:979](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L979)* Gets historical logs without creating a subscription @@ -3146,7 +2821,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:424](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L424)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:511](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L511)* **Parameters:** @@ -3162,7 +2837,7 @@ ___ ▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:666](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L666)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:626](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L626)* **Parameters:** @@ -3179,7 +2854,7 @@ ___ ▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:727](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L727)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:654](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L654)* NFTs assigned to zero address are considered invalid, and queries about them do throw. @@ -3200,7 +2875,7 @@ ___ ▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:782](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L782)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:682](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L682)* This works identically to the other function with an extra data parameter, except this function just sets data to "". @@ -3221,7 +2896,7 @@ ___ ▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L918)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:748](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L748)* Throws unless `msg.sender` is the current owner, an authorized operator, or the approved address for this NFT. Throws if `_from` is @@ -3248,7 +2923,7 @@ ___ ▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1056](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1056)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:814](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L814)* Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner. @@ -3268,7 +2943,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1318)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:934](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L934)* Subscribe to an event type emitted by the ERC721Token contract. @@ -3296,7 +2971,7 @@ ___ ▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1184)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:871](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L871)* Throws unless `msg.sender` is the current owner, an authorized operator, or the approved address for this NFT. Throws if `_from` is @@ -3319,7 +2994,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1343)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:960](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L960)* Cancel a subscription @@ -3337,7 +3012,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1349)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:967](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L967)* Cancels all existing subscriptions @@ -3349,7 +3024,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:182](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L182)* **Returns:** *[ContractAbi](#contractabi)* @@ -3361,7 +3036,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L101)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:138](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L138)* **Parameters:** @@ -3381,7 +3056,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:79](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L79)* **Parameters:** @@ -3396,13 +3071,33 @@ Name | Type | ___ +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:105](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L105)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -3426,7 +3121,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8066](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8066)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:6007](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L6007)* **Parameters:** @@ -3448,7 +3143,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -3458,7 +3153,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -3468,7 +3163,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -3478,7 +3173,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -3488,7 +3183,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "Exchange" + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:132](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L132)* ## Methods @@ -3496,7 +3199,7 @@ Defined in base-contract/lib/src/index.d.ts:30 ▸ **EIP1271_MAGIC_VALUE**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3106)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3228](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3228)* **Returns:** *`ContractFunctionObj`* @@ -3506,7 +3209,7 @@ ___ ▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3153)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3248](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3248)* **Returns:** *`ContractFunctionObj`* @@ -3516,7 +3219,7 @@ ___ ▸ **allowedValidators**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3200)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3268](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3268)* **Parameters:** @@ -3533,7 +3236,7 @@ ___ ▸ **batchCancelOrders**(`orders`: `Array`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3259](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3259)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3294](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3294)* Executes multiple calls of cancelOrder. @@ -3551,7 +3254,7 @@ ___ ▸ **batchExecuteTransactions**(`transactions`: `Array`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3403)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3366](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3366)* Executes a batch of Exchange method calls in the context of signer(s). @@ -3564,7 +3267,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Array containing ABI encoded return data for each of the underlying Exchange function calls. +returnData Array containing ABI encoded return data for each of the underlying Exchange function calls. ___ @@ -3572,7 +3275,7 @@ ___ ▸ **batchFillOrKillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3541)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3431](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3431)* Executes multiple calls of fillOrKillOrder. @@ -3586,7 +3289,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj>`* -Array of amounts filled and fees paid by makers and taker. +fillResults Array of amounts filled and fees paid by makers and taker. ___ @@ -3594,7 +3297,7 @@ ___ ▸ **batchFillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3717)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3535](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3535)* Executes multiple calls of fillOrder. @@ -3608,7 +3311,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj>`* -Array of amounts filled and fees paid by makers and taker. +fillResults Array of amounts filled and fees paid by makers and taker. ___ @@ -3616,7 +3319,7 @@ ___ ▸ **batchFillOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3893)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3639](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3639)* Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored. @@ -3630,7 +3333,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj>`* -Array of amounts filled and fees paid by makers and taker. +fillResults Array of amounts filled and fees paid by makers and taker. ___ @@ -3638,7 +3341,7 @@ ___ ▸ **batchMatchOrders**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4073](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4073)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3747](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3747)* Match complementary orders that have a profitable spread. Each order is filled at their respective price point, and @@ -3663,7 +3366,7 @@ ___ ▸ **batchMatchOrdersWithMaximalFill**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4298)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3905](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3905)* Match complementary orders that have a profitable spread. Each order is maximally filled at their respective price point, and @@ -3689,7 +3392,7 @@ ___ ▸ **cancelOrder**(`order`: object): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4514)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4054](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4054)* After calling, the order can not be filled anymore. @@ -3707,7 +3410,7 @@ ___ ▸ **cancelOrdersUpTo**(`targetOrderEpoch`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4123](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4123)* 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). @@ -3726,7 +3429,7 @@ ___ ▸ **cancelled**(`index_0`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4762](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4762)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4170](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4170)* **Parameters:** @@ -3742,17 +3445,30 @@ ___ ▸ **currentContextAddress**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4810](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4810)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4191](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4191)* **Returns:** *`ContractFunctionObj`* ___ +### detachProtocolFeeCollector + +▸ **detachProtocolFeeCollector**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4215](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4215)* + +Sets the protocolFeeCollector contract address to 0. +Only callable by owner. + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### executeTransaction ▸ **executeTransaction**(`transaction`: object, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4863](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4863)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4267](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4267)* Executes an Exchange method call in the context of signer. @@ -3773,9 +3489,9 @@ ___ ▸ **fillOrKillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4999](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4999)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4331](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4331)* -Fills the input order. Reverts if exact takerAssetFillAmount not filled. +Fills the input order. Reverts if exact `takerAssetFillAmount` not filled. **Parameters:** @@ -3783,17 +3499,19 @@ 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. | +`signature` | string | Proof that order has been created by maker. | **Returns:** *`ContractTxFunctionObj`* +fillResults Amounts filled and fees paid. + ___ ### fillOrder ▸ **fillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5168)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4428](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4428)* Fills the input order. @@ -3807,7 +3525,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Amounts filled and fees paid by maker and taker. +fillResults Amounts filled and fees paid by maker and taker. ___ @@ -3815,7 +3533,7 @@ ___ ▸ **filled**(`index_0`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5330)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4518](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4518)* **Parameters:** @@ -3831,7 +3549,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3092](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3092)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3213](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3213)* **Type parameters:** @@ -3852,7 +3570,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3085](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3085)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3205](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3205)* **Type parameters:** @@ -3873,7 +3591,7 @@ ___ ▸ **getAssetProxy**(`assetProxyId`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5383)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4544](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4544)* Gets an asset proxy. @@ -3885,7 +3603,7 @@ Name | Type | Description | **Returns:** *`ContractFunctionObj`* -The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. +assetProxy The asset proxy address registered to assetProxyId. Returns 0x0 if no proxy is registered. ___ @@ -3893,7 +3611,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3079)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3198](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3198)* **Parameters:** @@ -3909,7 +3627,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8050](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8050)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5991](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5991)* Gets historical logs without creating a subscription @@ -3935,7 +3653,7 @@ ___ ▸ **getOrderInfo**(`order`: object): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5436)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4570](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4570)* Gets information about an order: status, hash, and amount filled. @@ -3947,7 +3665,7 @@ Name | Type | Description | **Returns:** *`ContractFunctionObj`* -OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. +orderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. ___ @@ -3955,7 +3673,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3099](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3099)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:3221](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3221)* **Parameters:** @@ -3971,7 +3689,7 @@ ___ ▸ **isValidHashSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5520)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4621](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4621)* Verifies that a hash has been signed by the given signer. @@ -3993,7 +3711,7 @@ ___ ▸ **isValidOrderSignature**(`order`: object, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5583](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5583)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4650](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4650)* Verifies that a signature for an order is valid. @@ -4014,7 +3732,7 @@ ___ ▸ **isValidTransactionSignature**(`transaction`: object, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5664](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5664)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4697](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4697)* Verifies that a signature for a transaction is valid. @@ -4035,7 +3753,7 @@ ___ ▸ **marketBuyOrdersFillOrKill**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5738)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4736](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4736)* Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought. NOTE: This function does not enforce that the makerAsset is the same for each order. @@ -4050,7 +3768,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Amounts filled and fees paid by makers and taker. +fillResults Amounts filled and fees paid by makers and taker. ___ @@ -4058,7 +3776,7 @@ ___ ▸ **marketBuyOrdersNoThrow**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5909](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5909)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4835](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4835)* Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. If any fill reverts, the error is caught and ignored. @@ -4074,7 +3792,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Amounts filled and fees paid by makers and taker. +fillResults Amounts filled and fees paid by makers and taker. ___ @@ -4082,7 +3800,7 @@ ___ ▸ **marketSellOrdersFillOrKill**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6079)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:4933](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L4933)* Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold. NOTE: This function does not enforce that the takerAsset is the same for each order. @@ -4097,7 +3815,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Amounts filled and fees paid by makers and taker. +fillResults Amounts filled and fees paid by makers and taker. ___ @@ -4105,7 +3823,7 @@ ___ ▸ **marketSellOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6250)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5032](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5032)* Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. If any fill reverts, the error is caught and ignored. @@ -4121,7 +3839,7 @@ Name | Type | Description | **Returns:** *`ContractTxFunctionObj`* -Amounts filled and fees paid by makers and taker. +fillResults Amounts filled and fees paid by makers and taker. ___ @@ -4129,7 +3847,7 @@ ___ ▸ **matchOrders**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6423](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6423)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5133](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5133)* Match two complementary orders that have a profitable spread. Each order is filled at their respective price point. However, the calculations are @@ -4155,7 +3873,7 @@ ___ ▸ **matchOrdersWithMaximalFill**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6645](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6645)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5288](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5288)* Match two complementary orders that have a profitable spread. Each order is maximally filled at their respective price point, and @@ -4181,7 +3899,7 @@ ___ ▸ **orderEpoch**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6856](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6856)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5432](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5432)* **Parameters:** @@ -4198,7 +3916,7 @@ ___ ▸ **owner**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6911](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6911)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5454](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5454)* **Returns:** *`ContractFunctionObj`* @@ -4208,7 +3926,7 @@ ___ ▸ **preSign**(`hash`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6963)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5479](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5479)* Approves a hash on-chain. After presigning a hash, the preSign signature type will become valid for that hash and signer. @@ -4227,7 +3945,7 @@ ___ ▸ **preSigned**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7069](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7069)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5526](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5526)* **Parameters:** @@ -4244,7 +3962,7 @@ ___ ▸ **protocolFeeCollector**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7124)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5548](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5548)* **Returns:** *`ContractFunctionObj`* @@ -4254,7 +3972,7 @@ ___ ▸ **protocolFeeMultiplier**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7171](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7171)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5568](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5568)* **Returns:** *`ContractFunctionObj`* @@ -4264,7 +3982,7 @@ ___ ▸ **registerAssetProxy**(`assetProxy`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7223)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5593](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5593)* Registers an asset proxy to its asset proxy id. Once an asset proxy is registered, it cannot be unregistered. @@ -4283,7 +4001,7 @@ ___ ▸ **setProtocolFeeCollectorAddress**(`updatedProtocolFeeCollector`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7342)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5645](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5645)* Allows the owner to update the protocolFeeCollector address. @@ -4301,7 +4019,7 @@ ___ ▸ **setProtocolFeeMultiplier**(`updatedProtocolFeeMultiplier`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7461)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5696](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5696)* Allows the owner to update the protocol fee multiplier. @@ -4319,7 +4037,7 @@ ___ ▸ **setSignatureValidatorApproval**(`validatorAddress`: string, `approval`: boolean): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5749](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5749)* Approves/unnapproves a Validator contract to verify signatures on signer's behalf using the `Validator` signature type. @@ -4339,7 +4057,7 @@ ___ ▸ **simulateDispatchTransferFromCalls**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7712](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7712)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5809](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5809)* This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers. @@ -4362,7 +4080,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5946](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5946)* Subscribe to an event type emitted by the Exchange contract. @@ -4390,7 +4108,7 @@ ___ ▸ **transactionsExecuted**(`index_0`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7840](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7840)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5864](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5864)* **Parameters:** @@ -4406,13 +4124,15 @@ ___ ▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7890)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5889](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5889)* + +Change the owner of this contract. **Parameters:** -Name | Type | ------- | ------ | -`newOwner` | string | +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | New owner address. | **Returns:** *`ContractTxFunctionObj`* @@ -4422,7 +4142,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8033](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8033)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5972](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5972)* Cancel a subscription @@ -4440,7 +4160,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8039](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8039)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:5979](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L5979)* Cancels all existing subscriptions @@ -4452,7 +4172,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L198)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:245](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L245)* **Returns:** *[ContractAbi](#contractabi)* @@ -4464,7 +4184,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L151)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:196](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L196)* **Parameters:** @@ -4485,7 +4205,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L125)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L135)* **Parameters:** @@ -4501,13 +4221,34 @@ Name | Type | ___ +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:162](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L162)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`chainId` | `BigNumber` | + +**Returns:** *`Promise`* + +___ + ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -4531,7 +4272,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1147](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1147)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1515](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1515)* **Parameters:** @@ -4553,7 +4294,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -4563,7 +4304,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -4573,7 +4314,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -4583,7 +4324,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -4593,15 +4334,53 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "Forwarder" + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L58)* ## Methods +### ERC1155_BATCH_RECEIVED + +▸ **ERC1155_BATCH_RECEIVED**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:780](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L780)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### ERC1155_RECEIVED + +▸ **ERC1155_RECEIVED**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:800](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L800)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### EXCHANGE_V2_ORDER_ID + +▸ **EXCHANGE_V2_ORDER_ID**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:820](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L820)* + +**Returns:** *`ContractFunctionObj`* + +___ + ### approveMakerAssetProxy ▸ **approveMakerAssetProxy**(`assetData`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L449)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:848](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L848)* Approves the respective proxy for a given asset to transfer tokens on the Forwarder contract's behalf. This is necessary because an order fee denominated in the maker asset (i.e. a percentage fee) is sent by the @@ -4623,7 +4402,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:427](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L427)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:765](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L765)* **Type parameters:** @@ -4644,7 +4423,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:420](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L420)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:757](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L757)* **Type parameters:** @@ -4665,7 +4444,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:414](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L414)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:750](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L750)* **Parameters:** @@ -4677,11 +4456,37 @@ Name | Type | ___ +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ForwarderEvents](#enumeration-forwarderevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1499](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1499)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[ForwarderEventArgs](#forwardereventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [ForwarderEvents](#enumeration-forwarderevents) | The Forwarder 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 + +___ + ### getSelector ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L434)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:773](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L773)* **Parameters:** @@ -4695,9 +4500,9 @@ ___ ### marketBuyOrdersWithEth -▸ **marketBuyOrdersWithEth**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* +▸ **marketBuyOrdersWithEth**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `ethFeeAmounts`: `BigNumber`[], `feeRecipients`: string[]): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L571)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:909](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L909)* Attempt to buy makerAssetBuyAmount of makerAsset by selling ETH provided with transaction. The Forwarder may *fill* more than makerAssetBuyAmount of the makerAsset so that it can @@ -4711,20 +4516,45 @@ Name | Type | Description | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetBuyAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | `signatures` | string[] | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | +`ethFeeAmounts` | `BigNumber`[] | Amounts of ETH, denominated in Wei, that are paid to corresponding feeRecipients. | +`feeRecipients` | string[] | Addresses that will receive ETH when orders are filled. | -**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* -wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. +wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders. + +___ + +### marketSellAmountWithEth + +▸ **marketSellAmountWithEth**(`orders`: `Array`, `ethSellAmount`: `BigNumber`, `signatures`: string[], `ethFeeAmounts`: `BigNumber`[], `feeRecipients`: string[]): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1003](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1003)* + +Purchases as much of orders' makerAssets as possible by selling the specified amount of ETH +accounting for order and forwarder fees. This functions throws if ethSellAmount was not reached. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`ethSellAmount` | `BigNumber` | Desired amount of ETH to sell. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`ethFeeAmounts` | `BigNumber`[] | Amounts of ETH, denominated in Wei, that are paid to corresponding feeRecipients. | +`feeRecipients` | string[] | Addresses that will receive ETH when orders are filled. | + +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* + +wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders. ___ ### marketSellOrdersWithEth -▸ **marketSellOrdersWithEth**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* +▸ **marketSellOrdersWithEth**(`orders`: `Array`, `signatures`: string[], `ethFeeAmounts`: `BigNumber`[], `feeRecipients`: string[]): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:730](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L730)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1096](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1096)* Purchases as much of orders' makerAssets as possible by selling as much of the ETH value sent as possible, accounting for order and forwarder fees. @@ -4735,12 +4565,60 @@ Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | +`ethFeeAmounts` | `BigNumber`[] | Amounts of ETH, denominated in Wei, that are paid to corresponding feeRecipients. | +`feeRecipients` | string[] | Addresses that will receive ETH when orders are filled. | -**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber]>`* -wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. +wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders. + +___ + +### onERC1155BatchReceived + +▸ **onERC1155BatchReceived**(`operator`: string, `from`: string, `ids`: `BigNumber`[], `values`: `BigNumber`[], `data`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1184](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1184)* + +The smart contract calls this function on the recipient after a `safeTransferFrom`. This function MAY throw to revert and reject the transfer. Return of other than the magic value MUST result in the transaction being reverted Note: the contract address is always the message sender + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`operator` | string | The address which called `safeTransferFrom` function | +`from` | string | The address which previously owned the token | +`ids` | `BigNumber`[] | An array containing ids of each token being transferred | +`values` | `BigNumber`[] | An array containing amounts of each token being transferred | +`data` | string | Additional data with no specified format | + +**Returns:** *`ContractTxFunctionObj`* + +`bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` + +___ + +### onERC1155Received + +▸ **onERC1155Received**(`operator`: string, `from`: string, `id`: `BigNumber`, `value`: `BigNumber`, `data`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1256](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1256)* + +The smart contract calls this function on the recipient after a `safeTransferFrom`. This function MAY throw to revert and reject the transfer. Return of other than the magic value MUST result in the transaction being reverted Note: the contract address is always the message sender + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`operator` | string | The address which called `safeTransferFrom` function | +`from` | string | The address which previously owned the token | +`id` | `BigNumber` | An array containing the ids of the token being transferred | +`value` | `BigNumber` | An array containing the amount of tokens being transferred | +`data` | string | Additional data with no specified format | + +**Returns:** *`ContractTxFunctionObj`* + +`bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` ___ @@ -4748,44 +4626,103 @@ ___ ▸ **owner**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:876](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L876)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1319](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1319)* **Returns:** *`ContractFunctionObj`* ___ +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [ForwarderEvents](#enumeration-forwarderevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1454](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1454)* + +Subscribe to an event type emitted by the Forwarder contract. + +**Type parameters:** + +▪ **ArgsType**: *[ForwarderEventArgs](#forwardereventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [ForwarderEvents](#enumeration-forwarderevents) | - | The Forwarder 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 + +___ + ### transferOwnership ▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:923](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L923)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1343](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1343)* + +Change the owner of this contract. **Parameters:** -Name | Type | ------- | ------ | -`newOwner` | string | +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | New owner address. | **Returns:** *`ContractTxFunctionObj`* ___ +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1480](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1480)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1487](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1487)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + ### withdrawAsset ▸ **withdrawAsset**(`assetData`: string, `amount`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1038](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1038)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:1396](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L1396)* -Withdraws assets from this contract. The contract formerly required a ZRX balance in order -to function optimally, and this function allows the ZRX to be withdrawn by owner. -It may also be used to withdraw assets that were accidentally sent to this contract. +Withdraws assets from this contract. It may be used by the owner to withdraw assets +that were accidentally sent to this contract. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded for the respective asset proxy. | -`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | +`amount` | `BigNumber` | Amount of the asset to withdraw. | **Returns:** *`ContractTxFunctionObj`* @@ -4795,7 +4732,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L127)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:195](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L195)* **Returns:** *[ContractAbi](#contractabi)* @@ -4805,9 +4742,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L79)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:144](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L144)* **Parameters:** @@ -4819,7 +4756,8 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | -`_wethAssetData` | string | +`_exchangeV2` | string | +`_weth` | string | **Returns:** *`Promise`* @@ -4827,9 +4765,9 @@ ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:61](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L61)* **Parameters:** @@ -4840,7 +4778,31 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | -`_wethAssetData` | string | +`_exchangeV2` | string | +`_weth` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:99](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L99)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_exchangeV2` | string | +`_weth` | string | **Returns:** *`Promise`* @@ -4852,7 +4814,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -4865,18 +4827,18 @@ Name | Type |
-# Class: IValidatorContract +# Class: IAssetDataContract ## Constructors -\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)* +\+ **new IAssetDataContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IAssetDataContract](#class-iassetdatacontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:234](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L234)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:704](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L704)* **Parameters:** @@ -4886,9 +4848,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | +`deployedBytecode` | string \| undefined | IAssetDataContract.deployedBytecode | -**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* +**Returns:** *[IAssetDataContract](#class-iassetdatacontract)* ## Properties @@ -4898,7 +4860,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -4908,7 +4870,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -4918,7 +4880,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -4928,7 +4890,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -4938,15 +4900,140 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "IAssetData" + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L45)* ## Methods +### ERC1155Assets + +▸ **ERC1155Assets**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `values`: `BigNumber`[], `callbackData`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:361](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L361)* + +Function signature for encoding ERC1155 assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | Address of ERC1155 token contract. | +`tokenIds` | `BigNumber`[] | Array of ids of tokens to be transferred. | +`values` | `BigNumber`[] | Array of values that correspond to each token id to be transferred. Note that each value will be multiplied by the amount being filled in the order before transferring. | +`callbackData` | string | Extra data to be passed to receiver's `onERC1155Received` callback function. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### ERC20Bridge + +▸ **ERC20Bridge**(`tokenAddress`: string, `bridgeAddress`: string, `bridgeData`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L427)* + +Function signature for encoding ERC20Bridge assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | Address of token to transfer. | +`bridgeAddress` | string | Address of the bridge contract. | +`bridgeData` | string | Arbitrary data to be passed to the bridge contract. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### ERC20Token + +▸ **ERC20Token**(`tokenAddress`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:484](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L484)* + +Function signature for encoding ERC20 assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | Address of ERC20Token contract. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### ERC721Token + +▸ **ERC721Token**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:536](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L536)* + +Function signature for encoding ERC721 assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | Address of ERC721 token contract. | +`tokenId` | `BigNumber` | Id of ERC721 token to be transferred. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### MultiAsset + +▸ **MultiAsset**(`values`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:592](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L592)* + +Function signature for encoding MultiAsset assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`values` | `BigNumber`[] | Array of amounts that correspond to each asset to be transferred. Note that each value will be multiplied by the amount being filled in the order before transferring. | +`nestedAssetData` | string[] | Array of assetData fields that will be be dispatched to their correspnding AssetProxy contract. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### StaticCall + +▸ **StaticCall**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:648](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L648)* + +Function signature for encoding StaticCall assetData. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`staticCallTargetAddress` | string | Address that will execute the staticcall. | +`staticCallData` | string | Data that will be executed via staticcall on the staticCallTargetAddress. | +`expectedReturnDataHash` | string | Keccak-256 hash of the expected staticcall return data. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### getABIDecodedReturnData ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L157)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:336](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L336)* **Type parameters:** @@ -4967,7 +5054,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:150](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L150)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:328](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L328)* **Type parameters:** @@ -4988,7 +5075,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:144](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L144)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:321](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L321)* **Parameters:** @@ -5004,7 +5091,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L164)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:344](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L344)* **Parameters:** @@ -5016,33 +5103,11 @@ Name | Type | ___ -### isValidSignature - -▸ **isValidSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L178)* - -Verifies that a signature is valid. - -**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:** *`ContractFunctionObj`* - -Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidValidatorSignature(address,bytes32,address,bytes)")) - -___ - ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L111)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:150](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L150)* **Returns:** *[ContractAbi](#contractabi)* @@ -5052,9 +5117,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L69)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:106](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L106)* **Parameters:** @@ -5066,15 +5131,15 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L47)* **Parameters:** @@ -5085,7 +5150,27 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_asset_data.ts:73](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_asset_data.ts#L73)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* ___ @@ -5095,7 +5180,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -5108,18 +5193,18 @@ Name | Type |
-# Class: IWalletContract +# Class: IERC20BridgeSamplerContract ## Constructors -\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* +\+ **new IERC20BridgeSamplerContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IERC20BridgeSamplerContract](#class-ierc20bridgesamplercontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L224)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1534](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1534)* **Parameters:** @@ -5129,9 +5214,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | +`deployedBytecode` | string \| undefined | IERC20BridgeSamplerContract.deployedBytecode | -**Returns:** *[IWalletContract](#class-iwalletcontract)* +**Returns:** *[IERC20BridgeSamplerContract](#class-ierc20bridgesamplercontract)* ## Properties @@ -5141,7 +5226,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -5151,7 +5236,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -5161,7 +5246,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -5171,7 +5256,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -5181,15 +5266,43 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "IERC20BridgeSampler" + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L45)* ## Methods +### batchCall + +▸ **batchCall**(`callDatas`: string[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:859](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L859)* + +Call multiple public functions on this contract in a single transaction. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`callDatas` | string[] | ABI-encoded call data for each function call. | + +**Returns:** *`ContractFunctionObj`* + +callResults ABI-encoded results data for each call. + +___ + ### getABIDecodedReturnData ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L153)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:839](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L839)* **Type parameters:** @@ -5210,7 +5323,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:146](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L146)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:831](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L831)* **Type parameters:** @@ -5231,7 +5344,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L140)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:824](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L824)* **Parameters:** @@ -5243,11 +5356,79 @@ Name | Type | ___ +### getLiquidityProviderFromRegistry + +▸ **getLiquidityProviderFromRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:888](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L888)* + +Returns the address of a liquidity provider for the given market +(takerToken, makerToken), from a registry of liquidity providers. +Returns address(0) if no such provider exists in the registry. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`registryAddress` | string | - | +`takerToken` | string | Taker asset managed by liquidity provider. | +`makerToken` | string | Maker asset managed by liquidity provider. | + +**Returns:** *`ContractFunctionObj`* + +providerAddress Address of the liquidity provider. + +___ + +### getOrderFillableMakerAssetAmounts + +▸ **getOrderFillableMakerAssetAmounts**(`orders`: `Array`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:926](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L926)* + +Queries the fillable maker asset amounts of native orders. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Native orders to query. | +`orderSignatures` | string[] | Signatures for each respective order in `orders`. | +`devUtilsAddress` | string | Address to the DevUtils contract. | + +**Returns:** *`ContractFunctionObj`* + +orderFillableMakerAssetAmounts How much maker asset can be filled by each order in `orders`. + +___ + +### getOrderFillableTakerAssetAmounts + +▸ **getOrderFillableTakerAssetAmounts**(`orders`: `Array`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:980](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L980)* + +Queries the fillable taker asset amounts of native orders. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Native orders to query. | +`orderSignatures` | string[] | Signatures for each respective order in `orders`. | +`devUtilsAddress` | string | Address to the DevUtils contract. | + +**Returns:** *`ContractFunctionObj`* + +orderFillableTakerAssetAmounts How much taker asset can be filled by each order in `orders`. + +___ + ### getSelector ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L160)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:847](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L847)* **Parameters:** @@ -5259,24 +5440,295 @@ Name | Type | ___ -### isValidSignature +### sampleBuysFromCurve -▸ **isValidSignature**(`hash`: string, `signature`: string): *`ContractFunctionObj`* +▸ **sampleBuysFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:173](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L173)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1035](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1035)* -Validates a hash with the `Wallet` signature type. +Sample buy quotes from Curve. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`hash` | string | Message hash that is signed. | -`signature` | string | Proof of signing. | +`curveAddress` | string | Address of the Curve contract. | +`fromTokenIdx` | `BigNumber` | Index of the taker token (what to sell). | +`toTokenIdx` | `BigNumber` | Index of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | -**Returns:** *`ContractFunctionObj`* +**Returns:** *`ContractFunctionObj`* -magicValue `bytes4(0xb0671381)` if the signature check succeeds. +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleBuysFromEth2Dai + +▸ **sampleBuysFromEth2Dai**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1076](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1076)* + +Sample buy quotes from Eth2Dai/Oasis. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleBuysFromKyberNetwork + +▸ **sampleBuysFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1115](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1115)* + +Sample buy quotes from Kyber. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | +`opts` | object | `FakeBuyOptions` specifying target slippage and max iterations. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleBuysFromLiquidityProviderRegistry + +▸ **sampleBuysFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1158](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1158)* + +Sample buy quotes from an arbitrary on-chain liquidity provider. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`registryAddress` | string | Address of the liquidity provider registry contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | +`opts` | object | `FakeBuyOptions` specifying target slippage and max iterations. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleBuysFromUniswap + +▸ **sampleBuysFromUniswap**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1203](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1203)* + +Sample buy quotes from Uniswap. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleBuysFromUniswapV2 + +▸ **sampleBuysFromUniswapV2**(`path`: string[], `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1240](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1240)* + +Sample buy quotes from UniswapV2. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`path` | string[] | Token route. | +`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +takerTokenAmounts Taker amounts sold at each maker token amount. + +___ + +### sampleSellsFromCurve + +▸ **sampleSellsFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1270](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1270)* + +Sample sell quotes from Curve. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`curveAddress` | string | Address of the Curve contract. | +`fromTokenIdx` | `BigNumber` | Index of the taker token (what to sell). | +`toTokenIdx` | `BigNumber` | Index of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromEth2Dai + +▸ **sampleSellsFromEth2Dai**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1311](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1311)* + +Sample sell quotes from Eth2Dai/Oasis. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromKyberNetwork + +▸ **sampleSellsFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1349](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1349)* + +Sample sell quotes from Kyber. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromLiquidityProviderRegistry + +▸ **sampleSellsFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1388](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1388)* + +Sample sell quotes from an arbitrary on-chain liquidity provider. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`registryAddress` | string | Address of the liquidity provider registry contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromMultiBridge + +▸ **sampleSellsFromMultiBridge**(`multibridge`: string, `takerToken`: string, `intermediateToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1432](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1432)* + +Sample sell quotes from MultiBridge. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`multibridge` | string | Address of the MultiBridge contract. | +`takerToken` | string | Address of the taker token (what to sell). | +`intermediateToken` | string | The address of the intermediate token to use in an indirect route. | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromUniswap + +▸ **sampleSellsFromUniswap**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1476](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1476)* + +Sample sell quotes from Uniswap. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`takerToken` | string | Address of the taker token (what to sell). | +`makerToken` | string | Address of the maker token (what to buy). | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. + +___ + +### sampleSellsFromUniswapV2 + +▸ **sampleSellsFromUniswapV2**(`path`: string[], `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:1513](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L1513)* + +Sample sell quotes from UniswapV2. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`path` | string[] | Token route. | +`takerTokenAmounts` | `BigNumber`[] | Taker token sell amount for each sample. | + +**Returns:** *`ContractFunctionObj`* + +makerTokenAmounts Maker amounts bought at each taker token amount. ___ @@ -5284,7 +5736,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L111)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:162](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L162)* **Returns:** *[ContractAbi](#contractabi)* @@ -5294,9 +5746,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L69)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:118](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L118)* **Parameters:** @@ -5308,15 +5760,15 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L47)* **Parameters:** @@ -5327,7 +5779,27 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts:79](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_erc20_bridge_sampler.ts#L79)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* ___ @@ -5337,7 +5809,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -5350,18 +5822,18 @@ Name | Type |
-# Class: OrderValidatorContract +# Class: ITransformERC20Contract ## Constructors -\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[OrderValidatorContract](#class-ordervalidatorcontract)* +\+ **new ITransformERC20Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ITransformERC20Contract](#class-itransformerc20contract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1338](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1338)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:1008](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L1008)* **Parameters:** @@ -5371,9 +5843,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | OrderValidatorContract.deployedBytecode | +`deployedBytecode` | string \| undefined | ITransformERC20Contract.deployedBytecode | -**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* +**Returns:** *[ITransformERC20Contract](#class-itransformerc20contract)* ## Properties @@ -5383,7 +5855,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -5393,7 +5865,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -5403,7 +5875,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -5413,7 +5885,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -5423,15 +5895,55 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "ITransformERC20" + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:74](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L74)* ## Methods +### _transformERC20 + +▸ **_transformERC20**(`args`: object): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:500](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L500)* + +Internal version of `transformERC20()`. Only callable from within. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | object | A `TransformERC20Args` struct. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### createTransformWallet + +▸ **createTransformWallet**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:562](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L562)* + +Deploy a new flash wallet instance and replace the current one with it. +Useful if we somehow break the current wallet instance. +Only callable by the owner. + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### getABIDecodedReturnData ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:703](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L703)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:481](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L481)* **Type parameters:** @@ -5452,7 +5964,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:696](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L696)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:473](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L473)* **Type parameters:** @@ -5469,62 +5981,11 @@ Name | Type | ___ -### getBalanceAndAllowance - -▸ **getBalanceAndAllowance**(`target`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L835)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`assetData` | string | - -**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`* - -___ - -### getBalancesAndAllowances - -▸ **getBalancesAndAllowances**(`target`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1175)* - -**Parameters:** - -Name | Type | ------- | ------ | -`target` | string | -`assetData` | string[] | - -**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* - -___ - -### getERC721TokenOwner - -▸ **getERC721TokenOwner**(`token`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1120)* - -**Parameters:** - -Name | Type | ------- | ------ | -`token` | string | -`tokenId` | `BigNumber` | - -**Returns:** *`ContractFunctionObj`* - -___ - ### getFunctionSignature ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L690)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:466](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L466)* **Parameters:** @@ -5536,37 +5997,41 @@ Name | Type | ___ -### getOrderAndTraderInfo +### getLogsAsync -▸ **getOrderAndTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj<[object, object]>`* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ITransformERC20Events](#enumeration-itransformerc20events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L717)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:992](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L992)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[ITransformERC20EventArgs](#itransformerc20eventargs)* **Parameters:** -Name | Type | ------- | ------ | -`order` | object | -`takerAddress` | string | +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [ITransformERC20Events](#enumeration-itransformerc20events) | The ITransformERC20 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:** *`ContractFunctionObj<[object, object]>`* +**Returns:** *`Promise>>`* + +Array of logs that match the parameters ___ -### getOrdersAndTradersInfo +### getQuoteSigner -▸ **getOrdersAndTradersInfo**(`orders`: `Array`, `takerAddresses`: string[]): *`ContractFunctionObj<[Array, Array]>`* +▸ **getQuoteSigner**(): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L893)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:611](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L611)* -**Parameters:** +Return the optional signer for `transformERC20()` calldata. -Name | Type | ------- | ------ | -`orders` | `Array` | -`takerAddresses` | string[] | - -**Returns:** *`ContractFunctionObj<[Array, Array]>`* +**Returns:** *`ContractTxFunctionObj`* ___ @@ -5574,7 +6039,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L710)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:489](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L489)* **Parameters:** @@ -5586,37 +6051,2120 @@ Name | Type | ___ -### getTraderInfo +### getTransformWallet -▸ **getTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj`* +▸ **getTransformWallet**(): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1236)* +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:661](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L661)* + +Return the current wallet instance that will serve as the execution +context for transformations. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getTransformerDeployer + +▸ **getTransformerDeployer**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:710](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L710)* + +Return the allowed deployer for transformers. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### setQuoteSigner + +▸ **setQuoteSigner**(`quoteSigner`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:761](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L761)* + +Replace the optional signer for `transformERC20()` calldata. +Only callable by the owner. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`quoteSigner` | string | The address of the new calldata signer. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### setTransformerDeployer + +▸ **setTransformerDeployer**(`transformerDeployer`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:814](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L814)* + +Replace the allowed deployer for transformers. +Only callable by the owner. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transformerDeployer` | string | The address of the new trusted deployer for transformers. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [ITransformERC20Events](#enumeration-itransformerc20events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:947](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L947)* + +Subscribe to an event type emitted by the ITransformERC20 contract. + +**Type parameters:** + +▪ **ArgsType**: *[ITransformERC20EventArgs](#itransformerc20eventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [ITransformERC20Events](#enumeration-itransformerc20events) | - | The ITransformERC20 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 + +___ + +### transformERC20 + +▸ **transformERC20**(`inputToken`: string, `outputToken`: string, `inputTokenAmount`: `BigNumber`, `minOutputTokenAmount`: `BigNumber`, `transformations`: `Array`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:874](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L874)* + +Executes a series of transformations to convert an ERC20 `inputToken` +to an ERC20 `outputToken`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`inputToken` | string | The token being provided by the sender. If `0xeee...`, ETH is implied and should be provided with the call.` | +`outputToken` | string | The token to be acquired by the sender. `0xeee...` implies ETH. | +`inputTokenAmount` | `BigNumber` | The amount of `inputToken` to take from the sender. | +`minOutputTokenAmount` | `BigNumber` | The minimum amount of `outputToken` the sender must receive for the entire transformation to succeed. | +`transformations` | `Array` | The transformations to execute on the token balance(s) in sequence. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:973](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L973)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:980](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L980)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:180](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L180)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L136)* **Parameters:** Name | Type | ------ | ------ | -`order` | object | -`takerAddress` | string | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:77](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L77)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:103](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L103)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:44 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +
+ +# Class: IZeroExContract + + +## Constructors + + + +\+ **new IZeroExContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IZeroExContract](#class-izeroexcontract)* + +*Overrides void* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2781 + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IZeroExContract.deployedBytecode | + +**Returns:** *[IZeroExContract](#class-izeroexcontract)* + +## Properties + +### `Optional` _deployedBytecodeIfExists + +• **_deployedBytecodeIfExists**? : *`Buffer`* + + + +Defined in base-contract/lib/src/index.d.ts:34 + +___ + +### abi + +• **abi**: *[ContractAbi](#contractabi)* + + + +Defined in base-contract/lib/src/index.d.ts:30 + +___ + +### address + +• **address**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:31 + +___ + +Args + +• **constructorArgs**: *any[]* + + + +Defined in base-contract/lib/src/index.d.ts:33 + +___ + +### contractName + +• **contractName**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "IZeroEx" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:106 + +## Methods + +### _executeMetaTransaction + +▸ **_executeMetaTransaction**(`sender`: string, `mtx`: object, `signature`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1188 + +Execute a meta-transaction via `sender`. Privileged variant. +Only callable from within. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`sender` | string | Who is executing the meta-transaction.. | +`mtx` | object | The meta-transaction. | +`signature` | string | The signature by `mtx.signer`. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### _spendERC20Tokens + +▸ **_spendERC20Tokens**(`token`: string, `owner`: string, `to`: string, `amount`: `BigNumber`): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1261 + +Transfers ERC20 tokens from `owner` to `to`. +Only callable from within. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`token` | string | The token to spend. | +`owner` | string | The owner of the tokens. | +`to` | string | The recipient of the tokens. | +`amount` | `BigNumber` | The amount of `token` to transfer. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### _transformERC20 + +▸ **_transformERC20**(`args`: object): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1320 + +Internal version of `transformERC20()`. Only callable from within. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | object | A `TransformERC20Args` struct. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### batchExecuteMetaTransactions + +▸ **batchExecuteMetaTransactions**(`mtxs`: `Array`, `signatures`: string[]): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1382 + +Execute multiple meta-transactions. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`mtxs` | `Array` | The meta-transactions. | +`signatures` | string[] | The signature by each respective `mtx.signer`. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### createTransformWallet + +▸ **createTransformWallet**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1450 + +Deploy a new flash wallet instance and replace the current one with it. +Useful if we somehow break the current wallet instance. +Only callable by the owner. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### executeMetaTransaction + +▸ **executeMetaTransaction**(`mtx`: object, `signature`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1501 + +Execute a single meta-transaction. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`mtx` | object | The meta-transaction. | +`signature` | string | The signature by `mtx.signer`. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### extend + +▸ **extend**(`selector`: string, `impl`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1569 + +Register or replace a function. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`selector` | string | The function selector. | +`impl` | string | The implementation contract for the function. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1166 + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1158 + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getAllowanceTarget + +▸ **getAllowanceTarget**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1620 + +Get the address of the allowance target. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getFunctionImplementation + +▸ **getFunctionImplementation**(`selector`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1670 + +Get the implementation contract of a registered function. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`selector` | string | The function selector. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getFunctionSignature + +▸ **getFunctionSignature**(`methodName`: string): *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1151 + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [IZeroExEvents](#enumeration-izeroexevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2765 + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[IZeroExEventArgs](#izeroexeventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [IZeroExEvents](#enumeration-izeroexevents) | The IZeroEx 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 + +___ + +### getMetaTransactionExecutedBlock + +▸ **getMetaTransactionExecutedBlock**(`mtx`: object): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1721 + +Get the block at which a meta-transaction has been executed. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`mtx` | object | The meta-transaction. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getMetaTransactionHash + +▸ **getMetaTransactionHash**(`mtx`: object): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1784 + +Get the EIP712 hash of a meta-transaction. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`mtx` | object | The meta-transaction. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getMetaTransactionHashExecutedBlock + +▸ **getMetaTransactionHashExecutedBlock**(`mtxHash`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1847 + +Get the block at which a meta-transaction hash has been executed. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`mtxHash` | string | The meta-transaction hash. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getQuoteSigner + +▸ **getQuoteSigner**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1897 + +Return the optional signer for `transformERC20()` calldata. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getRollbackEntryAtIndex + +▸ **getRollbackEntryAtIndex**(`selector`: string, `idx`: `BigNumber`): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1948 + +Retrieve an entry in the rollback history for a function. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`selector` | string | The function selector. | +`idx` | `BigNumber` | The index in the rollback history. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getRollbackLength + +▸ **getRollbackLength**(`selector`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2000 + +Retrieve the length of the rollback history for a function. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`selector` | string | The function selector. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getSelector + +▸ **getSelector**(`methodName`: string): *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1174 + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getSpendableERC20BalanceOf + +▸ **getSpendableERC20BalanceOf**(`token`: string, `owner`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2053 + +Gets the maximum amount of an ERC20 token `token` that can be +pulled from `owner`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`token` | string | The token to spend. | +`owner` | string | The owner of the tokens. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getTransformWallet + +▸ **getTransformWallet**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2105 + +Return the current wallet instance that will serve as the execution +context for transformations. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getTransformerDeployer + +▸ **getTransformerDeployer**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2154 + +Return the allowed deployer for transformers. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### isValidHashSignature + +▸ **isValidHashSignature**(`hash`: string, `signer`: string, `signature`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2207 + +Check that `hash` was signed by `signer` given `signature`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | The hash that was signed. | +`signer` | string | The signer of the hash. | +`signature` | string | The signature. The last byte of this signature should be a member of the `SignatureType` enum. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### migrate + +▸ **migrate**(`target`: string, `data`: string, `newOwner`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2266 + +Execute a migration function in the context of the ZeroEx contract. +The result of the function being called should be the magic bytes +0x2c64c5ef (`keccack('MIGRATE_SUCCESS')`). Only callable by the owner. +The owner will be temporarily set to `address(this)` inside the call. +Before returning, the owner will be set to `newOwner`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | The migrator contract address. | +`data` | string | The call data. | +`newOwner` | string | The address of the new owner. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### owner + +▸ **owner**(): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2322 + +The owner of this contract. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### rollback + +▸ **rollback**(`selector`: string, `targetImpl`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2373 + +Roll back to a prior implementation of a function. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`selector` | string | The function selector. | +`targetImpl` | string | The address of an older implementation of the function. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### setQuoteSigner + +▸ **setQuoteSigner**(`quoteSigner`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2426 + +Replace the optional signer for `transformERC20()` calldata. +Only callable by the owner. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`quoteSigner` | string | The address of the new calldata signer. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### setTransformerDeployer + +▸ **setTransformerDeployer**(`transformerDeployer`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2479 + +Replace the allowed deployer for transformers. +Only callable by the owner. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`transformerDeployer` | string | The address of the new trusted deployer for transformers. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [IZeroExEvents](#enumeration-izeroexevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2720 + +Subscribe to an event type emitted by the IZeroEx contract. + +**Type parameters:** + +▪ **ArgsType**: *[IZeroExEventArgs](#izeroexeventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [IZeroExEvents](#enumeration-izeroexevents) | - | The IZeroEx 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 + +___ + +### transferOwnership + +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2530 + +Transfers ownership of the contract to a new address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | The address that will become the owner. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### transformERC20 + +▸ **transformERC20**(`inputToken`: string, `outputToken`: string, `inputTokenAmount`: `BigNumber`, `minOutputTokenAmount`: `BigNumber`, `transformations`: `Array`): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2590 + +Executes a series of transformations to convert an ERC20 `inputToken` +to an ERC20 `outputToken`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`inputToken` | string | The token being provided by the sender. If `0xeee...`, ETH is implied and should be provided with the call.` | +`outputToken` | string | The token to be acquired by the sender. `0xeee...` implies ETH. | +`inputTokenAmount` | `BigNumber` | The amount of `inputToken` to take from the sender. | +`minOutputTokenAmount` | `BigNumber` | The minimum amount of `outputToken` the sender must receive for the entire transformation to succeed. | +`transformations` | `Array` | The transformations to execute on the token balance(s) in sequence. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2746 + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2753 + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### validateHashSignature + +▸ **validateHashSignature**(`hash`: string, `signer`: string, `signature`: string): *`ContractTxFunctionObj`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2661 + +Validate that `hash` was signed by `signer` given `signature`. +Reverts otherwise. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | The hash that was signed. | +`signer` | string | The signer of the hash. | +`signature` | string | The signature. The last byte of this signature should be a member of the `SignatureType` enum. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:212 + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:168 + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:109 + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:135 + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:44 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +
+ +# Class: StakingContract + + +## Constructors + + + +\+ **new StakingContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[StakingContract](#class-stakingcontract)* + +*Overrides void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3557](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3557)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | StakingContract.deployedBytecode | + +**Returns:** *[StakingContract](#class-stakingcontract)* + +## Properties + +### `Optional` _deployedBytecodeIfExists + +• **_deployedBytecodeIfExists**? : *`Buffer`* + + + +Defined in base-contract/lib/src/index.d.ts:34 + +___ + +### abi + +• **abi**: *[ContractAbi](#contractabi)* + + + +Defined in base-contract/lib/src/index.d.ts:30 + +___ + +### address + +• **address**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:31 + +___ + +Args + +• **constructorArgs**: *any[]* + + + +Defined in base-contract/lib/src/index.d.ts:33 + +___ + +### contractName + +• **contractName**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "Staking" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:177](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L177)* + +## Methods + +### addAuthorizedAddress + +▸ **addAuthorizedAddress**(`target`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1701](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1701)* + +Authorizes an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### addExchangeAddress + +▸ **addExchangeAddress**(`addr`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1752](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1752)* + +Adds a new exchange address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`addr` | string | Address of exchange contract to add | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### aggregatedStatsByEpoch + +▸ **aggregatedStatsByEpoch**(`index_0`: `BigNumber`): *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1799](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1799)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>`* + +___ + +### authorities + +▸ **authorities**(`index_0`: `BigNumber`): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1827](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1827)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *`ContractFunctionObj`* + +___ + +### authorized + +▸ **authorized**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1848](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1848)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### cobbDouglasAlphaDenominator + +▸ **cobbDouglasAlphaDenominator**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1869](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1869)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### cobbDouglasAlphaNumerator + +▸ **cobbDouglasAlphaNumerator**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1889](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1889)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### computeRewardBalanceOfDelegator + +▸ **computeRewardBalanceOfDelegator**(`poolId`: string, `member`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1915](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1915)* + +Computes the reward balance in ETH of a specific member of a pool. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique id of pool. | +`member` | string | The member of the pool. | + +**Returns:** *`ContractFunctionObj`* + +totalReward Balance in ETH. + +___ + +### computeRewardBalanceOfOperator + +▸ **computeRewardBalanceOfOperator**(`poolId`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1942](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1942)* + +Computes the reward balance in ETH of the operator of a pool. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique id of pool. | + +**Returns:** *`ContractFunctionObj`* + +totalReward Balance in ETH. + +___ + +### createStakingPool + +▸ **createStakingPool**(`operatorShare`: number | `BigNumber`, `addOperatorAsMaker`: boolean): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1970](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1970)* + +Create a new staking pool. The sender will be the operator of this pool. Note that an operator must be payable. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`operatorShare` | number \| `BigNumber` | Portion of rewards owned by the operator, in ppm. | +`addOperatorAsMaker` | boolean | Adds operator to the created pool as a maker for convenience iff true. | + +**Returns:** *`ContractTxFunctionObj`* + +poolId The unique pool id generated for this pool. + +___ + +### currentEpoch + +▸ **currentEpoch**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2021](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2021)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### currentEpochStartTimeInSeconds + +▸ **currentEpochStartTimeInSeconds**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2041](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2041)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### decreaseStakingPoolOperatorShare + +▸ **decreaseStakingPoolOperatorShare**(`poolId`: string, `newOperatorShare`: number | `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2067](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2067)* + +Decreases the operator share for the given pool (i.e. increases pool rewards for members). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique Id of pool. | +`newOperatorShare` | number \| `BigNumber` | The newly decreased percentage of any rewards owned by the operator. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### endEpoch + +▸ **endEpoch**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2124](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2124)* + +Begins a new epoch, preparing the prior one for finalization. +Throws if not enough time has passed between epochs or if the +previous epoch was not fully finalized. + +**Returns:** *`ContractTxFunctionObj`* + +numPoolsToFinalize The number of unfinalized pools. + +___ + +### epochDurationInSeconds + +▸ **epochDurationInSeconds**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2170](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2170)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### finalizePool + +▸ **finalizePool**(`poolId`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2198](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2198)* + +Instantly finalizes a single pool that earned rewards in the previous +epoch, crediting it rewards for members and withdrawing operator's +rewards as WETH. This can be called by internal functions that need +to finalize a pool immediately. Does nothing if the pool is already +finalized or did not earn rewards in the previous epoch. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | The pool ID to finalize. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1682](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1682)* + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1674](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1674)* + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getAuthorizedAddresses + +▸ **getAuthorizedAddresses**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2249](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2249)* + +Gets all authorized addresses. + +**Returns:** *`ContractFunctionObj`* + +Array of authorized addresses. + +___ + +### getCurrentEpochEarliestEndTimeInSeconds + +▸ **getCurrentEpochEarliestEndTimeInSeconds**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2275](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2275)* + +Returns the earliest end time in seconds of this epoch. +The next epoch can begin once this time is reached. +Epoch period = [startTimeInSeconds..endTimeInSeconds) + +**Returns:** *`ContractFunctionObj`* + +Time in seconds. + +___ + +### getFunctionSignature + +▸ **getFunctionSignature**(`methodName`: string): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1667](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1667)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getGlobalStakeByStatus + +▸ **getGlobalStakeByStatus**(`stakeStatus`: number | `BigNumber`): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2300](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2300)* + +Gets global stake for a given status. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`stakeStatus` | number \| `BigNumber` | UNDELEGATED or DELEGATED | + +**Returns:** *`ContractFunctionObj`* + +Global stake for given status. + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [StakingEvents](#enumeration-stakingevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3541](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3541)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[StakingEventArgs](#stakingeventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [StakingEvents](#enumeration-stakingevents) | The Staking 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 + +___ + +### getOwnerStakeByStatus + +▸ **getOwnerStakeByStatus**(`staker`: string, `stakeStatus`: number | `BigNumber`): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2336](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2336)* + +Gets an owner's stake balances by status. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`staker` | string | Owner of stake. | +`stakeStatus` | number \| `BigNumber` | UNDELEGATED or DELEGATED | + +**Returns:** *`ContractFunctionObj`* + +Owner's stake balances for given status. + +___ + +### getParams + +▸ **getParams**(): *`ContractFunctionObj<[BigNumber, number, BigNumber, number, number]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2372](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2372)* + +Retrieves all configurable parameter values. + +**Returns:** *`ContractFunctionObj<[BigNumber, number, BigNumber, number, number]>`* + +_epochDurationInSeconds Minimum seconds between epochs._rewardDelegatedStakeWeight How much delegated stake is weighted vs operator stake, in ppm._minimumPoolStake Minimum amount of stake required in a pool to collect rewards._cobbDouglasAlphaNumerator Numerator for cobb douglas alpha factor._cobbDouglasAlphaDenominator Denominator for cobb douglas alpha factor. + +___ + +### getSelector + +▸ **getSelector**(`methodName`: string): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:1690](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L1690)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getStakeDelegatedToPoolByOwner + +▸ **getStakeDelegatedToPoolByOwner**(`staker`: string, `poolId`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2403](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2403)* + +Returns the stake delegated to a specific staking pool, by a given staker. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`staker` | string | of stake. | +`poolId` | string | Unique Id of pool. | + +**Returns:** *`ContractFunctionObj`* + +Stake delegated to pool by staker. + +___ + +### getStakingPool + +▸ **getStakingPool**(`poolId`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2439)* + +Returns a staking pool + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique id of pool. | **Returns:** *`ContractFunctionObj`* ___ -### getTradersInfo +### getStakingPoolStatsThisEpoch -▸ **getTradersInfo**(`orders`: `Array`, `takerAddresses`: string[]): *`ContractFunctionObj>`* +▸ **getStakingPoolStatsThisEpoch**(`poolId`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1011](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1011)* +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2468](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2468)* + +Get stats on a staking pool in this epoch. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Pool Id to query. | + +**Returns:** *`ContractFunctionObj`* + +PoolStats struct for pool id. + +___ + +### getTotalStake + +▸ **getTotalStake**(`staker`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2503](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2503)* + +Returns the total stake for a given staker. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`staker` | string | of stake. | + +**Returns:** *`ContractFunctionObj`* + +Total ZRX staked by `staker`. + +___ + +### getTotalStakeDelegatedToPool + +▸ **getTotalStakeDelegatedToPool**(`poolId`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2530](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2530)* + +Returns the total stake delegated to a specific staking pool, +across all members. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique Id of pool. | + +**Returns:** *`ContractFunctionObj`* + +Total stake delegated to pool. + +___ + +### getWethContract + +▸ **getWethContract**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2565](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2565)* + +An overridable way to access the deployed WETH contract. +Must be view to allow overrides to access state. + +**Returns:** *`ContractFunctionObj`* + +wethContract The WETH contract instance. + +___ + +### getZrxVault + +▸ **getZrxVault**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2590](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2590)* + +An overridable way to access the deployed zrxVault. +Must be view to allow overrides to access state. + +**Returns:** *`ContractFunctionObj`* + +zrxVault The zrxVault contract. + +___ + +### init + +▸ **init**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2615](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2615)* + +Initialize storage owned by this contract. +This function should not be called directly. +The StakingProxy contract will call it in `attachStakingContract()`. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### joinStakingPoolAsMaker + +▸ **joinStakingPoolAsMaker**(`poolId`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2665](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2665)* + +Allows caller to join a staking pool as a maker. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique id of pool. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### lastPoolId + +▸ **lastPoolId**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2712](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2712)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### minimumPoolStake + +▸ **minimumPoolStake**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2732](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2732)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### moveStake + +▸ **moveStake**(`from`: object, `to`: object, `amount`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2760](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2760)* + +Moves stake between statuses: 'undelegated' or 'delegated'. +Delegated stake can also be moved between pools. +This change comes into effect next epoch. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`from` | object | Status to move stake out of. | +`to` | object | Status to move stake into. | +`amount` | `BigNumber` | Amount of stake to move. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### owner + +▸ **owner**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2812](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2812)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### payProtocolFee + +▸ **payProtocolFee**(`makerAddress`: string, `payerAddress`: string, `protocolFee`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2841](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2841)* + +Pays a protocol fee in ETH or WETH. +Only a known 0x exchange can call this method. See +(MixinExchangeManager). + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`makerAddress` | string | The address of the order's maker. | +`payerAddress` | string | The address of the protocol fee payer. | +`protocolFee` | `BigNumber` | The protocol fee amount. This is either passed as ETH or transferred as WETH. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### poolIdByMaker + +▸ **poolIdByMaker**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2898](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2898)* **Parameters:** Name | Type | ------ | ------ | -`orders` | `Array` | -`takerAddresses` | string[] | +`index_0` | string | -**Returns:** *`ContractFunctionObj>`* +**Returns:** *`ContractFunctionObj`* + +___ + +### poolStatsByEpoch + +▸ **poolStatsByEpoch**(`index_0`: string, `index_1`: `BigNumber`): *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2919](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2919)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | `BigNumber` | + +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber]>`* + +___ + +### removeAuthorizedAddress + +▸ **removeAuthorizedAddress**(`target`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:2951](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L2951)* + +Removes authorizion of an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### removeAuthorizedAddressAtIndex + +▸ **removeAuthorizedAddressAtIndex**(`target`: string, `index`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3003](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3003)* + +Removes authorizion of an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### removeExchangeAddress + +▸ **removeExchangeAddress**(`addr`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3055](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3055)* + +Removes an existing exchange address + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`addr` | string | Address of exchange contract to remove | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### rewardDelegatedStakeWeight + +▸ **rewardDelegatedStakeWeight**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3102](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3102)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### rewardsByPoolId + +▸ **rewardsByPoolId**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3122](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3122)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### setParams + +▸ **setParams**(`_epochDurationInSeconds`: `BigNumber`, `_rewardDelegatedStakeWeight`: number | `BigNumber`, `_minimumPoolStake`: `BigNumber`, `_cobbDouglasAlphaNumerator`: number | `BigNumber`, `_cobbDouglasAlphaDenominator`: number | `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3154](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3154)* + +Set all configurable parameters at once. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_epochDurationInSeconds` | `BigNumber` | Minimum seconds between epochs. | +`_rewardDelegatedStakeWeight` | number \| `BigNumber` | How much delegated stake is weighted vs operator stake, in ppm. | +`_minimumPoolStake` | `BigNumber` | Minimum amount of stake required in a pool to collect rewards. | +`_cobbDouglasAlphaNumerator` | number \| `BigNumber` | Numerator for cobb douglas alpha factor. | +`_cobbDouglasAlphaDenominator` | number \| `BigNumber` | Denominator for cobb douglas alpha factor. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### stake + +▸ **stake**(`amount`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3222](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3222)* + +Stake ZRX tokens. Tokens are deposited into the ZRX Vault. +Unstake to retrieve the ZRX. Stake is in the 'Active' status. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amount` | `BigNumber` | Amount of ZRX to stake. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### stakingContract + +▸ **stakingContract**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3269](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3269)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [StakingEvents](#enumeration-stakingevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3496](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3496)* + +Subscribe to an event type emitted by the Staking contract. + +**Type parameters:** + +▪ **ArgsType**: *[StakingEventArgs](#stakingeventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [StakingEvents](#enumeration-stakingevents) | - | The Staking 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 + +___ + +### transferOwnership + +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3293](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3293)* + +Change the owner of this contract. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | New owner address. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### unstake + +▸ **unstake**(`amount`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3346](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3346)* + +Unstake. Tokens are withdrawn from the ZRX Vault and returned to +the staker. Stake must be in the 'undelegated' status in both the +current and next epoch in order to be unstaked. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amount` | `BigNumber` | Amount of ZRX to unstake. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3522](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3522)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3529](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3529)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### validExchanges + +▸ **validExchanges**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3393)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### wethReservedForPoolRewards + +▸ **wethReservedForPoolRewards**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3414](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3414)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### withdrawDelegatorRewards + +▸ **withdrawDelegatorRewards**(`poolId`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:3439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L3439)* + +Withdraws the caller's WETH rewards that have accumulated +until the last epoch. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`poolId` | string | Unique id of pool. | + +**Returns:** *`ContractTxFunctionObj`* ___ @@ -5624,7 +8172,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L127)* +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:283](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L283)* **Returns:** *[ContractAbi](#contractabi)* @@ -5634,9 +8182,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L79)* +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:239](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L239)* **Parameters:** @@ -5647,18 +8195,16 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:180](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L180)* **Parameters:** @@ -5668,10 +8214,28 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -`_exchange` | string | -`_zrxAssetData` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:206](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L206)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* ___ @@ -5681,7 +8245,713 @@ ___ -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 + +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* + +
+ +# Class: StakingProxyContract + + +## Constructors + + + +\+ **new StakingProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[StakingProxyContract](#class-stakingproxycontract)* + +*Overrides void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1681](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1681)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | StakingProxyContract.deployedBytecode | + +**Returns:** *[StakingProxyContract](#class-stakingproxycontract)* + +## Properties + +### `Optional` _deployedBytecodeIfExists + +• **_deployedBytecodeIfExists**? : *`Buffer`* + + + +Defined in base-contract/lib/src/index.d.ts:34 + +___ + +### abi + +• **abi**: *[ContractAbi](#contractabi)* + + + +Defined in base-contract/lib/src/index.d.ts:30 + +___ + +### address + +• **address**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:31 + +___ + +Args + +• **constructorArgs**: *any[]* + + + +Defined in base-contract/lib/src/index.d.ts:33 + +___ + +### contractName + +• **contractName**: *string* + + + +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "StakingProxy" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:83](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L83)* + +## Methods + +### addAuthorizedAddress + +▸ **addAuthorizedAddress**(`target`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:828](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L828)* + +Authorizes an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to authorize. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### aggregatedStatsByEpoch + +▸ **aggregatedStatsByEpoch**(`index_0`: `BigNumber`): *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:875](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L875)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber, BigNumber, BigNumber]>`* + +___ + +### assertValidStorageParams + +▸ **assertValidStorageParams**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:906](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L906)* + +Asserts that an epoch is between 5 and 30 days long. + +**Returns:** *`ContractFunctionObj`* + +___ + +### attachStakingContract + +▸ **attachStakingContract**(`_stakingContract`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:930](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L930)* + +Attach a staking contract; future calls will be delegated to the staking contract. Note that this is callable only by an authorized address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_stakingContract` | string | Address of staking contract. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### authorities + +▸ **authorities**(`index_0`: `BigNumber`): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:977](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L977)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | `BigNumber` | + +**Returns:** *`ContractFunctionObj`* + +___ + +### authorized + +▸ **authorized**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:998](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L998)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### batchExecute + +▸ **batchExecute**(`data`: string[]): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1024](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1024)* + +Batch executes a series of calls to the staking contract. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`data` | string[] | An array of data that encodes a sequence of functions to call in the staking contracts. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### cobbDouglasAlphaDenominator + +▸ **cobbDouglasAlphaDenominator**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1071](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1071)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### cobbDouglasAlphaNumerator + +▸ **cobbDouglasAlphaNumerator**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1091](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1091)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### currentEpoch + +▸ **currentEpoch**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1111](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1111)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### currentEpochStartTimeInSeconds + +▸ **currentEpochStartTimeInSeconds**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1131](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1131)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### detachStakingContract + +▸ **detachStakingContract**(): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1154](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1154)* + +Detach the current staking contract. Note that this is callable only by an authorized address. + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### epochDurationInSeconds + +▸ **epochDurationInSeconds**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1200](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1200)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### getABIDecodedReturnData + +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:809](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L809)* + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:801](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L801)* + +**Type parameters:** + +▪ **T** + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getAuthorizedAddresses + +▸ **getAuthorizedAddresses**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1224](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1224)* + +Gets all authorized addresses. + +**Returns:** *`ContractFunctionObj`* + +Array of authorized addresses. + +___ + +### getFunctionSignature + +▸ **getFunctionSignature**(`methodName`: string): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:794](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L794)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getLogsAsync + +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [StakingProxyEvents](#enumeration-stakingproxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1665](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1665)* + +Gets historical logs without creating a subscription + +**Type parameters:** + +▪ **ArgsType**: *[StakingProxyEventArgs](#stakingproxyeventargs)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`eventName` | [StakingProxyEvents](#enumeration-stakingproxyevents) | The StakingProxy 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 + +___ + +### getSelector + +▸ **getSelector**(`methodName`: string): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:817](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L817)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### lastPoolId + +▸ **lastPoolId**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1244](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1244)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### minimumPoolStake + +▸ **minimumPoolStake**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1264](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1264)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### owner + +▸ **owner**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1284](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1284)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### poolIdByMaker + +▸ **poolIdByMaker**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1304](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1304)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### poolStatsByEpoch + +▸ **poolStatsByEpoch**(`index_0`: string, `index_1`: `BigNumber`): *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber]>`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1325](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1325)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | `BigNumber` | + +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber, BigNumber]>`* + +___ + +### removeAuthorizedAddress + +▸ **removeAuthorizedAddress**(`target`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1357](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1357)* + +Removes authorizion of an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### removeAuthorizedAddressAtIndex + +▸ **removeAuthorizedAddressAtIndex**(`target`: string, `index`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1409](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1409)* + +Removes authorizion of an address. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`target` | string | Address to remove authorization from. | +`index` | `BigNumber` | Index of target in authorities array. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### rewardDelegatedStakeWeight + +▸ **rewardDelegatedStakeWeight**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1457](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1457)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### rewardsByPoolId + +▸ **rewardsByPoolId**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1477](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1477)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### stakingContract + +▸ **stakingContract**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1498](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1498)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [StakingProxyEvents](#enumeration-stakingproxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1620](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1620)* + +Subscribe to an event type emitted by the StakingProxy contract. + +**Type parameters:** + +▪ **ArgsType**: *[StakingProxyEventArgs](#stakingproxyeventargs)* + +**Parameters:** + +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`eventName` | [StakingProxyEvents](#enumeration-stakingproxyevents) | - | The StakingProxy 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 + +___ + +### transferOwnership + +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1522](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1522)* + +Change the owner of this contract. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`newOwner` | string | New owner address. | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### unsubscribe + +▸ **unsubscribe**(`subscriptionToken`: string): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1646](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1646)* + +Cancel a subscription + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | + +**Returns:** *void* + +___ + +### unsubscribeAll + +▸ **unsubscribeAll**(): *void* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1653](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1653)* + +Cancels all existing subscriptions + +**Returns:** *void* + +___ + +### validExchanges + +▸ **validExchanges**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1569](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1569)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### wethReservedForPoolRewards + +▸ **wethReservedForPoolRewards**(): *`ContractFunctionObj`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:1590](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L1590)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:210](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L210)* + +**Returns:** *[ContractAbi](#contractabi)* + +The contract ABI + +___ + +### `Static` deployAsync + +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:161](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L161)* + +**Parameters:** + +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_stakingContract` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployFrom0xArtifactAsync + +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:86](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L86)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_stakingContract` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:120](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L120)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_stakingContract` | string | + +**Returns:** *`Promise`* + +___ + +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* + + + +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -5705,7 +8975,7 @@ Name | Type | *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1381)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:984](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L984)* **Parameters:** @@ -5727,7 +8997,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:32 +Defined in base-contract/lib/src/index.d.ts:34 ___ @@ -5737,7 +9007,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:30 ___ @@ -5747,7 +9017,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -5757,7 +9027,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:33 ___ @@ -5767,7 +9037,15 @@ ___ -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:32 + +___ + +### `Static` contractName + +▪ **contractName**: *string* = "WETH9" + +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:82](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L82)* ## Methods @@ -5775,7 +9053,7 @@ Defined in base-contract/lib/src/index.d.ts:30 ▸ **allowance**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1258)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:552](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L552)* **Parameters:** @@ -5792,7 +9070,7 @@ ___ ▸ **approve**(`guy`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:512](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L512)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:574](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L574)* **Parameters:** @@ -5809,7 +9087,7 @@ ___ ▸ **balanceOf**(`index_0`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:946](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L946)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:622](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L622)* **Parameters:** @@ -5825,7 +9103,7 @@ ___ ▸ **decimals**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:643](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L643)* **Returns:** *`ContractFunctionObj`* @@ -5835,7 +9113,7 @@ ___ ▸ **deposit**(): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1153)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:663](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L663)* **Returns:** *`ContractTxFunctionObj`* @@ -5845,7 +9123,7 @@ ___ ▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L451)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:537](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L537)* **Type parameters:** @@ -5866,7 +9144,7 @@ ___ ▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:444](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L444)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:529](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L529)* **Type parameters:** @@ -5887,7 +9165,7 @@ ___ ▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L438)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:522](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L522)* **Parameters:** @@ -5903,7 +9181,7 @@ ___ ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1365)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:968](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L968)* Gets historical logs without creating a subscription @@ -5929,7 +9207,7 @@ ___ ▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L458)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:545](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L545)* **Parameters:** @@ -5945,7 +9223,7 @@ ___ ▸ **name**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L465)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:709](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L709)* **Returns:** *`ContractFunctionObj`* @@ -5955,7 +9233,7 @@ ___ ▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1323](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1323)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:923](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L923)* Subscribe to an event type emitted by the WETH9 contract. @@ -5983,7 +9261,7 @@ ___ ▸ **symbol**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:996](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L996)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:729](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L729)* **Returns:** *`ContractFunctionObj`* @@ -5993,7 +9271,7 @@ ___ ▸ **totalSupply**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:622](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L622)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:749](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L749)* **Returns:** *`ContractFunctionObj`* @@ -6003,7 +9281,7 @@ ___ ▸ **transfer**(`dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1043](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1043)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:769](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L769)* **Parameters:** @@ -6020,7 +9298,7 @@ ___ ▸ **transferFrom**(`src`: string, `dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:817](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L817)* **Parameters:** @@ -6038,7 +9316,7 @@ ___ ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1348)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:949](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L949)* Cancel a subscription @@ -6056,7 +9334,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1354)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:956](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L956)* Cancels all existing subscriptions @@ -6068,7 +9346,7 @@ ___ ▸ **withdraw**(`wad`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L793)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:866](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L866)* **Parameters:** @@ -6084,7 +9362,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L149)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:188](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L188)* **Returns:** *[ContractAbi](#contractabi)* @@ -6096,7 +9374,7 @@ ___ ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L107)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:144](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L144)* **Parameters:** @@ -6116,7 +9394,7 @@ ___ ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L82)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:85](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L85)* **Parameters:** @@ -6131,13 +9409,33 @@ Name | Type | ___ +### `Static` deployWithLibrariesFrom0xArtifactAsync + +▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* + +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:111](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L111)* + +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` | +`libraryArtifacts` | object | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* + +___ + ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -Defined in base-contract/lib/src/index.d.ts:42 +Defined in base-contract/lib/src/index.d.ts:44 **Parameters:** @@ -6150,145 +9448,6 @@ Name | Type |
-# Class: ContractWrappers - -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. - - -## Constructors - - - -\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L66)* - -Instantiates a new ContractWrappers instance. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. | -`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. | - -**Returns:** *[ContractWrappers](#class-contractwrappers)* - -An instance of the ContractWrappers class. - -## Properties - -### contractAddresses - -• **contractAddresses**: *`ContractAddresses`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L38)* - -An index of the default contract addresses for this chain. - -___ - -### coordinator - -• **coordinator**: *`CoordinatorContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L64)* - -An instance of the CoordinatorContract class containing methods for interacting with the Coordinator extension contract. - -___ - -### devUtils - -• **devUtils**: *`DevUtilsContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L60)* - -An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. - -___ - -### exchange - -• **exchange**: *`ExchangeContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L42)* - -An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. - -___ - -### forwarder - -• **forwarder**: *`ForwarderContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L51)* - -An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. - -___ - -### orderValidator - -• **orderValidator**: *`OrderValidatorContract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L56)* - -An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. - -___ - -### weth9 - -• **weth9**: *`WETH9Contract`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L47)* - -An instance of the WETH9Contract class containing methods for interacting with the -WETH9 smart contract. - -## Methods - -### getAbiDecoder - -▸ **getAbiDecoder**(): *`AbiDecoder`* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L124)* - -Get the abi decoder instance currently used by contract-wrappers - -**Returns:** *`AbiDecoder`* - -AbiDecoder instance - -___ - -### getProvider - -▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L117)* - -Get the provider instance currently used by contract-wrappers - -**Returns:** *[SupportedProvider](#supportedprovider)* - -Web3 provider instance - -___ - -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [contract-wrappers/src/contract_wrappers.ts:109](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L109)* - -Unsubscribes from all subscriptions for all contracts. - -**Returns:** *void* - -
- # Class: AbiDecoder AbiDecoder allows you to decode event logs given a set of supplied contract ABI's. It takes the contract's event @@ -6301,7 +9460,7 @@ signature from the ABI and attempts to decode the logs using it. \+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* -*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L42)* +*Defined in [utils/src/abi_decoder.ts:39](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L39)* Instantiate an AbiDecoder @@ -6321,7 +9480,7 @@ AbiDecoder instance ▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L158)* +*Defined in [utils/src/abi_decoder.ts:150](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L150)* Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. Additional properties can be included to disambiguate similar ABI's. For example, if two functions @@ -6343,7 +9502,7 @@ ___ ▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L118)* +*Defined in [utils/src/abi_decoder.ts:110](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L110)* Decodes calldata for a known ABI. @@ -6364,7 +9523,7 @@ ___ ▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L58)* +*Defined in [utils/src/abi_decoder.ts:55](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L55)* Attempt to decode a log given the ABI's the AbiDecoder knows about. @@ -6384,69 +9543,29 @@ The decoded log if the requisite ABI was available. Otherwise the log unaltered.
-# Enumeration: CoordinatorRegistryEvents +# Enumeration: SubscriptionErrors ## Enumeration members -### CoordinatorEndpointSet +### SubscriptionAlreadyPresent -• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" +• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L40)* - -
- -# Enumeration: DummyERC20TokenEvents - - -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L40)* +*Defined in [base-contract/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L21)* ___ -### Transfer +### SubscriptionNotFound -• **Transfer**: = "Transfer" +• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L41)* +*Defined in [base-contract/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L20)*
-# Enumeration: DummyERC721TokenEvents -## Enumeration members - -### Approval - -• **Approval**: = "Approval" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L43)* - -___ - -### ApprovalForAll - -• **ApprovalForAll**: = "ApprovalForAll" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L44)* - -___ - -### Transfer - -• **Transfer**: = "Transfer" - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L45)* - -
- # Enumeration: ERC20TokenEvents @@ -6456,7 +9575,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L41)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L41)* ___ @@ -6464,7 +9583,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L40)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L42)*
@@ -6477,7 +9596,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L43)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L44)* ___ @@ -6485,7 +9604,7 @@ ___ • **ApprovalForAll**: = "ApprovalForAll" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L45)* ___ @@ -6493,7 +9612,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L45)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L46)*
@@ -6506,7 +9625,7 @@ ___ • **AssetProxyRegistered**: = "AssetProxyRegistered" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L50)* ___ @@ -6514,7 +9633,7 @@ ___ • **Cancel**: = "Cancel" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L51)* ___ @@ -6522,7 +9641,7 @@ ___ • **CancelUpTo**: = "CancelUpTo" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L52)* ___ @@ -6530,7 +9649,15 @@ ___ • **Fill**: = "Fill" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:53](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L53)* + +___ + +### OwnershipTransferred + +• **OwnershipTransferred**: = "OwnershipTransferred" + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L54)* ___ @@ -6538,7 +9665,7 @@ ___ • **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L55)* ___ @@ -6546,7 +9673,7 @@ ___ • **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L53)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L56)* ___ @@ -6554,7 +9681,7 @@ ___ • **SignatureValidatorApproval**: = "SignatureValidatorApproval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L54)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L57)* ___ @@ -6562,7 +9689,288 @@ ___ • **TransactionExecution**: = "TransactionExecution" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L58)* + +
+ +# Enumeration: ForwarderEvents + + +## Enumeration members + +### OwnershipTransferred + +• **OwnershipTransferred**: = "OwnershipTransferred" + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:41](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L41)* + +
+ +# Enumeration: ITransformERC20Events + + +## Enumeration members + +### QuoteSignerUpdated + +• **QuoteSignerUpdated**: = "QuoteSignerUpdated" + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L44)* + +___ + +### TransformedERC20 + +• **TransformedERC20**: = "TransformedERC20" + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L45)* + +___ + +### TransformerDeployerUpdated + +• **TransformerDeployerUpdated**: = "TransformerDeployerUpdated" + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L46)* + +
+ +# Enumeration: IZeroExEvents + + +## Enumeration members + +### MetaTransactionExecuted + +• **MetaTransactionExecuted**: = "MetaTransactionExecuted" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:48 + +___ + +### Migrated + +• **Migrated**: = "Migrated" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:49 + +___ + +### OwnershipTransferred + +• **OwnershipTransferred**: = "OwnershipTransferred" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:50 + +___ + +### ProxyFunctionUpdated + +• **ProxyFunctionUpdated**: = "ProxyFunctionUpdated" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:51 + +___ + +### QuoteSignerUpdated + +• **QuoteSignerUpdated**: = "QuoteSignerUpdated" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:52 + +___ + +### TransformedERC20 + +• **TransformedERC20**: = "TransformedERC20" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:53 + +___ + +### TransformerDeployerUpdated + +• **TransformerDeployerUpdated**: = "TransformerDeployerUpdated" + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:54 + +
+ +# Enumeration: StakingEvents + + +## Enumeration members + +### AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:57](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L57)* + +___ + +### AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L58)* + +___ + +### EpochEnded + +• **EpochEnded**: = "EpochEnded" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:59](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L59)* + +___ + +### EpochFinalized + +• **EpochFinalized**: = "EpochFinalized" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:60](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L60)* + +___ + +### ExchangeAdded + +• **ExchangeAdded**: = "ExchangeAdded" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:61](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L61)* + +___ + +### ExchangeRemoved + +• **ExchangeRemoved**: = "ExchangeRemoved" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:62](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L62)* + +___ + +### MakerStakingPoolSet + +• **MakerStakingPoolSet**: = "MakerStakingPoolSet" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L63)* + +___ + +### MoveStake + +• **MoveStake**: = "MoveStake" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:64](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L64)* + +___ + +### OperatorShareDecreased + +• **OperatorShareDecreased**: = "OperatorShareDecreased" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:65](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L65)* + +___ + +### OwnershipTransferred + +• **OwnershipTransferred**: = "OwnershipTransferred" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:66](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L66)* + +___ + +### ParamsSet + +• **ParamsSet**: = "ParamsSet" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:67](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L67)* + +___ + +### RewardsPaid + +• **RewardsPaid**: = "RewardsPaid" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:68](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L68)* + +___ + +### Stake + +• **Stake**: = "Stake" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:69](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L69)* + +___ + +### StakingPoolCreated + +• **StakingPoolCreated**: = "StakingPoolCreated" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:70](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L70)* + +___ + +### StakingPoolEarnedRewardsInEpoch + +• **StakingPoolEarnedRewardsInEpoch**: = "StakingPoolEarnedRewardsInEpoch" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:71](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L71)* + +___ + +### Unstake + +• **Unstake**: = "Unstake" + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:72](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L72)* + +
+ +# Enumeration: StakingProxyEvents + + +## Enumeration members + +### AuthorizedAddressAdded + +• **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L46)* + +___ + +### AuthorizedAddressRemoved + +• **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L47)* + +___ + +### OwnershipTransferred + +• **OwnershipTransferred**: = "OwnershipTransferred" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:48](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L48)* + +___ + +### StakingContractAttachedToProxy + +• **StakingContractAttachedToProxy**: = "StakingContractAttachedToProxy" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L49)* + +___ + +### StakingContractDetachedFromProxy + +• **StakingContractDetachedFromProxy**: = "StakingContractDetachedFromProxy" + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L50)*
@@ -6575,7 +9983,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L45)* ___ @@ -6583,7 +9991,7 @@ ___ • **Deposit**: = "Deposit" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L46)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L46)* ___ @@ -6591,7 +9999,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L45)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L47)* ___ @@ -6599,14 +10007,10 @@ ___ • **Withdrawal**: = "Withdrawal" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L47)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L48)*
- - - - # Enumeration: ContractError @@ -6616,7 +10020,7 @@ ___ • **ContractNotDeployedOnChain**: = "CONTRACT_NOT_DEPLOYED_ON_CHAIN" -*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L16)* +*Defined in [contract-wrappers/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L9)* ___ @@ -6624,7 +10028,7 @@ ___ • **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L26)* +*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L19)* ___ @@ -6632,7 +10036,7 @@ ___ • **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" -*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L25)* +*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L18)* ___ @@ -6640,7 +10044,7 @@ ___ • **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" -*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L17)* +*Defined in [contract-wrappers/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L10)* ___ @@ -6648,7 +10052,7 @@ ___ • **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" -*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L18)* +*Defined in [contract-wrappers/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L11)* ___ @@ -6656,7 +10060,7 @@ ___ • **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" -*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L19)* +*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L12)* ___ @@ -6664,7 +10068,7 @@ ___ • **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" -*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L20)* +*Defined in [contract-wrappers/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L13)* ___ @@ -6672,7 +10076,7 @@ ___ • **InvalidJump**: = "INVALID_JUMP" -*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L21)* +*Defined in [contract-wrappers/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L14)* ___ @@ -6680,7 +10084,7 @@ ___ • **OutOfGas**: = "OUT_OF_GAS" -*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L22)* +*Defined in [contract-wrappers/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L15)* ___ @@ -6688,7 +10092,7 @@ ___ • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L27)* +*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L20)* ___ @@ -6696,7 +10100,7 @@ ___ • **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L24)* +*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L17)* ___ @@ -6704,7 +10108,7 @@ ___ • **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L23)* +*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L16)*
@@ -6717,7 +10121,7 @@ ___ • **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" -*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L12)* +*Defined in [contract-wrappers/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L5)*
@@ -6734,7 +10138,7 @@ ___ • **Earliest**: = "earliest" -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)* +*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L488)* ___ @@ -6742,7 +10146,7 @@ ___ • **Latest**: = "latest" -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)* +*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L489)* ___ @@ -6750,7 +10154,7 @@ ___ • **Pending**: = "pending" -*Defined in [ethereum-types/src/index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)* +*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L490)*
@@ -6782,220 +10186,589 @@ ___ +# Interface: AwaitTransactionSuccessOpts + +Used with `awaitTransactionSuccessAsync` +* pollingIntervalMs: Determine polling intervals in milliseconds +* timeoutMs: Determines timeout in milliseconds -
+## Properties -# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs +### `Optional` pollingIntervalMs +• **pollingIntervalMs**? : *undefined | number* -## Index - -### Properties - -* [coordinatorEndpoint](#coordinatorendpoint) -* [coordinatorOperator](#coordinatoroperator) - -## Properties - -### coordinatorEndpoint - -• **coordinatorEndpoint**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L45)* +*Defined in [base-contract/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L39)* ___ -### coordinatorOperator +### `Optional` shouldValidate -• **coordinatorOperator**: *string* +• **shouldValidate**? : *undefined | false | true* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L44)* +*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* + +*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L30)* + +___ + +### `Optional` timeoutMs + +• **timeoutMs**? : *undefined | number* + +*Defined in [base-contract/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L40)*
-# Interface: DummyERC20TokenApprovalEventArgs +# Interface: ContractEvent <**ContractEventArgs**> + +## Type parameters + +▪ **ContractEventArgs** -## Index +## Properties -### Properties +### address -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) +• **address**: *string* -## Properties - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L45)* +*Defined in [base-contract/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L13)* ___ -### _spender +### args -• **_spender**: *string* +• **args**: *`ContractEventArgs`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L46)* +*Defined in [base-contract/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L16)* ___ -### _value +### blockHash -• **_value**: *`BigNumber`* +• **blockHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L47)* +*Defined in [base-contract/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L11)* + +___ + +### blockNumber + +• **blockNumber**: *number* + +*Defined in [base-contract/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L12)* + +___ + +### event + +• **event**: *string* + +*Defined in [base-contract/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L15)* + +___ + +### logIndex + +• **logIndex**: *number* + +*Defined in [base-contract/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L8)* + +___ + +### transactionHash + +• **transactionHash**: *string* + +*Defined in [base-contract/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L10)* + +___ + +### transactionIndex + +• **transactionIndex**: *number* + +*Defined in [base-contract/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L9)* + +___ + +### type + +• **type**: *string* + +*Defined in [base-contract/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L14)*
-# Interface: DummyERC20TokenTransferEventArgs +# Interface: ContractFunctionObj <**T**> + +## Type parameters + +▪ **T** -## Index +## Methods -### Properties +### callAsync -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -## Properties +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L44)* -### _from +**Parameters:** -• **_from**: *string* +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L51)* +**Returns:** *`Promise`* ___ -### _to +### getABIEncodedTransactionData -• **_to**: *string* +▸ **getABIEncodedTransactionData**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L52)* +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L45)* -___ - -### _value - -• **_value**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L53)* +**Returns:** *string*
-# Interface: DummyERC721TokenApprovalEventArgs +# Interface: ContractTxFunctionObj <**T**> + +## Type parameters + +▪ **T** -## Index +## Methods -### Properties +### awaitTransactionSuccessAsync -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash`* -## Properties +*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L50)* -### _approved +**Parameters:** -• **_approved**: *string* +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L50)* +**Returns:** *`PromiseWithTransactionHash`* ___ -### _owner +### callAsync -• **_owner**: *string* +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L49)* +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[callAsync](#callasync)* + +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L44)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | + +**Returns:** *`Promise`* ___ -### _tokenId +### estimateGasAsync -• **_tokenId**: *`BigNumber`* +▸ **estimateGasAsync**(`txData?`: `Partial`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L51)* +*Defined in [base-contract/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L54)* + +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` | + +**Returns:** *`Promise`* + +___ + +### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[getABIEncodedTransactionData](#getabiencodedtransactiondata)* + +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L45)* + +**Returns:** *string* + +___ + +### sendTransactionAsync + +▸ **sendTransactionAsync**(`txData?`: `Partial`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise`* + +*Defined in [base-contract/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L49)* + +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [SendTransactionOpts](#class-sendtransactionopts) | + +**Returns:** *`Promise`*
-# Interface: DummyERC721TokenApprovalForAllEventArgs +# Interface: SendTransactionOpts + +Used with `sendTransactionAsync` +* shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before +broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true. -## Index +## Properties -### Properties +### `Optional` shouldValidate -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) +• **shouldValidate**? : *undefined | false | true* -## Properties - -### _approved - -• **_approved**: *boolean* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L57)* - -___ - -### _operator - -• **_operator**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L56)* - -___ - -### _owner - -• **_owner**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L55)* +*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L30)*
-# Interface: DummyERC721TokenTransferEventArgs +# Interface: ContractAddresses -## Index +## Properties -### Properties +### assetProxyOwner -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) +• **assetProxyOwner**: *string* -## Properties - -### _from - -• **_from**: *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L61)* +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L10)* ___ -### _to +### balancerBridge -• **_to**: *string* +• **balancerBridge**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L62)* +*Defined in [contract-addresses/src/index.ts:37](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L37)* ___ -### _tokenId +### broker -• **_tokenId**: *`BigNumber`* +• **broker**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L63)* +*Defined in [contract-addresses/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L32)* + +___ + +### chaiBridge + +• **chaiBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L28)* + +___ + +### chainlinkStopLimit + +• **chainlinkStopLimit**: *string* + +*Defined in [contract-addresses/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L33)* + +___ + +### coordinator + +• **coordinator**: *string* + +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L14)* + +___ + +### coordinatorRegistry + +• **coordinatorRegistry**: *string* + +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L13)* + +___ + +### curveBridge + +• **curveBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L30)* + +___ + +### devUtils + +• **devUtils**: *string* + +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L18)* + +___ + +### dexForwarderBridge + +• **dexForwarderBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L35)* + +___ + +### dydxBridge + +• **dydxBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L29)* + +___ + +### erc1155Proxy + +• **erc1155Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L17)* + +___ + +### erc20BridgeProxy + +• **erc20BridgeProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L22)* + +___ + +### erc20BridgeSampler + +• **erc20BridgeSampler**: *string* + +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L23)* + +___ + +### erc20Proxy + +• **erc20Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L4)* + +___ + +### erc721Proxy + +• **erc721Proxy**: *string* + +*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L5)* + +___ + +### eth2DaiBridge + +• **eth2DaiBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L26)* + +___ + +### etherToken + +• **etherToken**: *string* + +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L7)* + +___ + +### exchange + +• **exchange**: *string* + +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L9)* + +___ + +### exchangeProxy + +• **exchangeProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:39](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L39)* + +___ + +### exchangeProxyAllowanceTarget + +• **exchangeProxyAllowanceTarget**: *string* + +*Defined in [contract-addresses/src/index.ts:40](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L40)* + +___ + +### exchangeProxyFlashWallet + +• **exchangeProxyFlashWallet**: *string* + +*Defined in [contract-addresses/src/index.ts:42](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L42)* + +___ + +### exchangeProxyGovernor + +• **exchangeProxyGovernor**: *string* + +*Defined in [contract-addresses/src/index.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L38)* + +___ + +### exchangeProxyTransformerDeployer + +• **exchangeProxyTransformerDeployer**: *string* + +*Defined in [contract-addresses/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L41)* + +___ + +### exchangeV2 + +• **exchangeV2**: *string* + +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L8)* + +___ + +### forwarder + +• **forwarder**: *string* + +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L12)* + +___ + +### godsUnchainedValidator + +• **godsUnchainedValidator**: *string* + +*Defined in [contract-addresses/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L31)* + +___ + +### kyberBridge + +• **kyberBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L27)* + +___ + +### maximumGasPrice + +• **maximumGasPrice**: *string* + +*Defined in [contract-addresses/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L34)* + +___ + +### multiAssetProxy + +• **multiAssetProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L15)* + +___ + +### multiBridge + +• **multiBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:36](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L36)* + +___ + +### staking + +• **staking**: *string* + +*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L20)* + +___ + +### stakingProxy + +• **stakingProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L21)* + +___ + +### staticCallProxy + +• **staticCallProxy**: *string* + +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L16)* + +___ + +### transformers + +• **transformers**: *object* + +*Defined in [contract-addresses/src/index.ts:43](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L43)* + +#### Type declaration: + +___ + +### uniswapBridge + +• **uniswapBridge**: *string* + +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L24)* + +___ + +### uniswapV2Bridge + +• **uniswapV2Bridge**: *string* + +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L25)* + +___ + +### zeroExGovernor + +• **zeroExGovernor**: *string* + +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L11)* + +___ + +### zrxToken + +• **zrxToken**: *string* + +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L6)* + +___ + +### zrxVault + +• **zrxVault**: *string* + +*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L19)*
@@ -7016,7 +10789,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L46)* ___ @@ -7024,7 +10797,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L52)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L47)* ___ @@ -7032,7 +10805,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L53)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L48)*
@@ -7053,7 +10826,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L45)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L52)* ___ @@ -7061,7 +10834,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L46)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L53)* ___ @@ -7069,7 +10842,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L47)* +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L54)*
@@ -7090,7 +10863,7 @@ ___ • **_approved**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L50)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L51)* ___ @@ -7098,7 +10871,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L49)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L50)* ___ @@ -7106,7 +10879,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L51)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L52)*
@@ -7127,7 +10900,7 @@ ___ • **_approved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L57)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L58)* ___ @@ -7135,7 +10908,7 @@ ___ • **_operator**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L56)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L57)* ___ @@ -7143,7 +10916,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L55)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L56)*
@@ -7164,7 +10937,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L62)* ___ @@ -7172,7 +10945,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L62)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L63)* ___ @@ -7180,7 +10953,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L63)* +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:64](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L64)*
@@ -7200,7 +10973,7 @@ ___ • **assetProxy**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L63)* ___ @@ -7208,7 +10981,7 @@ ___ • **id**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L62)*
@@ -7232,7 +11005,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:68](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L68)* ___ @@ -7240,7 +11013,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:67](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L67)* ___ @@ -7248,7 +11021,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:69](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L69)* ___ @@ -7256,7 +11029,7 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L69)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L72)* ___ @@ -7264,7 +11037,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L68)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L71)* ___ @@ -7272,7 +11045,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L67)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L70)*
@@ -7293,7 +11066,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L76)* ___ @@ -7301,7 +11074,7 @@ ___ • **orderEpoch**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L78)* ___ @@ -7309,7 +11082,7 @@ ___ • **orderSenderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L77)*
@@ -7341,7 +11114,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L83)* ___ @@ -7349,7 +11122,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L82)* ___ @@ -7357,7 +11130,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L84)* ___ @@ -7365,7 +11138,7 @@ ___ • **makerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:91](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L91)* ___ @@ -7373,7 +11146,7 @@ ___ • **makerFeeAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L86)* ___ @@ -7381,7 +11154,7 @@ ___ • **makerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L90)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L93)* ___ @@ -7389,7 +11162,7 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L88)* ___ @@ -7397,7 +11170,7 @@ ___ • **protocolFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L95)* ___ @@ -7405,7 +11178,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:90](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L90)* ___ @@ -7413,7 +11186,7 @@ ___ • **takerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L89)* ___ @@ -7421,7 +11194,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L85)* ___ @@ -7429,7 +11202,7 @@ ___ • **takerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L92)* ___ @@ -7437,7 +11210,7 @@ ___ • **takerFeeAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L87)* ___ @@ -7445,7 +11218,35 @@ ___ • **takerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L91)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:94](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L94)* + +
+ +# Interface: ExchangeOwnershipTransferredEventArgs + + +## Index + +### Properties + +* [newOwner](#newowner) +* [previousOwner](#previousowner) + +## Properties + +### newOwner + +• **newOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:100](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L100)* + +___ + +### previousOwner + +• **previousOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L99)*
@@ -7465,7 +11266,7 @@ ___ • **oldProtocolFeeCollector**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L96)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:104](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L104)* ___ @@ -7473,7 +11274,7 @@ ___ • **updatedProtocolFeeCollector**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:105](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L105)*
@@ -7493,7 +11294,7 @@ ___ • **oldProtocolFeeMultiplier**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L101)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:109](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L109)* ___ @@ -7501,7 +11302,7 @@ ___ • **updatedProtocolFeeMultiplier**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L102)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:110](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L110)*
@@ -7522,7 +11323,7 @@ ___ • **isApproved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:108](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L108)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:116](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L116)* ___ @@ -7530,7 +11331,7 @@ ___ • **signerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L106)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:114](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L114)* ___ @@ -7538,7 +11339,7 @@ ___ • **validatorAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L107)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:115](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L115)*
@@ -7557,17 +11358,1054 @@ ___ • **transactionHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)* +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:120](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L120)*
-# Interface: WETH9ApprovalEventArgs +# Interface: ForwarderOwnershipTransferredEventArgs ## Index ### Properties +* [newOwner](#newowner) +* [previousOwner](#previousowner) + +## Properties + +### newOwner + +• **newOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:46](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L46)* + +___ + +### previousOwner + +• **previousOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L45)* + +
+ +# Interface: ITransformERC20QuoteSignerUpdatedEventArgs + + +## Index + +### Properties + +* [quoteSigner](#quotesigner) + +## Properties + +### quoteSigner + +• **quoteSigner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L50)* + +
+ +# Interface: ITransformERC20TransformedERC20EventArgs + + +## Index + +### Properties + +* [inputToken](#inputtoken) +* [inputTokenAmount](#inputtokenamount) +* [outputToken](#outputtoken) +* [outputTokenAmount](#outputtokenamount) +* [taker](#taker) + +## Properties + +### inputToken + +• **inputToken**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:55](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L55)* + +___ + +### inputTokenAmount + +• **inputTokenAmount**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:57](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L57)* + +___ + +### outputToken + +• **outputToken**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:56](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L56)* + +___ + +### outputTokenAmount + +• **outputTokenAmount**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L58)* + +___ + +### taker + +• **taker**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L54)* + +
+ +# Interface: ITransformERC20TransformerDeployerUpdatedEventArgs + + +## Index + +### Properties + +* [transformerDeployer](#transformerdeployer) + +## Properties + +### transformerDeployer + +• **transformerDeployer**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:62](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L62)* + +
+ +# Interface: IZeroExMetaTransactionExecutedEventArgs + + +## Index + +### Properties + +* [hash](#hash) +* [selector](#selector) +* [sender](#sender) +* [signer](#signer) + +## Properties + +### hash + +• **hash**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:58 + +___ + +### selector + +• **selector**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:59 + +___ + +### sender + +• **sender**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:61 + +___ + +### signer + +• **signer**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:60 + +
+ +# Interface: IZeroExMigratedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [migrator](#migrator) +* [newOwner](#newowner) + +## Properties + +### caller + +• **caller**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:65 + +___ + +### migrator + +• **migrator**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:66 + +___ + +### newOwner + +• **newOwner**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:67 + +
+ +# Interface: IZeroExOwnershipTransferredEventArgs + + +## Index + +### Properties + +* [newOwner](#newowner) +* [previousOwner](#previousowner) + +## Properties + +### newOwner + +• **newOwner**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:72 + +___ + +### previousOwner + +• **previousOwner**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:71 + +
+ +# Interface: IZeroExProxyFunctionUpdatedEventArgs + + +## Index + +### Properties + +* [newImpl](#newimpl) +* [oldImpl](#oldimpl) +* [selector](#selector) + +## Properties + +### newImpl + +• **newImpl**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:78 + +___ + +### oldImpl + +• **oldImpl**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:77 + +___ + +### selector + +• **selector**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:76 + +
+ +# Interface: IZeroExQuoteSignerUpdatedEventArgs + + +## Index + +### Properties + +* [quoteSigner](#quotesigner) + +## Properties + +### quoteSigner + +• **quoteSigner**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:82 + +
+ +# Interface: IZeroExTransformedERC20EventArgs + + +## Index + +### Properties + +* [inputToken](#inputtoken) +* [inputTokenAmount](#inputtokenamount) +* [outputToken](#outputtoken) +* [outputTokenAmount](#outputtokenamount) +* [taker](#taker) + +## Properties + +### inputToken + +• **inputToken**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:87 + +___ + +### inputTokenAmount + +• **inputTokenAmount**: *`BigNumber`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:89 + +___ + +### outputToken + +• **outputToken**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:88 + +___ + +### outputTokenAmount + +• **outputTokenAmount**: *`BigNumber`* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:90 + +___ + +### taker + +• **taker**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:86 + +
+ +# Interface: IZeroExTransformerDeployerUpdatedEventArgs + + +## Index + +### Properties + +* [transformerDeployer](#transformerdeployer) + +## Properties + +### transformerDeployer + +• **transformerDeployer**: *string* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:94 + +
+ +# Interface: StakingAuthorizedAddressAddedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:77](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L77)* + +___ + +### target + +• **target**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:76](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L76)* + +
+ +# Interface: StakingAuthorizedAddressRemovedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:82](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L82)* + +___ + +### target + +• **target**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:81](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L81)* + +
+ +# Interface: StakingEpochEndedEventArgs + + +## Index + +### Properties + +* [epoch](#epoch) +* [numPoolsToFinalize](#numpoolstofinalize) +* [rewardsAvailable](#rewardsavailable) +* [totalFeesCollected](#totalfeescollected) +* [totalWeightedStake](#totalweightedstake) + +## Properties + +### epoch + +• **epoch**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:86](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L86)* + +___ + +### numPoolsToFinalize + +• **numPoolsToFinalize**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:87](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L87)* + +___ + +### rewardsAvailable + +• **rewardsAvailable**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:88](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L88)* + +___ + +### totalFeesCollected + +• **totalFeesCollected**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:89](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L89)* + +___ + +### totalWeightedStake + +• **totalWeightedStake**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:90](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L90)* + +
+ +# Interface: StakingEpochFinalizedEventArgs + + +## Index + +### Properties + +* [epoch](#epoch) +* [rewardsPaid](#rewardspaid) +* [rewardsRemaining](#rewardsremaining) + +## Properties + +### epoch + +• **epoch**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:94](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L94)* + +___ + +### rewardsPaid + +• **rewardsPaid**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L95)* + +___ + +### rewardsRemaining + +• **rewardsRemaining**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:96](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L96)* + +
+ +# Interface: StakingExchangeAddedEventArgs + + +## Index + +### Properties + +* [exchangeAddress](#exchangeaddress) + +## Properties + +### exchangeAddress + +• **exchangeAddress**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:100](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L100)* + +
+ +# Interface: StakingExchangeRemovedEventArgs + + +## Index + +### Properties + +* [exchangeAddress](#exchangeaddress) + +## Properties + +### exchangeAddress + +• **exchangeAddress**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:104](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L104)* + +
+ +# Interface: StakingMakerStakingPoolSetEventArgs + + +## Index + +### Properties + +* [makerAddress](#makeraddress) +* [poolId](#poolid) + +## Properties + +### makerAddress + +• **makerAddress**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:108](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L108)* + +___ + +### poolId + +• **poolId**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:109](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L109)* + +
+ +# Interface: StakingMoveStakeEventArgs + + +## Index + +### Properties + +* [amount](#amount) +* [fromPool](#frompool) +* [fromStatus](#fromstatus) +* [staker](#staker) +* [toPool](#topool) +* [toStatus](#tostatus) + +## Properties + +### amount + +• **amount**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:114](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L114)* + +___ + +### fromPool + +• **fromPool**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:116](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L116)* + +___ + +### fromStatus + +• **fromStatus**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:115](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L115)* + +___ + +### staker + +• **staker**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:113](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L113)* + +___ + +### toPool + +• **toPool**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:118](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L118)* + +___ + +### toStatus + +• **toStatus**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:117](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L117)* + +
+ +# Interface: StakingOperatorShareDecreasedEventArgs + + +## Index + +### Properties + +* [newOperatorShare](#newoperatorshare) +* [oldOperatorShare](#oldoperatorshare) +* [poolId](#poolid) + +## Properties + +### newOperatorShare + +• **newOperatorShare**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:124](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L124)* + +___ + +### oldOperatorShare + +• **oldOperatorShare**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:123](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L123)* + +___ + +### poolId + +• **poolId**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:122](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L122)* + +
+ +# Interface: StakingOwnershipTransferredEventArgs + + +## Index + +### Properties + +* [newOwner](#newowner) +* [previousOwner](#previousowner) + +## Properties + +### newOwner + +• **newOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:129](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L129)* + +___ + +### previousOwner + +• **previousOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:128](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L128)* + +
+ +# Interface: StakingParamsSetEventArgs + + +## Index + +### Properties + +* [cobbDouglasAlphaDenominator](#cobbdouglasalphadenominator) +* [cobbDouglasAlphaNumerator](#cobbdouglasalphanumerator) +* [epochDurationInSeconds](#epochdurationinseconds) +* [minimumPoolStake](#minimumpoolstake) +* [rewardDelegatedStakeWeight](#rewarddelegatedstakeweight) + +## Properties + +### cobbDouglasAlphaDenominator + +• **cobbDouglasAlphaDenominator**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:137](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L137)* + +___ + +### cobbDouglasAlphaNumerator + +• **cobbDouglasAlphaNumerator**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L136)* + +___ + +### epochDurationInSeconds + +• **epochDurationInSeconds**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:133](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L133)* + +___ + +### minimumPoolStake + +• **minimumPoolStake**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L135)* + +___ + +### rewardDelegatedStakeWeight + +• **rewardDelegatedStakeWeight**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:134](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L134)* + +
+ +# Interface: StakingRewardsPaidEventArgs + + +## Index + +### Properties + +* [epoch](#epoch) +* [membersReward](#membersreward) +* [operatorReward](#operatorreward) +* [poolId](#poolid) + +## Properties + +### epoch + +• **epoch**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:141](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L141)* + +___ + +### membersReward + +• **membersReward**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:144](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L144)* + +___ + +### operatorReward + +• **operatorReward**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:143](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L143)* + +___ + +### poolId + +• **poolId**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:142](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L142)* + +
+ +# Interface: StakingStakeEventArgs + + +## Index + +### Properties + +* [amount](#amount) +* [staker](#staker) + +## Properties + +### amount + +• **amount**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:149](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L149)* + +___ + +### staker + +• **staker**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:148](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L148)* + +
+ +# Interface: StakingStakingPoolCreatedEventArgs + + +## Index + +### Properties + +* [operator](#operator) +* [operatorShare](#operatorshare) +* [poolId](#poolid) + +## Properties + +### operator + +• **operator**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:154](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L154)* + +___ + +### operatorShare + +• **operatorShare**: *number* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:155](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L155)* + +___ + +### poolId + +• **poolId**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:153](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L153)* + +
+ +# Interface: StakingStakingPoolEarnedRewardsInEpochEventArgs + + +## Index + +### Properties + +* [epoch](#epoch) +* [poolId](#poolid) + +## Properties + +### epoch + +• **epoch**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:159](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L159)* + +___ + +### poolId + +• **poolId**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:160](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L160)* + +
+ +# Interface: StakingUnstakeEventArgs + + +## Index + +### Properties + +* [amount](#amount) +* [staker](#staker) + +## Properties + +### amount + +• **amount**: *`BigNumber`* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:165](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L165)* + +___ + +### staker + +• **staker**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:164](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L164)* + +
+ +# Interface: StakingProxyAuthorizedAddressAddedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:55](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L55)* + +___ + +### target + +• **target**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L54)* + +
+ +# Interface: StakingProxyAuthorizedAddressRemovedEventArgs + + +## Index + +### Properties + +* [caller](#caller) +* [target](#target) + +## Properties + +### caller + +• **caller**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L60)* + +___ + +### target + +• **target**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:59](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L59)* + +
+ +# Interface: StakingProxyOwnershipTransferredEventArgs + + +## Index + +### Properties + +* [newOwner](#newowner) +* [previousOwner](#previousowner) + +## Properties + +### newOwner + +• **newOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:65](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L65)* + +___ + +### previousOwner + +• **previousOwner**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:64](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L64)* + +
+ +# Interface: StakingProxyStakingContractAttachedToProxyEventArgs + + +## Index + +### Properties + +* [newStakingContractAddress](#newstakingcontractaddress) + +## Properties + +### newStakingContractAddress + +• **newStakingContractAddress**: *string* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:69](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L69)* + +
+ +# Interface: StakingProxyStakingContractDetachedFromProxyEventArgs + + +## Hierarchy + +* `DecodedLogArgs` + + * **WETH9ApprovalEventArgs** + + +## Index + +### Properties + * [_owner](#_owner) * [_spender](#_spender) * [_value](#_value) @@ -7578,7 +12416,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L51)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:52](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L52)* ___ @@ -7586,7 +12424,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L52)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:53](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L53)* ___ @@ -7594,7 +12432,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L53)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L54)*
@@ -7614,7 +12452,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L63)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:58](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L58)* ___ @@ -7622,7 +12460,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L64)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L59)*
@@ -7643,7 +12481,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L57)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L63)* ___ @@ -7651,7 +12489,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L58)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:64](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L64)* ___ @@ -7659,7 +12497,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L65)*
@@ -7679,7 +12517,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L68)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L69)* ___ @@ -7687,345 +12525,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)* - -
- -# Interface: AwaitTransactionSuccessOpts - -Used with `awaitTransactionSuccessAsync` -* pollingIntervalMs: Determine polling intervals in milliseconds -* timeoutMs: Determines timeout in milliseconds - - -## Properties - -### `Optional` pollingIntervalMs - -• **pollingIntervalMs**? : *undefined | number* - -*Defined in [base-contract/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L39)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* - -*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L30)* - -___ - -### `Optional` timeoutMs - -• **timeoutMs**? : *undefined | number* - -*Defined in [base-contract/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L40)* - -
- - - -# Interface: ContractFunctionObj <**T**> - -## Type parameters - -▪ **T** - - -## Methods - -### callAsync - -▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData?` | `Partial` | -`defaultBlock?` | [BlockParam](#blockparam) | - -**Returns:** *`Promise`* - -___ - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* - -**Returns:** *string* - -
- -# Interface: ContractTxFunctionObj <**T**> - -## Type parameters - -▪ **T** - - -## Methods - -### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash`* - -*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L50)* - -**Parameters:** - -Name | Type | ------- | ------ | -`txData?` | `Partial` | -`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) | - -**Returns:** *`PromiseWithTransactionHash`* - -___ - -### callAsync - -▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[callAsync](#callasync)* - -*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* - -**Parameters:** - -Name | Type | ------- | ------ | -`callData?` | `Partial` | -`defaultBlock?` | [BlockParam](#blockparam) | - -**Returns:** *`Promise`* - -___ - -### estimateGasAsync - -▸ **estimateGasAsync**(`txData?`: `Partial`): *`Promise`* - -*Defined in [base-contract/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L54)* - -**Parameters:** - -Name | Type | ------- | ------ | -`txData?` | `Partial` | - -**Returns:** *`Promise`* - -___ - -### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[getABIEncodedTransactionData](#getabiencodedtransactiondata)* - -*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* - -**Returns:** *string* - -___ - -### sendTransactionAsync - -▸ **sendTransactionAsync**(`txData?`: `Partial`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise`* - -*Defined in [base-contract/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L49)* - -**Parameters:** - -Name | Type | ------- | ------ | -`txData?` | `Partial` | -`opts?` | [SendTransactionOpts](#class-sendtransactionopts) | - -**Returns:** *`Promise`* - -
- - - -# Interface: ContractAddresses - - -## Properties - -### assetProxyOwner - -• **assetProxyOwner**: *string* - -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)* - -___ - -### coordinator - -• **coordinator**: *string* - -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)* - -___ - -### coordinatorRegistry - -• **coordinatorRegistry**: *string* - -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)* - -___ - -### devUtils - -• **devUtils**: *string* - -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)* - -___ - -### dutchAuction - -• **dutchAuction**: *string* - -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)* - -___ - -### erc1155Proxy - -• **erc1155Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)* - -___ - -### erc20BridgeProxy - -• **erc20BridgeProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)* - -___ - -### erc20Proxy - -• **erc20Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)* - -___ - -### erc721Proxy - -• **erc721Proxy**: *string* - -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)* - -___ - -### etherToken - -• **etherToken**: *string* - -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)* - -___ - -### exchange - -• **exchange**: *string* - -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)* - -___ - -### exchangeV2 - -• **exchangeV2**: *string* - -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)* - -___ - -### forwarder - -• **forwarder**: *string* - -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)* - -___ - -### multiAssetProxy - -• **multiAssetProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)* - -___ - -### orderValidator - -• **orderValidator**: *string* - -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)* - -___ - -### staking - -• **staking**: *string* - -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)* - -___ - -### stakingProxy - -• **stakingProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)* - -___ - -### staticCallProxy - -• **staticCallProxy**: *string* - -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)* - -___ - -### zeroExGovernor - -• **zeroExGovernor**: *string* - -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)* - -___ - -### zrxToken - -• **zrxToken**: *string* - -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)* - -___ - -### zrxVault - -• **zrxVault**: *string* - -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)* +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:70](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L70)*
@@ -8043,7 +12543,7 @@ blockPollingIntervalMs: The interval to use for block polling in event watching • **blockPollingIntervalMs**? : *undefined | number* -*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L40)* +*Defined in [contract-wrappers/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L33)* ___ @@ -8051,7 +12551,7 @@ ___ • **chainId**: *number* -*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L37)* +*Defined in [contract-wrappers/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L30)* ___ @@ -8059,7 +12559,7 @@ ___ • **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* -*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L39)* +*Defined in [contract-wrappers/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L32)* ___ @@ -8067,7 +12567,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L38)* +*Defined in [contract-wrappers/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L31)*
@@ -8079,14 +12579,6 @@ ___ - - - - - - - - # Interface: BlockRange @@ -8096,7 +12588,7 @@ ___ • **fromBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L743)* +*Defined in [ethereum-types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L759)* ___ @@ -8104,7 +12596,7 @@ ___ • **toBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L744)* +*Defined in [ethereum-types/src/index.ts:760](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L760)*
@@ -8123,7 +12615,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)* ___ @@ -8131,7 +12623,7 @@ ___ • **from**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)* +*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L411)* ___ @@ -8141,7 +12633,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)* ___ @@ -8151,7 +12643,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)* ___ @@ -8161,7 +12653,15 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L395)* + +___ + +### `Optional` overrides + +• **overrides**? : *[GethCallOverrides](#class-gethcalloverrides)* + +*Defined in [ethereum-types/src/index.ts:412](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L412)* ___ @@ -8171,7 +12671,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)* ___ @@ -8181,7 +12681,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L391)*
@@ -8198,7 +12698,7 @@ ___ • **name**: *"solc"* -*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L656)* +*Defined in [ethereum-types/src/index.ts:672](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L672)* ___ @@ -8206,7 +12706,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L658)* +*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L674)* ___ @@ -8214,7 +12714,7 @@ ___ • **version**: *string* -*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L657)* +*Defined in [ethereum-types/src/index.ts:673](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L673)*
@@ -8227,7 +12727,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)* +*Defined in [ethereum-types/src/index.ts:706](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L706)* ___ @@ -8235,7 +12735,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)* +*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L708)* ___ @@ -8243,7 +12743,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)* +*Defined in [ethereum-types/src/index.ts:707](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L707)* ___ @@ -8251,7 +12751,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)* +*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L705)* ___ @@ -8259,7 +12759,7 @@ ___ • **outputSelection**: *object* -*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)* +*Defined in [ethereum-types/src/index.ts:713](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L713)* #### Type declaration: @@ -8273,7 +12773,7 @@ ___ • **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)* +*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L704)*
@@ -8286,7 +12786,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)* +*Defined in [ethereum-types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L721)*
@@ -8299,7 +12799,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L103)* ___ @@ -8307,7 +12807,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L104)* ___ @@ -8315,7 +12815,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L105)* ___ @@ -8323,7 +12823,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L102)*
@@ -8348,7 +12848,7 @@ If any of the sources change, the hash would change notifying us that a re-compi • **chains**: *[ContractChains](#class-contractchains)* -*Defined in [ethereum-types/src/index.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L677)* +*Defined in [ethereum-types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L693)* ___ @@ -8358,7 +12858,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L658)* ___ @@ -8368,7 +12868,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* -*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* +*Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L668)* ___ @@ -8376,7 +12876,7 @@ ___ • **contractName**: *string* -*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L676)* +*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L692)* ___ @@ -8384,7 +12884,7 @@ ___ • **schemaVersion**: *string* -*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L675)* +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L691)* ___ @@ -8394,7 +12894,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* +*Defined in [ethereum-types/src/index.ts:664](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L664)* #### Type declaration: @@ -8408,7 +12908,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* +*Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L667)* ___ @@ -8418,7 +12918,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* +*Defined in [ethereum-types/src/index.ts:659](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L659)* #### Type declaration: @@ -8435,7 +12935,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L555)* +*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L564)* ___ @@ -8443,7 +12943,7 @@ Args • **constructorArgs**: *string* -*Defined in [ethereum-types/src/index.ts:559](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L559)* +*Defined in [ethereum-types/src/index.ts:568](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L568)* ___ @@ -8451,7 +12951,7 @@ ___ • **links**: *object* -*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L556)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L565)* #### Type declaration: @@ -8475,7 +12975,7 @@ ___ • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L658)* ___ @@ -8483,7 +12983,7 @@ ___ • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* +*Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L668)* ___ @@ -8491,7 +12991,7 @@ ___ • **sourceCodes**: *object* -*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* +*Defined in [ethereum-types/src/index.ts:664](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L664)* #### Type declaration: @@ -8503,7 +13003,7 @@ ___ • **sourceTreeHashHex**: *string* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* +*Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L667)* ___ @@ -8511,7 +13011,7 @@ ___ • **sources**: *object* -*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* +*Defined in [ethereum-types/src/index.ts:659](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L659)* #### Type declaration: @@ -8528,7 +13028,7 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L138)* ___ @@ -8536,7 +13036,7 @@ ___ • **internalType**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L137)* ___ @@ -8544,7 +13044,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L135)* ___ @@ -8552,7 +13052,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L136)*
@@ -8572,7 +13072,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)* ___ @@ -8580,7 +13080,7 @@ ___ • **args**: *`A`* -*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* +*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)* ___ @@ -8590,7 +13090,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)* ___ @@ -8600,7 +13100,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)* ___ @@ -8610,7 +13110,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)* ___ @@ -8618,7 +13118,7 @@ ___ • **event**: *string* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)* ___ @@ -8628,7 +13128,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)* ___ @@ -8638,7 +13138,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)* ___ @@ -8648,7 +13148,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)* ___ @@ -8658,7 +13158,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
@@ -8677,7 +13177,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)* ___ @@ -8687,7 +13187,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* +*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)* ___ @@ -8697,7 +13197,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)* ___ @@ -8707,7 +13207,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)* ___ @@ -8717,7 +13217,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)* ___ @@ -8727,7 +13227,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)* ___ @@ -8737,7 +13237,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)* ___ @@ -8745,7 +13245,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L422)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L431)* ___ @@ -8755,7 +13255,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)* ___ @@ -8765,7 +13265,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)* ___ @@ -8775,7 +13275,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
@@ -8788,7 +13288,7 @@ ___ • **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)* +*Defined in [ethereum-types/src/index.ts:645](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L645)* ___ @@ -8796,7 +13296,7 @@ ___ • **methods**: *object* -*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)* +*Defined in [ethereum-types/src/index.ts:646](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L646)* #### Type declaration: @@ -8808,7 +13308,7 @@ ___ • **title**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)* +*Defined in [ethereum-types/src/index.ts:644](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L644)*
@@ -8821,7 +13321,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -8829,7 +13329,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -8853,7 +13353,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -8875,11 +13375,19 @@ Name | Type | ## Properties +### linkReferences + +• **linkReferences**: *[EvmBytecodeOutputLinkReferences](#class-evmbytecodeoutputlinkreferences)* + +*Defined in [ethereum-types/src/index.ts:632](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L632)* + +___ + ### object • **object**: *string* -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)* +*Defined in [ethereum-types/src/index.ts:633](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L633)* ___ @@ -8887,20 +13395,25 @@ ___ • **sourceMap**: *string* -*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)* +*Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L634)*
-# Interface: EvmOutput +# Interface: EvmBytecodeOutputLinkReferences -## Properties +## Hierarchy + +* **EvmOutput** + + +## Properties ### bytecode • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)* +*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L627)* ___ @@ -8908,7 +13421,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)* +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L628)*
@@ -8921,7 +13434,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L112)* ___ @@ -8929,7 +13442,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L111)*
@@ -8944,7 +13457,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -8959,16 +13472,21 @@ Name | Type | -# Interface: JSONRPCRequestPayload +# Interface: GethCallOverrides -## Properties +## Hierarchy + +* **JSONRPCRequestPayload** + + +## Properties ### id • **id**: *number* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L331)* ___ @@ -8976,7 +13494,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L332)* ___ @@ -8984,7 +13502,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L330)* ___ @@ -8992,7 +13510,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L329)*
@@ -9005,7 +13523,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L337)* ___ @@ -9013,7 +13531,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L336)*
@@ -9026,7 +13544,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L344)* ___ @@ -9034,7 +13552,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L342)* ___ @@ -9042,7 +13560,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L343)* ___ @@ -9050,7 +13568,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L341)*
@@ -9063,7 +13581,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)* ___ @@ -9071,7 +13589,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)* ___ @@ -9079,7 +13597,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)* ___ @@ -9087,7 +13605,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)* ___ @@ -9095,7 +13613,7 @@ ___ • **logIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)* ___ @@ -9103,7 +13621,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)* ___ @@ -9111,7 +13629,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)* ___ @@ -9119,7 +13637,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
@@ -9134,7 +13652,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)* ___ @@ -9144,7 +13662,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)* ___ @@ -9154,7 +13672,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)* ___ @@ -9164,7 +13682,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)* ___ @@ -9174,7 +13692,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)* ___ @@ -9182,7 +13700,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L426)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L435)* ___ @@ -9192,7 +13710,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)* ___ @@ -9202,7 +13720,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)* ___ @@ -9212,7 +13730,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
@@ -9231,7 +13749,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)* ___ @@ -9241,7 +13759,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* +*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)* ___ @@ -9251,7 +13769,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)* ___ @@ -9261,7 +13779,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)* ___ @@ -9271,7 +13789,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)* ___ @@ -9281,7 +13799,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)* ___ @@ -9291,7 +13809,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)* ___ @@ -9301,7 +13819,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)* ___ @@ -9311,7 +13829,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)* ___ @@ -9321,7 +13839,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
@@ -9330,11 +13848,11 @@ ___ ## Properties -### constant +### `Optional` constant -• **constant**: *boolean* +• **constant**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L94)* ___ @@ -9342,7 +13860,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L92)* ___ @@ -9350,7 +13868,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L91)* ___ @@ -9358,15 +13876,15 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L93)* ___ -### payable +### `Optional` payable -• **payable**: *boolean* +• **payable**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L96)* ___ @@ -9374,7 +13892,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L95)* ___ @@ -9382,7 +13900,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L90)*
@@ -9395,7 +13913,7 @@ ___ • **enabled**: *boolean* -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)* +*Defined in [ethereum-types/src/index.ts:725](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L725)* ___ @@ -9403,7 +13921,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)* +*Defined in [ethereum-types/src/index.ts:726](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L726)*
@@ -9420,7 +13938,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L122)* ___ @@ -9428,7 +13946,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L121)* ___ @@ -9436,391 +13954,12 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L120)*
-# Class: CoordinatorContract -## Constructors - - - -\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1163)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode | - -**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* - -## Properties - -### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:32 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -## Methods - -### EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH - -▸ **EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:483](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L483)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### EIP712_COORDINATOR_DOMAIN_HASH - -▸ **EIP712_COORDINATOR_DOMAIN_HASH**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:533](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L533)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### EIP712_COORDINATOR_DOMAIN_NAME - -▸ **EIP712_COORDINATOR_DOMAIN_NAME**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:580](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L580)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### EIP712_COORDINATOR_DOMAIN_VERSION - -▸ **EIP712_COORDINATOR_DOMAIN_VERSION**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:627](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L627)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### EIP712_EXCHANGE_DOMAIN_HASH - -▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L677)* - -**Returns:** *`ContractFunctionObj`* - -___ - -### assertValidCoordinatorApprovals - -▸ **assertValidCoordinatorApprovals**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L736)* - -Validates that the 0x transaction has been approved by all of the feeRecipients -that correspond to each order in the transaction's Exchange calldata. - -**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. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *`ContractFunctionObj`* - -___ - -### decodeOrdersFromFillData - -▸ **decodeOrdersFromFillData**(`data`: string): *`ContractFunctionObj>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:811](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L811)* - -Decodes the orders from Exchange calldata representing any fill method. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`data` | string | Exchange calldata representing a fill method. | - -**Returns:** *`ContractFunctionObj>`* - -orders The orders from the Exchange calldata. - -___ - -### executeTransaction - -▸ **executeTransaction**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractTxFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:919](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L919)* - -Executes a 0x transaction that has been signed by the feeRecipients that correspond to -each order in the transaction's Exchange calldata. - -**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. | -`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | - -**Returns:** *`ContractTxFunctionObj`* - -___ - -### getABIDecodedReturnData - -▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L469)* - -**Type parameters:** - -▪ **T** - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | -`callData` | string | - -**Returns:** *`T`* - -___ - -### getABIDecodedTransactionData - -▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:462](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L462)* - -**Type parameters:** - -▪ **T** - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | -`callData` | string | - -**Returns:** *`T`* - -___ - -### getCoordinatorApprovalHash - -▸ **getCoordinatorApprovalHash**(`approval`: object): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1060](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1060)* - -Calculates the EIP712 hash of the Coordinator approval mesasage using the domain -separator of this contract. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`approval` | object | Coordinator approval message containing the transaction hash, and transaction signature. | - -**Returns:** *`ContractFunctionObj`* - -approvalHash EIP712 hash of the Coordinator approval message with the domain separator of this contract. - -___ - -### getFunctionSignature - -▸ **getFunctionSignature**(`methodName`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L456)* - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | - -**Returns:** *string* - -___ - -### getSelector - -▸ **getSelector**(`methodName`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L476)* - -**Parameters:** - -Name | Type | ------- | ------ | -`methodName` | string | - -**Returns:** *string* - -___ - -### getSignerAddress - -▸ **getSignerAddress**(`hash`: string, `signature`: string): *`ContractFunctionObj`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1122)* - -Recovers the address of a signer given a hash and signature. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32 byte hash. | -`signature` | string | Proof that the hash has been signed by signer. | - -**Returns:** *`ContractFunctionObj`* - -signerAddress Address of the signer. - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L128)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L80)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`exchange` | string | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L45)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`exchange` | string | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:42 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -
- @@ -9834,7 +13973,7 @@ Name | Type | • **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)* +*Defined in [ethereum-types/src/index.ts:574](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L574)* ___ @@ -9842,7 +13981,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)* +*Defined in [ethereum-types/src/index.ts:576](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L576)* ___ @@ -9850,7 +13989,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)* +*Defined in [ethereum-types/src/index.ts:575](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L575)*
@@ -9879,7 +14018,7 @@ ___ *Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L142)* ___ @@ -9889,7 +14028,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L137)* ___ @@ -9899,7 +14038,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L135)* ___ @@ -9909,7 +14048,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L136)*
@@ -9924,7 +14063,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)* ___ @@ -9932,7 +14071,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L399)* ___ @@ -9942,7 +14081,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)* ___ @@ -9952,7 +14091,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)* ___ @@ -9962,7 +14101,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L395)* ___ @@ -9972,7 +14111,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)* ___ @@ -9982,7 +14121,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L391)*
@@ -9997,7 +14136,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)* ___ @@ -10007,7 +14146,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L399)* ___ @@ -10017,7 +14156,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)* ___ @@ -10027,7 +14166,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)* ___ @@ -10037,7 +14176,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L395)* ___ @@ -10047,7 +14186,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)* ___ @@ -10057,7 +14196,7 @@ ___ *Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)* +*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L452)*
@@ -10074,7 +14213,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -10090,7 +14229,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -10116,7 +14255,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -10142,7 +14281,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -10168,7 +14307,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L31)* ___ @@ -10176,7 +14315,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L32)* ___ @@ -10184,7 +14323,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -10192,7 +14331,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -10202,7 +14341,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -10219,7 +14358,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -10258,7 +14397,7 @@ ___ • **isRemoved**: *boolean* -*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L844)* +*Defined in [types/src/index.ts:872](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L872)* ___ @@ -10266,7 +14405,7 @@ ___ • **log**: *`LogWithDecodedArgs`* -*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L845)* +*Defined in [types/src/index.ts:873](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L873)*
@@ -10293,6 +14432,10 @@ ___ + + + + @@ -10318,7 +14461,7 @@ ___ • **keyName**: *string* -*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L691)* +*Defined in [types/src/index.ts:719](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L719)* ___ @@ -10326,7 +14469,7 @@ ___ • **keyType**: *[Type](#class-type)* -*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L692)* +*Defined in [types/src/index.ts:720](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L720)* ___ @@ -10334,7 +14477,7 @@ ___ • **valueName**: *string* -*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L693)* +*Defined in [types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L721)*
@@ -10397,7 +14540,7 @@ ___ • **chains**: *`ContractChains`* -*Defined in [types/src/index.ts:861](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L861)* +*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L889)* ___ @@ -10405,7 +14548,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:860](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L860)* +*Defined in [types/src/index.ts:888](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L888)* ___ @@ -10413,7 +14556,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:859](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L859)* +*Defined in [types/src/index.ts:887](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L887)* ___ @@ -10421,7 +14564,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:858](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L858)* +*Defined in [types/src/index.ts:886](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L886)*
@@ -10434,7 +14577,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:875](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L875)* +*Defined in [types/src/index.ts:903](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L903)*
@@ -10447,7 +14590,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:871](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L871)* +*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L899)*
@@ -10460,7 +14603,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:865](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L865)* +*Defined in [types/src/index.ts:893](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L893)* ___ @@ -10468,7 +14611,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L867)* +*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L895)* ___ @@ -10476,7 +14619,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:866](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L866)* +*Defined in [types/src/index.ts:894](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L894)*
@@ -10515,165 +14658,6 @@ ___ - - - - -## Type aliases - - - - - - - - - - - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L848)* - -#### Type declaration: - -▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`err` | null \| `Error` | -`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | - -___ - - - - - - - - - - - - - -
- - - - -## Type aliases - -### CoordinatorRegistryEventArgs - -Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* - -
- - - -
- - - - -## Type aliases - -### DummyERC20TokenEventArgs - -Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs) | [DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* - -
- - - - -## Type aliases - -### DummyERC721TokenEventArgs - -Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L37)* - -
- - - - -## Type aliases - -### ERC20TokenEventArgs - -Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* - -
- - - - -## Type aliases - -### ERC721TokenEventArgs - -Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L37)* - -
- - - - -## Type aliases - -### ExchangeEventArgs - -Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L37)* - -
- - - -
- - - -
- - - -
- - - -
- - - - -## Type aliases - -### WETH9EventArgs - -Ƭ **WETH9EventArgs**: *[WETH9ApprovalEventArgs](#interface-weth9approvaleventargs) | [WETH9TransferEventArgs](#interface-weth9transfereventargs) | [WETH9DepositEventArgs](#interface-weth9depositeventargs) | [WETH9WithdrawalEventArgs](#interface-weth9withdrawaleventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)* - -
@@ -10691,7 +14675,7 @@ ___ ▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)* +*Defined in [contract-addresses/src/index.ts:67](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L67)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -10720,6 +14704,143 @@ given chainId. +
+ + + +
+ + + + +## Type aliases + +### ERC20TokenEventArgs + +Ƭ **ERC20TokenEventArgs**: *[ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs) | [ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L38)* + +
+ + + + +## Type aliases + +### ERC721TokenEventArgs + +Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/erc721_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L38)* + +
+ + + + +## Type aliases + +### ExchangeEventArgs + +Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeOwnershipTransferredEventArgs](#interface-exchangeownershiptransferredeventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/exchange.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L38)* + +
+ + + + +## Type aliases + +### ForwarderEventArgs + +Ƭ **ForwarderEventArgs**: *[ForwarderOwnershipTransferredEventArgs](#interface-forwarderownershiptransferredeventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/forwarder.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L38)* + +
+ + + +
+ + + +
+ + + + +## Type aliases + +### ITransformERC20EventArgs + +Ƭ **ITransformERC20EventArgs**: *[ITransformERC20QuoteSignerUpdatedEventArgs](#interface-itransformerc20quotesignerupdatedeventargs) | [ITransformERC20TransformedERC20EventArgs](#interface-itransformerc20transformederc20eventargs) | [ITransformERC20TransformerDeployerUpdatedEventArgs](#interface-itransformerc20transformerdeployerupdatedeventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/i_transform_erc20.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/i_transform_erc20.ts#L38)* + +
+ + + + +## Type aliases + +### IZeroExEventArgs + +Ƭ **IZeroExEventArgs**: *[IZeroExMetaTransactionExecutedEventArgs](#interface-izeroexmetatransactionexecutedeventargs) | [IZeroExMigratedEventArgs](#interface-izeroexmigratedeventargs) | [IZeroExOwnershipTransferredEventArgs](#interface-izeroexownershiptransferredeventargs) | [IZeroExProxyFunctionUpdatedEventArgs](#interface-izeroexproxyfunctionupdatedeventargs) | [IZeroExQuoteSignerUpdatedEventArgs](#interface-izeroexquotesignerupdatedeventargs) | [IZeroExTransformedERC20EventArgs](#interface-izeroextransformederc20eventargs) | [IZeroExTransformerDeployerUpdatedEventArgs](#interface-izeroextransformerdeployerupdatedeventargs)* + +Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:38 + +
+ + + + +## Type aliases + +### StakingEventArgs + +Ƭ **StakingEventArgs**: *[StakingAuthorizedAddressAddedEventArgs](#interface-stakingauthorizedaddressaddedeventargs) | [StakingAuthorizedAddressRemovedEventArgs](#interface-stakingauthorizedaddressremovedeventargs) | [StakingEpochEndedEventArgs](#interface-stakingepochendedeventargs) | [StakingEpochFinalizedEventArgs](#interface-stakingepochfinalizedeventargs) | [StakingExchangeAddedEventArgs](#interface-stakingexchangeaddedeventargs) | [StakingExchangeRemovedEventArgs](#interface-stakingexchangeremovedeventargs) | [StakingMakerStakingPoolSetEventArgs](#interface-stakingmakerstakingpoolseteventargs) | [StakingMoveStakeEventArgs](#interface-stakingmovestakeeventargs) | [StakingOperatorShareDecreasedEventArgs](#interface-stakingoperatorsharedecreasedeventargs) | [StakingOwnershipTransferredEventArgs](#interface-stakingownershiptransferredeventargs) | [StakingParamsSetEventArgs](#interface-stakingparamsseteventargs) | [StakingRewardsPaidEventArgs](#interface-stakingrewardspaideventargs) | [StakingStakeEventArgs](#interface-stakingstakeeventargs) | [StakingStakingPoolCreatedEventArgs](#interface-stakingstakingpoolcreatedeventargs) | [StakingStakingPoolEarnedRewardsInEpochEventArgs](#interface-stakingstakingpoolearnedrewardsinepocheventargs) | [StakingUnstakeEventArgs](#interface-stakingunstakeeventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/staking.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking.ts#L38)* + +
+ + + + +## Type aliases + +### StakingProxyEventArgs + +Ƭ **StakingProxyEventArgs**: *[StakingProxyAuthorizedAddressAddedEventArgs](#interface-stakingproxyauthorizedaddressaddedeventargs) | [StakingProxyAuthorizedAddressRemovedEventArgs](#interface-stakingproxyauthorizedaddressremovedeventargs) | [StakingProxyOwnershipTransferredEventArgs](#interface-stakingproxyownershiptransferredeventargs) | [StakingProxyStakingContractAttachedToProxyEventArgs](#interface-stakingproxystakingcontractattachedtoproxyeventargs) | [StakingProxyStakingContractDetachedFromProxyEventArgs](#interface-stakingproxystakingcontractdetachedfromproxyeventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/staking_proxy.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/staking_proxy.ts#L38)* + +
+ + + + +## Type aliases + +### WETH9EventArgs + +Ƭ **WETH9EventArgs**: *[WETH9ApprovalEventArgs](#interface-weth9approvaleventargs) | [WETH9DepositEventArgs](#interface-weth9depositeventargs) | [WETH9TransferEventArgs](#interface-weth9transfereventargs) | [WETH9WithdrawalEventArgs](#interface-weth9withdrawaleventargs)* + +*Defined in [contract-wrappers/src/generated-wrappers/weth9.ts:38](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L38)* + +
+ + + +
+ + + ## Type aliases @@ -10727,7 +14848,7 @@ given chainId. Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L80)* ___ @@ -10735,7 +14856,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)* +*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L493)* ___ @@ -10743,7 +14864,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L84)* ___ @@ -10751,7 +14872,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L78)* ___ @@ -10759,7 +14880,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)* +*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L478)* ___ @@ -10769,7 +14890,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -10784,7 +14905,7 @@ ___ Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)* -*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L82)* ___ @@ -10792,7 +14913,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -10813,7 +14934,7 @@ ___ Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"* -*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)* +*Defined in [ethereum-types/src/index.ts:535](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L535)* ___ @@ -10821,7 +14942,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)* +*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L571)* ___ @@ -10829,7 +14950,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [ethereum-types/src/index.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L476)* +*Defined in [ethereum-types/src/index.ts:485](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L485)* ___ @@ -10837,7 +14958,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L85)* ___ @@ -10845,7 +14966,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -10860,7 +14981,55 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L11)*
+ + + +## Type aliases + + + + + + + + + + + +### EventCallback + +Ƭ **EventCallback**: *function* + +*Defined in [types/src/index.ts:876](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L876)* + +#### Type declaration: + +▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`err` | null \| `Error` | +`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | + +___ + + + + + + + + + + + + + +
+ diff --git a/packages/contract-wrappers/package.json b/packages/contract-wrappers/package.json index a668f10f8e..9e209e2964 100644 --- a/packages/contract-wrappers/package.json +++ b/packages/contract-wrappers/package.json @@ -32,7 +32,7 @@ "wrappers:generate": "abi-gen --abis ${npm_package_config_abis} --output src/generated-wrappers --backend ethers" }, "config": { - "abis": "../contract-artifacts/artifacts/@(DevUtils|ERC20Token|ERC721Token|Exchange|Forwarder|IAssetData|LibTransactionDecoder|WETH9|Coordinator|Staking|StakingProxy|IERC20BridgeSampler|ERC20BridgeSampler|GodsUnchainedValidator|Broker|ILiquidityProvider|ILiquidityProviderRegistry|MaximumGasPrice|ITransformERC20).json" + "abis": "../contract-artifacts/artifacts/@(DevUtils|ERC20Token|ERC721Token|Exchange|Forwarder|IAssetData|LibTransactionDecoder|WETH9|Coordinator|Staking|StakingProxy|IERC20BridgeSampler|ERC20BridgeSampler|GodsUnchainedValidator|Broker|ILiquidityProvider|ILiquidityProviderRegistry|MaximumGasPrice|ITransformERC20|IZeroEx).json" }, "gitpkg": { "registry": "git@github.com:0xProject/gitpkg-registry.git" diff --git a/packages/contract-wrappers/src/generated-wrappers/i_zero_ex.ts b/packages/contract-wrappers/src/generated-wrappers/i_zero_ex.ts new file mode 100644 index 0000000000..94ffa18680 --- /dev/null +++ b/packages/contract-wrappers/src/generated-wrappers/i_zero_ex.ts @@ -0,0 +1,2815 @@ +// tslint:disable:no-consecutive-blank-lines ordered-imports align trailing-comma enum-naming +// tslint:disable:whitespace no-unbound-method no-trailing-whitespace +// tslint:disable:no-unused-variable +import { + AwaitTransactionSuccessOpts, + ContractFunctionObj, + ContractTxFunctionObj, + SendTransactionOpts, + BaseContract, + SubscriptionManager, + PromiseWithTransactionHash, + methodAbiToFunctionSignature, + linkLibrariesInBytecode, +} from '@0x/base-contract'; +import { schemas } from '@0x/json-schemas'; +import { + BlockParam, + BlockParamLiteral, + BlockRange, + CallData, + ContractAbi, + ContractArtifact, + DecodedLogArgs, + LogWithDecodedArgs, + MethodAbi, + TransactionReceiptWithDecodedLogs, + TxData, + TxDataPayable, + SupportedProvider, +} from 'ethereum-types'; +import { BigNumber, classUtils, hexUtils, logUtils, providerUtils } from '@0x/utils'; +import { EventCallback, IndexedFilterValues, SimpleContractArtifact } from '@0x/types'; +import { Web3Wrapper } from '@0x/web3-wrapper'; +import { assert } from '@0x/assert'; +import * as ethers from 'ethers'; +// tslint:enable:no-unused-variable + +export type IZeroExEventArgs = + | IZeroExMetaTransactionExecutedEventArgs + | IZeroExMigratedEventArgs + | IZeroExOwnershipTransferredEventArgs + | IZeroExProxyFunctionUpdatedEventArgs + | IZeroExQuoteSignerUpdatedEventArgs + | IZeroExTransformedERC20EventArgs + | IZeroExTransformerDeployerUpdatedEventArgs; + +export enum IZeroExEvents { + MetaTransactionExecuted = 'MetaTransactionExecuted', + Migrated = 'Migrated', + OwnershipTransferred = 'OwnershipTransferred', + ProxyFunctionUpdated = 'ProxyFunctionUpdated', + QuoteSignerUpdated = 'QuoteSignerUpdated', + TransformedERC20 = 'TransformedERC20', + TransformerDeployerUpdated = 'TransformerDeployerUpdated', +} + +export interface IZeroExMetaTransactionExecutedEventArgs extends DecodedLogArgs { + hash: string; + selector: string; + signer: string; + sender: string; +} + +export interface IZeroExMigratedEventArgs extends DecodedLogArgs { + caller: string; + migrator: string; + newOwner: string; +} + +export interface IZeroExOwnershipTransferredEventArgs extends DecodedLogArgs { + previousOwner: string; + newOwner: string; +} + +export interface IZeroExProxyFunctionUpdatedEventArgs extends DecodedLogArgs { + selector: string; + oldImpl: string; + newImpl: string; +} + +export interface IZeroExQuoteSignerUpdatedEventArgs extends DecodedLogArgs { + quoteSigner: string; +} + +export interface IZeroExTransformedERC20EventArgs extends DecodedLogArgs { + taker: string; + inputToken: string; + outputToken: string; + inputTokenAmount: BigNumber; + outputTokenAmount: BigNumber; +} + +export interface IZeroExTransformerDeployerUpdatedEventArgs extends DecodedLogArgs { + transformerDeployer: string; +} + +/* istanbul ignore next */ +// tslint:disable:array-type +// tslint:disable:no-parameter-reassignment +// tslint:disable-next-line:class-name +export class IZeroExContract extends BaseContract { + /** + * @ignore + */ + public static deployedBytecode: string | undefined; + public static contractName = 'IZeroEx'; + private readonly _methodABIIndex: { [name: string]: number } = {}; + private readonly _subscriptionManager: SubscriptionManager; + public static async deployFrom0xArtifactAsync( + artifact: ContractArtifact | SimpleContractArtifact, + supportedProvider: SupportedProvider, + txDefaults: Partial, + logDecodeDependencies: { [contractName: string]: ContractArtifact | SimpleContractArtifact }, + ): Promise { + assert.doesConformToSchema('txDefaults', txDefaults, schemas.txDataSchema, [ + schemas.addressSchema, + schemas.numberSchema, + schemas.jsNumber, + ]); + if (artifact.compilerOutput === undefined) { + throw new Error('Compiler output not found in the artifact file'); + } + const provider = providerUtils.standardizeOrThrow(supportedProvider); + const bytecode = artifact.compilerOutput.evm.bytecode.object; + const abi = artifact.compilerOutput.abi; + const logDecodeDependenciesAbiOnly: { [contractName: string]: ContractAbi } = {}; + if (Object.keys(logDecodeDependencies) !== undefined) { + for (const key of Object.keys(logDecodeDependencies)) { + logDecodeDependenciesAbiOnly[key] = logDecodeDependencies[key].compilerOutput.abi; + } + } + return IZeroExContract.deployAsync(bytecode, abi, provider, txDefaults, logDecodeDependenciesAbiOnly); + } + + public static async deployWithLibrariesFrom0xArtifactAsync( + artifact: ContractArtifact, + libraryArtifacts: { [libraryName: string]: ContractArtifact }, + supportedProvider: SupportedProvider, + txDefaults: Partial, + logDecodeDependencies: { [contractName: string]: ContractArtifact | SimpleContractArtifact }, + ): Promise { + assert.doesConformToSchema('txDefaults', txDefaults, schemas.txDataSchema, [ + schemas.addressSchema, + schemas.numberSchema, + schemas.jsNumber, + ]); + if (artifact.compilerOutput === undefined) { + throw new Error('Compiler output not found in the artifact file'); + } + const provider = providerUtils.standardizeOrThrow(supportedProvider); + const abi = artifact.compilerOutput.abi; + const logDecodeDependenciesAbiOnly: { [contractName: string]: ContractAbi } = {}; + if (Object.keys(logDecodeDependencies) !== undefined) { + for (const key of Object.keys(logDecodeDependencies)) { + logDecodeDependenciesAbiOnly[key] = logDecodeDependencies[key].compilerOutput.abi; + } + } + const libraryAddresses = await IZeroExContract._deployLibrariesAsync( + artifact, + libraryArtifacts, + new Web3Wrapper(provider), + txDefaults, + ); + const bytecode = linkLibrariesInBytecode(artifact, libraryAddresses); + return IZeroExContract.deployAsync(bytecode, abi, provider, txDefaults, logDecodeDependenciesAbiOnly); + } + + public static async deployAsync( + bytecode: string, + abi: ContractAbi, + supportedProvider: SupportedProvider, + txDefaults: Partial, + logDecodeDependencies: { [contractName: string]: ContractAbi }, + ): Promise { + assert.isHexString('bytecode', bytecode); + assert.doesConformToSchema('txDefaults', txDefaults, schemas.txDataSchema, [ + schemas.addressSchema, + schemas.numberSchema, + schemas.jsNumber, + ]); + const provider = providerUtils.standardizeOrThrow(supportedProvider); + const constructorAbi = BaseContract._lookupConstructorAbi(abi); + [] = BaseContract._formatABIDataItemList(constructorAbi.inputs, [], BaseContract._bigNumberToString); + const iface = new ethers.utils.Interface(abi); + const deployInfo = iface.deployFunction; + const txData = deployInfo.encode(bytecode, []); + const web3Wrapper = new Web3Wrapper(provider); + const txDataWithDefaults = await BaseContract._applyDefaultsToContractTxDataAsync( + { + data: txData, + ...txDefaults, + }, + web3Wrapper.estimateGasAsync.bind(web3Wrapper), + ); + const txHash = await web3Wrapper.sendTransactionAsync(txDataWithDefaults); + logUtils.log(`transactionHash: ${txHash}`); + const txReceipt = await web3Wrapper.awaitTransactionSuccessAsync(txHash); + logUtils.log(`IZeroEx successfully deployed at ${txReceipt.contractAddress}`); + const contractInstance = new IZeroExContract( + txReceipt.contractAddress as string, + provider, + txDefaults, + logDecodeDependencies, + ); + contractInstance.constructorArgs = []; + return contractInstance; + } + + /** + * @returns The contract ABI + */ + public static ABI(): ContractAbi { + const abi = [ + { + anonymous: false, + inputs: [ + { + name: 'hash', + type: 'bytes32', + indexed: false, + }, + { + name: 'selector', + type: 'bytes4', + indexed: true, + }, + { + name: 'signer', + type: 'address', + indexed: false, + }, + { + name: 'sender', + type: 'address', + indexed: false, + }, + ], + name: 'MetaTransactionExecuted', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'caller', + type: 'address', + indexed: false, + }, + { + name: 'migrator', + type: 'address', + indexed: false, + }, + { + name: 'newOwner', + type: 'address', + indexed: false, + }, + ], + name: 'Migrated', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'previousOwner', + type: 'address', + indexed: true, + }, + { + name: 'newOwner', + type: 'address', + indexed: true, + }, + ], + name: 'OwnershipTransferred', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'selector', + type: 'bytes4', + indexed: true, + }, + { + name: 'oldImpl', + type: 'address', + indexed: false, + }, + { + name: 'newImpl', + type: 'address', + indexed: false, + }, + ], + name: 'ProxyFunctionUpdated', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'quoteSigner', + type: 'address', + indexed: false, + }, + ], + name: 'QuoteSignerUpdated', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'taker', + type: 'address', + indexed: true, + }, + { + name: 'inputToken', + type: 'address', + indexed: false, + }, + { + name: 'outputToken', + type: 'address', + indexed: false, + }, + { + name: 'inputTokenAmount', + type: 'uint256', + indexed: false, + }, + { + name: 'outputTokenAmount', + type: 'uint256', + indexed: false, + }, + ], + name: 'TransformedERC20', + outputs: [], + type: 'event', + }, + { + anonymous: false, + inputs: [ + { + name: 'transformerDeployer', + type: 'address', + indexed: false, + }, + ], + name: 'TransformerDeployerUpdated', + outputs: [], + type: 'event', + }, + { + inputs: [ + { + name: 'sender', + type: 'address', + }, + { + name: 'mtx', + type: 'tuple', + components: [ + { + name: 'signer', + type: 'address', + }, + { + name: 'sender', + type: 'address', + }, + { + name: 'minGasPrice', + type: 'uint256', + }, + { + name: 'maxGasPrice', + type: 'uint256', + }, + { + name: 'expirationTimeSeconds', + type: 'uint256', + }, + { + name: 'salt', + type: 'uint256', + }, + { + name: 'callData', + type: 'bytes', + }, + { + name: 'value', + type: 'uint256', + }, + { + name: 'feeToken', + type: 'address', + }, + { + name: 'feeAmount', + type: 'uint256', + }, + ], + }, + { + name: 'signature', + type: 'bytes', + }, + ], + name: '_executeMetaTransaction', + outputs: [ + { + name: 'returnResult', + type: 'bytes', + }, + ], + stateMutability: 'payable', + type: 'function', + }, + { + inputs: [ + { + name: 'token', + type: 'address', + }, + { + name: 'owner', + type: 'address', + }, + { + name: 'to', + type: 'address', + }, + { + name: 'amount', + type: 'uint256', + }, + ], + name: '_spendERC20Tokens', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'args', + type: 'tuple', + components: [ + { + name: 'taker', + type: 'address', + }, + { + name: 'inputToken', + type: 'address', + }, + { + name: 'outputToken', + type: 'address', + }, + { + name: 'inputTokenAmount', + type: 'uint256', + }, + { + name: 'minOutputTokenAmount', + type: 'uint256', + }, + { + name: 'transformations', + type: 'tuple[]', + components: [ + { + name: 'deploymentNonce', + type: 'uint32', + }, + { + name: 'data', + type: 'bytes', + }, + ], + }, + { + name: 'callDataHash', + type: 'bytes32', + }, + { + name: 'callDataSignature', + type: 'bytes', + }, + ], + }, + ], + name: '_transformERC20', + outputs: [ + { + name: 'outputTokenAmount', + type: 'uint256', + }, + ], + stateMutability: 'payable', + type: 'function', + }, + { + inputs: [ + { + name: 'mtxs', + type: 'tuple[]', + components: [ + { + name: 'signer', + type: 'address', + }, + { + name: 'sender', + type: 'address', + }, + { + name: 'minGasPrice', + type: 'uint256', + }, + { + name: 'maxGasPrice', + type: 'uint256', + }, + { + name: 'expirationTimeSeconds', + type: 'uint256', + }, + { + name: 'salt', + type: 'uint256', + }, + { + name: 'callData', + type: 'bytes', + }, + { + name: 'value', + type: 'uint256', + }, + { + name: 'feeToken', + type: 'address', + }, + { + name: 'feeAmount', + type: 'uint256', + }, + ], + }, + { + name: 'signatures', + type: 'bytes[]', + }, + ], + name: 'batchExecuteMetaTransactions', + outputs: [ + { + name: 'returnResults', + type: 'bytes[]', + }, + ], + stateMutability: 'payable', + type: 'function', + }, + { + inputs: [], + name: 'createTransformWallet', + outputs: [ + { + name: 'wallet', + type: 'address', + }, + ], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'mtx', + type: 'tuple', + components: [ + { + name: 'signer', + type: 'address', + }, + { + name: 'sender', + type: 'address', + }, + { + name: 'minGasPrice', + type: 'uint256', + }, + { + name: 'maxGasPrice', + type: 'uint256', + }, + { + name: 'expirationTimeSeconds', + type: 'uint256', + }, + { + name: 'salt', + type: 'uint256', + }, + { + name: 'callData', + type: 'bytes', + }, + { + name: 'value', + type: 'uint256', + }, + { + name: 'feeToken', + type: 'address', + }, + { + name: 'feeAmount', + type: 'uint256', + }, + ], + }, + { + name: 'signature', + type: 'bytes', + }, + ], + name: 'executeMetaTransaction', + outputs: [ + { + name: 'returnResult', + type: 'bytes', + }, + ], + stateMutability: 'payable', + type: 'function', + }, + { + inputs: [ + { + name: 'selector', + type: 'bytes4', + }, + { + name: 'impl', + type: 'address', + }, + ], + name: 'extend', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [], + name: 'getAllowanceTarget', + outputs: [ + { + name: 'target', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'selector', + type: 'bytes4', + }, + ], + name: 'getFunctionImplementation', + outputs: [ + { + name: 'impl', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'mtx', + type: 'tuple', + components: [ + { + name: 'signer', + type: 'address', + }, + { + name: 'sender', + type: 'address', + }, + { + name: 'minGasPrice', + type: 'uint256', + }, + { + name: 'maxGasPrice', + type: 'uint256', + }, + { + name: 'expirationTimeSeconds', + type: 'uint256', + }, + { + name: 'salt', + type: 'uint256', + }, + { + name: 'callData', + type: 'bytes', + }, + { + name: 'value', + type: 'uint256', + }, + { + name: 'feeToken', + type: 'address', + }, + { + name: 'feeAmount', + type: 'uint256', + }, + ], + }, + ], + name: 'getMetaTransactionExecutedBlock', + outputs: [ + { + name: 'blockNumber', + type: 'uint256', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'mtx', + type: 'tuple', + components: [ + { + name: 'signer', + type: 'address', + }, + { + name: 'sender', + type: 'address', + }, + { + name: 'minGasPrice', + type: 'uint256', + }, + { + name: 'maxGasPrice', + type: 'uint256', + }, + { + name: 'expirationTimeSeconds', + type: 'uint256', + }, + { + name: 'salt', + type: 'uint256', + }, + { + name: 'callData', + type: 'bytes', + }, + { + name: 'value', + type: 'uint256', + }, + { + name: 'feeToken', + type: 'address', + }, + { + name: 'feeAmount', + type: 'uint256', + }, + ], + }, + ], + name: 'getMetaTransactionHash', + outputs: [ + { + name: 'mtxHash', + type: 'bytes32', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'mtxHash', + type: 'bytes32', + }, + ], + name: 'getMetaTransactionHashExecutedBlock', + outputs: [ + { + name: 'blockNumber', + type: 'uint256', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [], + name: 'getQuoteSigner', + outputs: [ + { + name: 'signer', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'selector', + type: 'bytes4', + }, + { + name: 'idx', + type: 'uint256', + }, + ], + name: 'getRollbackEntryAtIndex', + outputs: [ + { + name: 'impl', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'selector', + type: 'bytes4', + }, + ], + name: 'getRollbackLength', + outputs: [ + { + name: 'rollbackLength', + type: 'uint256', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'token', + type: 'address', + }, + { + name: 'owner', + type: 'address', + }, + ], + name: 'getSpendableERC20BalanceOf', + outputs: [ + { + name: 'amount', + type: 'uint256', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [], + name: 'getTransformWallet', + outputs: [ + { + name: 'wallet', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [], + name: 'getTransformerDeployer', + outputs: [ + { + name: 'deployer', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'hash', + type: 'bytes32', + }, + { + name: 'signer', + type: 'address', + }, + { + name: 'signature', + type: 'bytes', + }, + ], + name: 'isValidHashSignature', + outputs: [ + { + name: 'isValid', + type: 'bool', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'target', + type: 'address', + }, + { + name: 'data', + type: 'bytes', + }, + { + name: 'newOwner', + type: 'address', + }, + ], + name: 'migrate', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [], + name: 'owner', + outputs: [ + { + name: 'ownerAddress', + type: 'address', + }, + ], + stateMutability: 'view', + type: 'function', + }, + { + inputs: [ + { + name: 'selector', + type: 'bytes4', + }, + { + name: 'targetImpl', + type: 'address', + }, + ], + name: 'rollback', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'quoteSigner', + type: 'address', + }, + ], + name: 'setQuoteSigner', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'transformerDeployer', + type: 'address', + }, + ], + name: 'setTransformerDeployer', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'newOwner', + type: 'address', + }, + ], + name: 'transferOwnership', + outputs: [], + stateMutability: 'nonpayable', + type: 'function', + }, + { + inputs: [ + { + name: 'inputToken', + type: 'address', + }, + { + name: 'outputToken', + type: 'address', + }, + { + name: 'inputTokenAmount', + type: 'uint256', + }, + { + name: 'minOutputTokenAmount', + type: 'uint256', + }, + { + name: 'transformations', + type: 'tuple[]', + components: [ + { + name: 'deploymentNonce', + type: 'uint32', + }, + { + name: 'data', + type: 'bytes', + }, + ], + }, + ], + name: 'transformERC20', + outputs: [ + { + name: 'outputTokenAmount', + type: 'uint256', + }, + ], + stateMutability: 'payable', + type: 'function', + }, + { + inputs: [ + { + name: 'hash', + type: 'bytes32', + }, + { + name: 'signer', + type: 'address', + }, + { + name: 'signature', + type: 'bytes', + }, + ], + name: 'validateHashSignature', + outputs: [], + stateMutability: 'view', + type: 'function', + }, + ] as ContractAbi; + return abi; + } + + protected static async _deployLibrariesAsync( + artifact: ContractArtifact, + libraryArtifacts: { [libraryName: string]: ContractArtifact }, + web3Wrapper: Web3Wrapper, + txDefaults: Partial, + libraryAddresses: { [libraryName: string]: string } = {}, + ): Promise<{ [libraryName: string]: string }> { + const links = artifact.compilerOutput.evm.bytecode.linkReferences; + // Go through all linked libraries, recursively deploying them if necessary. + for (const link of Object.values(links)) { + for (const libraryName of Object.keys(link)) { + if (!libraryAddresses[libraryName]) { + // Library not yet deployed. + const libraryArtifact = libraryArtifacts[libraryName]; + if (!libraryArtifact) { + throw new Error(`Missing artifact for linked library "${libraryName}"`); + } + // Deploy any dependent libraries used by this library. + await IZeroExContract._deployLibrariesAsync( + libraryArtifact, + libraryArtifacts, + web3Wrapper, + txDefaults, + libraryAddresses, + ); + // Deploy this library. + const linkedLibraryBytecode = linkLibrariesInBytecode(libraryArtifact, libraryAddresses); + const txDataWithDefaults = await BaseContract._applyDefaultsToContractTxDataAsync( + { + data: linkedLibraryBytecode, + ...txDefaults, + }, + web3Wrapper.estimateGasAsync.bind(web3Wrapper), + ); + const txHash = await web3Wrapper.sendTransactionAsync(txDataWithDefaults); + logUtils.log(`transactionHash: ${txHash}`); + const { contractAddress } = await web3Wrapper.awaitTransactionSuccessAsync(txHash); + logUtils.log(`${libraryArtifact.contractName} successfully deployed at ${contractAddress}`); + libraryAddresses[libraryArtifact.contractName] = contractAddress as string; + } + } + } + return libraryAddresses; + } + + public getFunctionSignature(methodName: string): string { + const index = this._methodABIIndex[methodName]; + const methodAbi = IZeroExContract.ABI()[index] as MethodAbi; // tslint:disable-line:no-unnecessary-type-assertion + const functionSignature = methodAbiToFunctionSignature(methodAbi); + return functionSignature; + } + + public getABIDecodedTransactionData(methodName: string, callData: string): T { + const functionSignature = this.getFunctionSignature(methodName); + const self = (this as any) as IZeroExContract; + const abiEncoder = self._lookupAbiEncoder(functionSignature); + const abiDecodedCallData = abiEncoder.strictDecode(callData); + return abiDecodedCallData; + } + + public getABIDecodedReturnData(methodName: string, callData: string): T { + const functionSignature = this.getFunctionSignature(methodName); + const self = (this as any) as IZeroExContract; + const abiEncoder = self._lookupAbiEncoder(functionSignature); + const abiDecodedCallData = abiEncoder.strictDecodeReturnValue(callData); + return abiDecodedCallData; + } + + public getSelector(methodName: string): string { + const functionSignature = this.getFunctionSignature(methodName); + const self = (this as any) as IZeroExContract; + const abiEncoder = self._lookupAbiEncoder(functionSignature); + return abiEncoder.getSelector(); + } + + /** + * Execute a meta-transaction via `sender`. Privileged variant. + * Only callable from within. + * @param sender Who is executing the meta-transaction.. + * @param mtx The meta-transaction. + * @param signature The signature by `mtx.signer`. + */ + public _executeMetaTransaction( + sender: string, + mtx: { + signer: string; + sender: string; + minGasPrice: BigNumber; + maxGasPrice: BigNumber; + expirationTimeSeconds: BigNumber; + salt: BigNumber; + callData: string; + value: BigNumber; + feeToken: string; + feeAmount: BigNumber; + }, + signature: string, + ): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('sender', sender); + + assert.isString('signature', signature); + const functionSignature = + '_executeMetaTransaction(address,(address,address,uint256,uint256,uint256,uint256,bytes,uint256,address,uint256),bytes)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [sender.toLowerCase(), mtx, signature]); + }, + }; + } + /** + * Transfers ERC20 tokens from `owner` to `to`. + * Only callable from within. + * @param token The token to spend. + * @param owner The owner of the tokens. + * @param to The recipient of the tokens. + * @param amount The amount of `token` to transfer. + */ + public _spendERC20Tokens(token: string, owner: string, to: string, amount: BigNumber): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('token', token); + assert.isString('owner', owner); + assert.isString('to', to); + assert.isBigNumber('amount', amount); + const functionSignature = '_spendERC20Tokens(address,address,address,uint256)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [ + token.toLowerCase(), + owner.toLowerCase(), + to.toLowerCase(), + amount, + ]); + }, + }; + } + /** + * Internal version of `transformERC20()`. Only callable from within. + * @param args A `TransformERC20Args` struct. + */ + public _transformERC20(args: { + taker: string; + inputToken: string; + outputToken: string; + inputTokenAmount: BigNumber; + minOutputTokenAmount: BigNumber; + transformations: Array<{ deploymentNonce: number | BigNumber; data: string }>; + callDataHash: string; + callDataSignature: string; + }): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + + const functionSignature = + '_transformERC20((address,address,address,uint256,uint256,(uint32,bytes)[],bytes32,bytes))'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [args]); + }, + }; + } + /** + * Execute multiple meta-transactions. + * @param mtxs The meta-transactions. + * @param signatures The signature by each respective `mtx.signer`. + */ + public batchExecuteMetaTransactions( + mtxs: Array<{ + signer: string; + sender: string; + minGasPrice: BigNumber; + maxGasPrice: BigNumber; + expirationTimeSeconds: BigNumber; + salt: BigNumber; + callData: string; + value: BigNumber; + feeToken: string; + feeAmount: BigNumber; + }>, + signatures: string[], + ): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isArray('mtxs', mtxs); + assert.isArray('signatures', signatures); + const functionSignature = + 'batchExecuteMetaTransactions((address,address,uint256,uint256,uint256,uint256,bytes,uint256,address,uint256)[],bytes[])'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [mtxs, signatures]); + }, + }; + } + /** + * Deploy a new flash wallet instance and replace the current one with it. + * Useful if we somehow break the current wallet instance. + * Only callable by the owner. + */ + public createTransformWallet(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'createTransformWallet()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Execute a single meta-transaction. + * @param mtx The meta-transaction. + * @param signature The signature by `mtx.signer`. + */ + public executeMetaTransaction( + mtx: { + signer: string; + sender: string; + minGasPrice: BigNumber; + maxGasPrice: BigNumber; + expirationTimeSeconds: BigNumber; + salt: BigNumber; + callData: string; + value: BigNumber; + feeToken: string; + feeAmount: BigNumber; + }, + signature: string, + ): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + + assert.isString('signature', signature); + const functionSignature = + 'executeMetaTransaction((address,address,uint256,uint256,uint256,uint256,bytes,uint256,address,uint256),bytes)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [mtx, signature]); + }, + }; + } + /** + * Register or replace a function. + * @param selector The function selector. + * @param impl The implementation contract for the function. + */ + public extend(selector: string, impl: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('selector', selector); + assert.isString('impl', impl); + const functionSignature = 'extend(bytes4,address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [selector, impl.toLowerCase()]); + }, + }; + } + /** + * Get the address of the allowance target. + */ + public getAllowanceTarget(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'getAllowanceTarget()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Get the implementation contract of a registered function. + * @param selector The function selector. + */ + public getFunctionImplementation(selector: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('selector', selector); + const functionSignature = 'getFunctionImplementation(bytes4)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [selector]); + }, + }; + } + /** + * Get the block at which a meta-transaction has been executed. + * @param mtx The meta-transaction. + */ + public getMetaTransactionExecutedBlock(mtx: { + signer: string; + sender: string; + minGasPrice: BigNumber; + maxGasPrice: BigNumber; + expirationTimeSeconds: BigNumber; + salt: BigNumber; + callData: string; + value: BigNumber; + feeToken: string; + feeAmount: BigNumber; + }): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + + const functionSignature = + 'getMetaTransactionExecutedBlock((address,address,uint256,uint256,uint256,uint256,bytes,uint256,address,uint256))'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [mtx]); + }, + }; + } + /** + * Get the EIP712 hash of a meta-transaction. + * @param mtx The meta-transaction. + */ + public getMetaTransactionHash(mtx: { + signer: string; + sender: string; + minGasPrice: BigNumber; + maxGasPrice: BigNumber; + expirationTimeSeconds: BigNumber; + salt: BigNumber; + callData: string; + value: BigNumber; + feeToken: string; + feeAmount: BigNumber; + }): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + + const functionSignature = + 'getMetaTransactionHash((address,address,uint256,uint256,uint256,uint256,bytes,uint256,address,uint256))'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [mtx]); + }, + }; + } + /** + * Get the block at which a meta-transaction hash has been executed. + * @param mtxHash The meta-transaction hash. + */ + public getMetaTransactionHashExecutedBlock(mtxHash: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('mtxHash', mtxHash); + const functionSignature = 'getMetaTransactionHashExecutedBlock(bytes32)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [mtxHash]); + }, + }; + } + /** + * Return the optional signer for `transformERC20()` calldata. + */ + public getQuoteSigner(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'getQuoteSigner()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Retrieve an entry in the rollback history for a function. + * @param selector The function selector. + * @param idx The index in the rollback history. + */ + public getRollbackEntryAtIndex(selector: string, idx: BigNumber): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('selector', selector); + assert.isBigNumber('idx', idx); + const functionSignature = 'getRollbackEntryAtIndex(bytes4,uint256)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [selector, idx]); + }, + }; + } + /** + * Retrieve the length of the rollback history for a function. + * @param selector The function selector. + */ + public getRollbackLength(selector: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('selector', selector); + const functionSignature = 'getRollbackLength(bytes4)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [selector]); + }, + }; + } + /** + * Gets the maximum amount of an ERC20 token `token` that can be + * pulled from `owner`. + * @param token The token to spend. + * @param owner The owner of the tokens. + */ + public getSpendableERC20BalanceOf(token: string, owner: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('token', token); + assert.isString('owner', owner); + const functionSignature = 'getSpendableERC20BalanceOf(address,address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [token.toLowerCase(), owner.toLowerCase()]); + }, + }; + } + /** + * Return the current wallet instance that will serve as the execution + * context for transformations. + */ + public getTransformWallet(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'getTransformWallet()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Return the allowed deployer for transformers. + */ + public getTransformerDeployer(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'getTransformerDeployer()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Check that `hash` was signed by `signer` given `signature`. + * @param hash The hash that was signed. + * @param signer The signer of the hash. + * @param signature The signature. The last byte of this signature should + * be a member of the `SignatureType` enum. + */ + public isValidHashSignature(hash: string, signer: string, signature: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('hash', hash); + assert.isString('signer', signer); + assert.isString('signature', signature); + const functionSignature = 'isValidHashSignature(bytes32,address,bytes)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [hash, signer.toLowerCase(), signature]); + }, + }; + } + /** + * Execute a migration function in the context of the ZeroEx contract. + * The result of the function being called should be the magic bytes + * 0x2c64c5ef (`keccack('MIGRATE_SUCCESS')`). Only callable by the owner. + * The owner will be temporarily set to `address(this)` inside the call. + * Before returning, the owner will be set to `newOwner`. + * @param target The migrator contract address. + * @param data The call data. + * @param newOwner The address of the new owner. + */ + public migrate(target: string, data: string, newOwner: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('target', target); + assert.isString('data', data); + assert.isString('newOwner', newOwner); + const functionSignature = 'migrate(address,bytes,address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [ + target.toLowerCase(), + data, + newOwner.toLowerCase(), + ]); + }, + }; + } + /** + * The owner of this contract. + */ + public owner(): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + const functionSignature = 'owner()'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, []); + }, + }; + } + /** + * Roll back to a prior implementation of a function. + * @param selector The function selector. + * @param targetImpl The address of an older implementation of the function. + */ + public rollback(selector: string, targetImpl: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('selector', selector); + assert.isString('targetImpl', targetImpl); + const functionSignature = 'rollback(bytes4,address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [selector, targetImpl.toLowerCase()]); + }, + }; + } + /** + * Replace the optional signer for `transformERC20()` calldata. + * Only callable by the owner. + * @param quoteSigner The address of the new calldata signer. + */ + public setQuoteSigner(quoteSigner: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('quoteSigner', quoteSigner); + const functionSignature = 'setQuoteSigner(address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [quoteSigner.toLowerCase()]); + }, + }; + } + /** + * Replace the allowed deployer for transformers. + * Only callable by the owner. + * @param transformerDeployer The address of the new trusted deployer + * for transformers. + */ + public setTransformerDeployer(transformerDeployer: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('transformerDeployer', transformerDeployer); + const functionSignature = 'setTransformerDeployer(address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [transformerDeployer.toLowerCase()]); + }, + }; + } + /** + * Transfers ownership of the contract to a new address. + * @param newOwner The address that will become the owner. + */ + public transferOwnership(newOwner: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('newOwner', newOwner); + const functionSignature = 'transferOwnership(address)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [newOwner.toLowerCase()]); + }, + }; + } + /** + * Executes a series of transformations to convert an ERC20 `inputToken` + * to an ERC20 `outputToken`. + * @param inputToken The token being provided by the sender. If + * `0xeee...`, ETH is implied and should be provided with the call.` + * @param outputToken The token to be acquired by the sender. `0xeee...` + * implies ETH. + * @param inputTokenAmount The amount of `inputToken` to take from the sender. + * @param minOutputTokenAmount The minimum amount of `outputToken` the sender + * must receive for the entire transformation to succeed. + * @param transformations The transformations to execute on the token + * balance(s) in sequence. + */ + public transformERC20( + inputToken: string, + outputToken: string, + inputTokenAmount: BigNumber, + minOutputTokenAmount: BigNumber, + transformations: Array<{ deploymentNonce: number | BigNumber; data: string }>, + ): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('inputToken', inputToken); + assert.isString('outputToken', outputToken); + assert.isBigNumber('inputTokenAmount', inputTokenAmount); + assert.isBigNumber('minOutputTokenAmount', minOutputTokenAmount); + assert.isArray('transformations', transformations); + const functionSignature = 'transformERC20(address,address,uint256,uint256,(uint32,bytes)[])'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [ + inputToken.toLowerCase(), + outputToken.toLowerCase(), + inputTokenAmount, + minOutputTokenAmount, + transformations, + ]); + }, + }; + } + /** + * Validate that `hash` was signed by `signer` given `signature`. + * Reverts otherwise. + * @param hash The hash that was signed. + * @param signer The signer of the hash. + * @param signature The signature. The last byte of this signature should + * be a member of the `SignatureType` enum. + */ + public validateHashSignature(hash: string, signer: string, signature: string): ContractTxFunctionObj { + const self = (this as any) as IZeroExContract; + assert.isString('hash', hash); + assert.isString('signer', signer); + assert.isString('signature', signature); + const functionSignature = 'validateHashSignature(bytes32,address,bytes)'; + + return { + async sendTransactionAsync( + txData?: Partial | undefined, + opts: SendTransactionOpts = { shouldValidate: true }, + ): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync( + { data: this.getABIEncodedTransactionData(), ...txData }, + this.estimateGasAsync.bind(this), + ); + if (opts.shouldValidate !== false) { + await this.callAsync(txDataWithDefaults); + } + return self._web3Wrapper.sendTransactionAsync(txDataWithDefaults); + }, + awaitTransactionSuccessAsync( + txData?: Partial, + opts: AwaitTransactionSuccessOpts = { shouldValidate: true }, + ): PromiseWithTransactionHash { + return self._promiseWithTransactionHash(this.sendTransactionAsync(txData, opts), opts); + }, + async estimateGasAsync(txData?: Partial | undefined): Promise { + const txDataWithDefaults = await self._applyDefaultsToTxDataAsync({ + data: this.getABIEncodedTransactionData(), + ...txData, + }); + return self._web3Wrapper.estimateGasAsync(txDataWithDefaults); + }, + async callAsync(callData: Partial = {}, defaultBlock?: BlockParam): Promise { + BaseContract._assertCallParams(callData, defaultBlock); + const rawCallResult = await self._performCallAsync( + { data: this.getABIEncodedTransactionData(), ...callData }, + defaultBlock, + ); + const abiEncoder = self._lookupAbiEncoder(functionSignature); + BaseContract._throwIfUnexpectedEmptyCallResult(rawCallResult, abiEncoder); + return abiEncoder.strictDecodeReturnValue(rawCallResult); + }, + getABIEncodedTransactionData(): string { + return self._strictEncodeArguments(functionSignature, [hash, signer.toLowerCase(), signature]); + }, + }; + } + + /** + * Subscribe to an event type emitted by the IZeroEx contract. + * @param eventName The IZeroEx contract event you would like to subscribe to. + * @param indexFilterValues 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}` + * @param callback Callback that gets called when a log is added/removed + * @param isVerbose Enable verbose subscription warnings (e.g recoverable network issues encountered) + * @return Subscription token used later to unsubscribe + */ + public subscribe( + eventName: IZeroExEvents, + indexFilterValues: IndexedFilterValues, + callback: EventCallback, + isVerbose: boolean = false, + blockPollingIntervalMs?: number, + ): string { + assert.doesBelongToStringEnum('eventName', eventName, IZeroExEvents); + assert.doesConformToSchema('indexFilterValues', indexFilterValues, schemas.indexFilterValuesSchema); + assert.isFunction('callback', callback); + const subscriptionToken = this._subscriptionManager.subscribe( + this.address, + eventName, + indexFilterValues, + IZeroExContract.ABI(), + callback, + isVerbose, + blockPollingIntervalMs, + ); + return subscriptionToken; + } + + /** + * Cancel a subscription + * @param subscriptionToken Subscription token returned by `subscribe()` + */ + public unsubscribe(subscriptionToken: string): void { + this._subscriptionManager.unsubscribe(subscriptionToken); + } + + /** + * Cancels all existing subscriptions + */ + public unsubscribeAll(): void { + this._subscriptionManager.unsubscribeAll(); + } + + /** + * Gets historical logs without creating a subscription + * @param eventName The IZeroEx contract event you would like to subscribe to. + * @param blockRange Block range to get logs from. + * @param indexFilterValues 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}` + * @return Array of logs that match the parameters + */ + public async getLogsAsync( + eventName: IZeroExEvents, + blockRange: BlockRange, + indexFilterValues: IndexedFilterValues, + ): Promise>> { + assert.doesBelongToStringEnum('eventName', eventName, IZeroExEvents); + assert.doesConformToSchema('blockRange', blockRange, schemas.blockRangeSchema); + assert.doesConformToSchema('indexFilterValues', indexFilterValues, schemas.indexFilterValuesSchema); + const logs = await this._subscriptionManager.getLogsAsync( + this.address, + eventName, + blockRange, + indexFilterValues, + IZeroExContract.ABI(), + ); + return logs; + } + + constructor( + address: string, + supportedProvider: SupportedProvider, + txDefaults?: Partial, + logDecodeDependencies?: { [contractName: string]: ContractAbi }, + deployedBytecode: string | undefined = IZeroExContract.deployedBytecode, + ) { + super( + 'IZeroEx', + IZeroExContract.ABI(), + address, + supportedProvider, + txDefaults, + logDecodeDependencies, + deployedBytecode, + ); + classUtils.bindAll(this, ['_abiEncoderByFunctionSignature', 'address', '_web3Wrapper']); + this._subscriptionManager = new SubscriptionManager( + IZeroExContract.ABI(), + this._web3Wrapper, + ); + IZeroExContract.ABI().forEach((item, index) => { + if (item.type === 'function') { + const methodAbi = item as MethodAbi; + this._methodABIIndex[methodAbi.name] = index; + } + }); + } +} + +// tslint:disable:max-file-line-count +// tslint:enable:no-unbound-method no-parameter-reassignment no-consecutive-blank-lines ordered-imports align +// tslint:enable:trailing-comma whitespace no-trailing-whitespace diff --git a/packages/contract-wrappers/src/index.ts b/packages/contract-wrappers/src/index.ts index a9d2342fb4..363416beb6 100644 --- a/packages/contract-wrappers/src/index.ts +++ b/packages/contract-wrappers/src/index.ts @@ -87,9 +87,22 @@ export { ITransformERC20Contract, ITransformERC20EventArgs, ITransformERC20Events, + ITransformERC20QuoteSignerUpdatedEventArgs, ITransformERC20TransformerDeployerUpdatedEventArgs, ITransformERC20TransformedERC20EventArgs, } from './generated-wrappers/i_transform_erc20'; +export { + IZeroExContract, + IZeroExEventArgs, + IZeroExEvents, + IZeroExMetaTransactionExecutedEventArgs, + IZeroExMigratedEventArgs, + IZeroExOwnershipTransferredEventArgs, + IZeroExProxyFunctionUpdatedEventArgs, + IZeroExQuoteSignerUpdatedEventArgs, + IZeroExTransformedERC20EventArgs, + IZeroExTransformerDeployerUpdatedEventArgs, +} from './generated-wrappers/i_zero_ex'; export { BlockRange, SupportedProvider,