15036 lines
439 KiB
Plaintext
15036 lines
439 KiB
Plaintext
# 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: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*
|
||
|
||
<hr />
|
||
|
||
# Class: CoordinatorContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`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: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* = "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<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EIP712_COORDINATOR_DOMAIN_HASH
|
||
|
||
▸ **EIP712_COORDINATOR_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EIP712_COORDINATOR_DOMAIN_NAME
|
||
|
||
▸ **EIP712_COORDINATOR_DOMAIN_NAME**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EIP712_COORDINATOR_DOMAIN_VERSION
|
||
|
||
▸ **EIP712_COORDINATOR_DOMAIN_VERSION**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EIP712_EXCHANGE_DOMAIN_HASH
|
||
|
||
▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### assertValidCoordinatorApprovals
|
||
|
||
▸ **assertValidCoordinatorApprovals**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### decodeOrdersFromFillData
|
||
|
||
▸ **decodeOrdersFromFillData**(`data`: string): *`ContractFunctionObj<Array<object>>`*
|
||
|
||
*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<Array<object>>`*
|
||
|
||
orders The orders from the Exchange calldata.
|
||
|
||
___
|
||
|
||
### executeTransaction
|
||
|
||
▸ **executeTransaction**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/coordinator.ts:557](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/coordinator.ts#L557)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getCoordinatorApprovalHash
|
||
|
||
▸ **getCoordinatorApprovalHash**(`approval`: object): *`ContractFunctionObj<string>`*
|
||
|
||
*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)*
|
||
|
||
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<string>`*
|
||
|
||
approvalHash EIP712 hash of the Coordinator approval message with the domain separator of this contract.
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getSignerAddress
|
||
|
||
▸ **getSignerAddress**(`hash`: string, `signature`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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)*
|
||
|
||
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<string>`*
|
||
|
||
signerAddress Address of the signer.
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise<CoordinatorContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange` | string |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<CoordinatorContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise<CoordinatorContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange` | string |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<CoordinatorContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise<CoordinatorContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange` | string |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<CoordinatorContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: DevUtilsContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode |
|
||
|
||
**Returns:** *[DevUtilsContract](#class-devutilscontract)*
|
||
|
||
## 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* = "DevUtils"
|
||
|
||
*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)*
|
||
|
||
## Methods
|
||
|
||
### EIP712_EXCHANGE_DOMAIN_HASH
|
||
|
||
▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj<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)*
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### chaiBridgeAddress
|
||
|
||
▸ **chaiBridgeAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### decodeAssetProxyId
|
||
|
||
▸ **decodeAssetProxyId**(`assetData`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
The AssetProxy identifier
|
||
|
||
___
|
||
|
||
### decodeERC1155AssetData
|
||
|
||
▸ **decodeERC1155AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`*
|
||
|
||
The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as `memory` are returned as pointers to locations within the memory of the input parameter `assetData`.
|
||
|
||
___
|
||
|
||
### decodeERC20AssetData
|
||
|
||
▸ **decodeERC20AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, string]>`*
|
||
|
||
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.
|
||
|
||
___
|
||
|
||
### decodeERC721AssetData
|
||
|
||
▸ **decodeERC721AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`*
|
||
|
||
The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting this asset, and the identifier of the specific asset to be traded.
|
||
|
||
___
|
||
|
||
### decodeMultiAssetData
|
||
|
||
▸ **decodeMultiAssetData**(`assetData`: string): *`ContractFunctionObj<[string, BigNumber[], string[]]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, BigNumber[], string[]]>`*
|
||
|
||
The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array.
|
||
|
||
___
|
||
|
||
### decodeStaticCallAssetData
|
||
|
||
▸ **decodeStaticCallAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy-compliant asset data describing a StaticCall asset |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, string, string, string]>`*
|
||
|
||
The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data.
|
||
|
||
___
|
||
|
||
### decodeZeroExTransactionData
|
||
|
||
▸ **decodeZeroExTransactionData**(`transactionData`: string): *`ContractFunctionObj<[string, Array<object>, BigNumber[], string[]]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. |
|
||
|
||
**Returns:** *`ContractFunctionObj<[string, Array<object>, BigNumber[], string[]]>`*
|
||
|
||
The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element.
|
||
|
||
___
|
||
|
||
### dydxBridgeAddress
|
||
|
||
▸ **dydxBridgeAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### encodeERC1155AssetData
|
||
|
||
▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`tokenAddress` | string | The address of the ERC-1155 contract hosting the asset(s) to be traded. |
|
||
`tokenIds` | `BigNumber`[] | The identifiers of the specific assets to be traded. |
|
||
`tokenValues` | `BigNumber`[] | The amounts of each asset to be traded. |
|
||
`callbackData` | string | Data to be passed to receiving contracts when a transfer is performed. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
AssetProxy-compliant asset data describing the set of assets.
|
||
|
||
___
|
||
|
||
### encodeERC20AssetData
|
||
|
||
▸ **encodeERC20AssetData**(`tokenAddress`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
AssetProxy-compliant data describing the asset.
|
||
|
||
___
|
||
|
||
### encodeERC721AssetData
|
||
|
||
▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`tokenAddress` | string | The address of the ERC-721 contract hosting the asset to be traded. |
|
||
`tokenId` | `BigNumber` | The identifier of the specific asset to be traded. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
AssetProxy-compliant asset data describing the asset.
|
||
|
||
___
|
||
|
||
### encodeMultiAssetData
|
||
|
||
▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`amounts` | `BigNumber`[] | The amounts of each asset to be traded. |
|
||
`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
AssetProxy-compliant data describing the set of assets.
|
||
|
||
___
|
||
|
||
### encodeStaticCallAssetData
|
||
|
||
▸ **encodeStaticCallAssetData**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`staticCallTargetAddress` | string | Target address of StaticCall. |
|
||
`staticCallData` | string | Data that will be passed to staticCallTargetAddress in the StaticCall. |
|
||
`expectedReturnDataHash` | string | Expected Keccak-256 hash of the StaticCall return data. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
AssetProxy-compliant asset data describing the set of assets.
|
||
|
||
___
|
||
|
||
### erc1155ProxyAddress
|
||
|
||
▸ **erc1155ProxyAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### erc20ProxyAddress
|
||
|
||
▸ **erc20ProxyAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### erc721ProxyAddress
|
||
|
||
▸ **erc721ProxyAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### exchangeAddress
|
||
|
||
▸ **exchangeAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/dev_utils.ts:1574](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/dev_utils.ts#L1574)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getAssetProxyAllowance
|
||
|
||
▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend.
|
||
|
||
___
|
||
|
||
### getBalance
|
||
|
||
▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
Number of assets (or asset baskets) held by owner.
|
||
|
||
___
|
||
|
||
### getBalanceAndAssetProxyAllowance
|
||
|
||
▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`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.
|
||
|
||
___
|
||
|
||
### getBatchAssetProxyAllowances
|
||
|
||
▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj<BigNumber[]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber[]>`*
|
||
|
||
An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input.
|
||
|
||
___
|
||
|
||
### getBatchBalances
|
||
|
||
▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj<BigNumber[]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber[]>`*
|
||
|
||
Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input.
|
||
|
||
___
|
||
|
||
### getBatchBalancesAndAssetProxyAllowances
|
||
|
||
▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractTxFunctionObj<[BigNumber[], BigNumber[]]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Owner of the assets specified by assetData. |
|
||
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`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.
|
||
|
||
___
|
||
|
||
### getEthBalances
|
||
|
||
▸ **getEthBalances**(`addresses`: string[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`addresses` | string[] | Array of addresses. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
Array of ETH balances.
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getOrderHash
|
||
|
||
▸ **getOrderHash**(`order`: object, `chainId`: `BigNumber`, `exchange`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### getOrderRelevantState
|
||
|
||
▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractTxFunctionObj<[object, BigNumber, boolean]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | The order structure. |
|
||
`signature` | string | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. |
|
||
|
||
**Returns:** *`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.
|
||
|
||
___
|
||
|
||
### getOrderRelevantStates
|
||
|
||
▸ **getOrderRelevantStates**(`orders`: `Array<object>`, `signatures`: string[]): *`ContractTxFunctionObj<[Array<object>, BigNumber[], boolean[]]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | 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:** *`ContractTxFunctionObj<[Array<object>, 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.
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getSimulatedOrderMakerTransferResults
|
||
|
||
▸ **getSimulatedOrderMakerTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
The index of the first failed transfer (or 4 if all transfers are successful).
|
||
|
||
___
|
||
|
||
### getSimulatedOrderTransferResults
|
||
|
||
▸ **getSimulatedOrderTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj<number>`*
|
||
|
||
*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.
|
||
|
||
**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<number>`*
|
||
|
||
The index of the first failed transfer (or 4 if all transfers are successful).
|
||
|
||
___
|
||
|
||
### getSimulatedOrdersTransferResults
|
||
|
||
▸ **getSimulatedOrdersTransferResults**(`orders`: `Array<object>`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *`ContractTxFunctionObj<number[]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of orders to individually simulate transfers for. |
|
||
`takerAddresses` | string[] | Array of addresses of takers that will fill each order. |
|
||
`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<number[]>`*
|
||
|
||
The indices of the first failed transfer (or 4 if all transfers are successful) for each order.
|
||
|
||
___
|
||
|
||
### getTransactionHash
|
||
|
||
▸ **getTransactionHash**(`transaction`: object, `chainId`: `BigNumber`, `exchange`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### getTransferableAssetAmount
|
||
|
||
▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
*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 maker of an order.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`ownerAddress` | string | Address of the owner of the asset. |
|
||
`assetData` | string | Description of tokens, per the AssetProxy contract specification. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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`.
|
||
|
||
___
|
||
|
||
### revertIfInvalidAssetData
|
||
|
||
▸ **revertIfInvalidAssetData**(`assetData`: string): *`ContractFunctionObj<void>`*
|
||
|
||
*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 | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | AssetProxy compliant asset data. |
|
||
|
||
**Returns:** *`ContractFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### staticCallProxyAddress
|
||
|
||
▸ **staticCallProxyAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise<DevUtilsContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange_` | string |
|
||
`chaiBridge_` | string |
|
||
`dydxBridge_` | string |
|
||
|
||
**Returns:** *`Promise<DevUtilsContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise<DevUtilsContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange_` | string |
|
||
`chaiBridge_` | string |
|
||
`dydxBridge_` | string |
|
||
|
||
**Returns:** *`Promise<DevUtilsContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange_`: string, `chaiBridge_`: string, `dydxBridge_`: string): *`Promise<DevUtilsContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`exchange_` | string |
|
||
`chaiBridge_` | string |
|
||
`dydxBridge_` | string |
|
||
|
||
**Returns:** *`Promise<DevUtilsContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ERC20BridgeSamplerContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ERC20BridgeSamplerContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20BridgeSamplerContract](#class-erc20bridgesamplercontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ERC20BridgeSamplerContract.deployedBytecode |
|
||
|
||
**Returns:** *[ERC20BridgeSamplerContract](#class-erc20bridgesamplercontract)*
|
||
|
||
## 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* = "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
|
||
|
||
### batchCall
|
||
|
||
▸ **batchCall**(`callDatas`: string[]): *`ContractFunctionObj<string[]>`*
|
||
|
||
*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)*
|
||
|
||
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<string[]>`*
|
||
|
||
callResults ABI-encoded results data for each call.
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/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:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLiquidityProviderFromRegistry
|
||
|
||
▸ **getLiquidityProviderFromRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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)*
|
||
|
||
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<string>`*
|
||
|
||
providerAddress Address of the liquidity provider.
|
||
|
||
___
|
||
|
||
### getOrderFillableMakerAssetAmounts
|
||
|
||
▸ **getOrderFillableMakerAssetAmounts**(`orders`: `Array<object>`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<object>` | Native orders to query. |
|
||
`orderSignatures` | string[] | Signatures for each respective order in `orders`. |
|
||
`devUtilsAddress` | string | Address to the DevUtils contract. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
orderFillableMakerAssetAmounts How much maker asset can be filled by each order in `orders`.
|
||
|
||
___
|
||
|
||
### getOrderFillableTakerAssetAmounts
|
||
|
||
▸ **getOrderFillableTakerAssetAmounts**(`orders`: `Array<object>`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<object>` | Native orders to query. |
|
||
`orderSignatures` | string[] | Signatures for each respective order in `orders`. |
|
||
`devUtilsAddress` | string | Address to the DevUtils contract. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
orderFillableTakerAssetAmounts How much taker asset can be filled by each order in `orders`.
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### sampleBuysFromCurve
|
||
|
||
▸ **sampleBuysFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
Sample buy 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). |
|
||
`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromEth2Dai
|
||
|
||
▸ **sampleBuysFromEth2Dai**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
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`[] | - |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromKyberNetwork
|
||
|
||
▸ **sampleBuysFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromLiquidityProviderRegistry
|
||
|
||
▸ **sampleBuysFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromUniswap
|
||
|
||
▸ **sampleBuysFromUniswap**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
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 sell amount for each sample. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromUniswapV2
|
||
|
||
▸ **sampleBuysFromUniswapV2**(`path`: string[], `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
Sample buy quotes from UniswapV2.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`path` | string[] | Token route. Should be takerToken -> makerToken. |
|
||
`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromCurve
|
||
|
||
▸ **sampleSellsFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromEth2Dai
|
||
|
||
▸ **sampleSellsFromEth2Dai**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromEth2DaiHop
|
||
|
||
▸ **sampleSellsFromEth2DaiHop**(`takerToken`: string, `makerToken`: string, `intermediateToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromKyberNetwork
|
||
|
||
▸ **sampleSellsFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromLiquidityProviderRegistry
|
||
|
||
▸ **sampleSellsFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromMultiBridge
|
||
|
||
▸ **sampleSellsFromMultiBridge**(`multibridge`: string, `takerToken`: string, `intermediateToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromUniswap
|
||
|
||
▸ **sampleSellsFromUniswap**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromUniswapV2
|
||
|
||
▸ **sampleSellsFromUniswapV2**(`path`: string[], `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ERC20TokenContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode |
|
||
|
||
**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)*
|
||
|
||
## 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* = "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
|
||
|
||
### allowance
|
||
|
||
▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`_owner` | string |
|
||
`_spender` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### approve
|
||
|
||
▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_spender` | string | The address of the account able to transfer the tokens |
|
||
`_value` | `BigNumber` | The amount of wei to be approved for transfer |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
Always true if the call has enough gas to complete execution
|
||
|
||
___
|
||
|
||
### balanceOf
|
||
|
||
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_owner` | string | The address from which the balance will be retrieved |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
Balance of owner
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/erc20_token.ts:405](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc20_token.ts#L405)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`eventName` | [ERC20TokenEvents](#enumeration-erc20tokenevents) | The ERC20Token contract event you would like to subscribe to. |
|
||
`blockRange` | `BlockRange` | Block range to get logs from. |
|
||
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
|
||
|
||
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### subscribe
|
||
|
||
▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
|
||
|
||
*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.
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default | Description |
|
||
------ | ------ | ------ | ------ |
|
||
`eventName` | [ERC20TokenEvents](#enumeration-erc20tokenevents) | - | The ERC20Token contract event you would like to subscribe to. |
|
||
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
|
||
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
|
||
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
|
||
`blockPollingIntervalMs?` | undefined \| number | - | - |
|
||
|
||
**Returns:** *string*
|
||
|
||
Subscription token used later to unsubscribe
|
||
|
||
___
|
||
|
||
### totalSupply
|
||
|
||
▸ **totalSupply**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
Total supply of token
|
||
|
||
___
|
||
|
||
### transfer
|
||
|
||
▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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`
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_to` | string | The address of the recipient |
|
||
`_value` | `BigNumber` | The amount of token to be transferred |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
True if transfer was successful
|
||
|
||
___
|
||
|
||
### transferFrom
|
||
|
||
▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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`
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_from` | string | The address of the sender |
|
||
`_to` | string | The address of the recipient |
|
||
`_value` | `BigNumber` | The amount of token to be transferred |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
True if transfer was successful
|
||
|
||
___
|
||
|
||
### unsubscribe
|
||
|
||
▸ **unsubscribe**(`subscriptionToken`: string): *void*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### unsubscribeAll
|
||
|
||
▸ **unsubscribeAll**(): *void*
|
||
|
||
*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
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20TokenContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20TokenContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20TokenContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20TokenContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20TokenContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC20TokenContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ERC721TokenContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode |
|
||
|
||
**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)*
|
||
|
||
## 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* = "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
|
||
|
||
### approve
|
||
|
||
▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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
|
||
operator of the current owner.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_approved` | string | The new approved NFT controller |
|
||
`_tokenId` | `BigNumber` | The NFT to approve |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### balanceOf
|
||
|
||
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_owner` | string | An address for whom to query the balance |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
The number of NFTs owned by `_owner`, possibly zero
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/erc721_token.ts:495](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/erc721_token.ts#L495)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getApproved
|
||
|
||
▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_tokenId` | `BigNumber` | The NFT to find the approved address for |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
The approved address for this NFT, or the zero address if there is none
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | The ERC721Token contract event you would like to subscribe to. |
|
||
`blockRange` | `BlockRange` | Block range to get logs from. |
|
||
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
|
||
|
||
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### isApprovedForAll
|
||
|
||
▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`_owner` | string |
|
||
`_operator` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### ownerOf
|
||
|
||
▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`_tokenId` | `BigNumber` | The identifier for an NFT |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
The address of the owner of the NFT
|
||
|
||
___
|
||
|
||
### safeTransferFrom1
|
||
|
||
▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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 "".
|
||
|
||
**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<void>`*
|
||
|
||
___
|
||
|
||
### safeTransferFrom2
|
||
|
||
▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### setApprovalForAll
|
||
|
||
▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**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<void>`*
|
||
|
||
___
|
||
|
||
### subscribe
|
||
|
||
▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
|
||
|
||
*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.
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default | Description |
|
||
------ | ------ | ------ | ------ |
|
||
`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | - | The ERC721Token contract event you would like to subscribe to. |
|
||
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
|
||
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
|
||
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
|
||
`blockPollingIntervalMs?` | undefined \| number | - | - |
|
||
|
||
**Returns:** *string*
|
||
|
||
Subscription token used later to unsubscribe
|
||
|
||
___
|
||
|
||
### transferFrom
|
||
|
||
▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### unsubscribe
|
||
|
||
▸ **unsubscribe**(`subscriptionToken`: string): *void*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### unsubscribeAll
|
||
|
||
▸ **unsubscribeAll**(): *void*
|
||
|
||
*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
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC721TokenContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC721TokenContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC721TokenContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC721TokenContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC721TokenContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ERC721TokenContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ExchangeContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode |
|
||
|
||
**Returns:** *[ExchangeContract](#class-exchangecontract)*
|
||
|
||
## 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* = "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
|
||
|
||
### EIP1271_MAGIC_VALUE
|
||
|
||
▸ **EIP1271_MAGIC_VALUE**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EIP712_EXCHANGE_DOMAIN_HASH
|
||
|
||
▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### allowedValidators
|
||
|
||
▸ **allowedValidators**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
`index_1` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### batchCancelOrders
|
||
|
||
▸ **batchCancelOrders**(`orders`: `Array<object>`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### batchExecuteTransactions
|
||
|
||
▸ **batchExecuteTransactions**(`transactions`: `Array<object>`, `signatures`: string[]): *`ContractTxFunctionObj<string[]>`*
|
||
|
||
*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).
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`transactions` | `Array<object>` | Array of 0x transaction structures. |
|
||
`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string[]>`*
|
||
|
||
returnData Array containing ABI encoded return data for each of the underlying Exchange function calls.
|
||
|
||
___
|
||
|
||
### batchFillOrKillOrders
|
||
|
||
▸ **batchFillOrKillOrders**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
|
||
`signatures` | string[] | Proofs that orders have been created by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
fillResults Array of amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### batchFillOrders
|
||
|
||
▸ **batchFillOrders**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
|
||
`signatures` | string[] | Proofs that orders have been created by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
fillResults Array of amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### batchFillOrdersNoThrow
|
||
|
||
▸ **batchFillOrdersNoThrow**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
|
||
`signatures` | string[] | Proofs that orders have been created by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
|
||
|
||
fillResults Array of amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### batchMatchOrders
|
||
|
||
▸ **batchMatchOrders**(`leftOrders`: `Array<object>`, `rightOrders`: `Array<object>`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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
|
||
the matcher receives a profit denominated in the left maker asset.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`leftOrders` | `Array<object>` | Set of orders with the same maker / taker asset. |
|
||
`rightOrders` | `Array<object>` | Set of orders to match against `leftOrders` |
|
||
`leftSignatures` | string[] | Proof that left orders were created by the left makers. |
|
||
`rightSignatures` | string[] | Proof that right orders were created by the right makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
batchMatchedFillResults Amounts filled and profit generated.
|
||
|
||
___
|
||
|
||
### batchMatchOrdersWithMaximalFill
|
||
|
||
▸ **batchMatchOrdersWithMaximalFill**(`leftOrders`: `Array<object>`, `rightOrders`: `Array<object>`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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
|
||
the matcher receives a profit denominated in either the left maker asset,
|
||
right maker asset, or a combination of both.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`leftOrders` | `Array<object>` | Set of orders with the same maker / taker asset. |
|
||
`rightOrders` | `Array<object>` | Set of orders to match against `leftOrders` |
|
||
`leftSignatures` | string[] | Proof that left orders were created by the left makers. |
|
||
`rightSignatures` | string[] | Proof that right orders were created by the right makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
batchMatchedFillResults Amounts filled and profit generated.
|
||
|
||
___
|
||
|
||
### cancelOrder
|
||
|
||
▸ **cancelOrder**(`order`: object): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | Order struct containing order specifications. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### cancelOrdersUpTo
|
||
|
||
▸ **cancelOrdersUpTo**(`targetOrderEpoch`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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).
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### cancelled
|
||
|
||
▸ **cancelled**(`index_0`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### currentContextAddress
|
||
|
||
▸ **currentContextAddress**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### detachProtocolFeeCollector
|
||
|
||
▸ **detachProtocolFeeCollector**(): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### executeTransaction
|
||
|
||
▸ **executeTransaction**(`transaction`: object, `signature`: string): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`transaction` | object | 0x transaction structure. |
|
||
`signature` | string | Proof that transaction has been signed by signer. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
ABI encoded return data of the underlying Exchange function call.
|
||
|
||
___
|
||
|
||
### fillOrKillOrder
|
||
|
||
▸ **fillOrKillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | Order struct containing order specifications. |
|
||
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
|
||
`signature` | string | Proof that order has been created by maker. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid.
|
||
|
||
___
|
||
|
||
### fillOrder
|
||
|
||
▸ **fillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | Order struct containing order specifications. |
|
||
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
|
||
`signature` | string | Proof that order has been created by maker. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid by maker and taker.
|
||
|
||
___
|
||
|
||
### filled
|
||
|
||
▸ **filled**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/exchange.ts:3205](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/exchange.ts#L3205)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getAssetProxy
|
||
|
||
▸ **getAssetProxy**(`assetProxyId`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetProxyId` | string | Id of the asset proxy. |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
assetProxy The asset proxy address registered to assetProxyId. Returns 0x0 if no proxy is registered.
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`eventName` | [ExchangeEvents](#enumeration-exchangeevents) | The Exchange contract event you would like to subscribe to. |
|
||
`blockRange` | `BlockRange` | Block range to get logs from. |
|
||
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
|
||
|
||
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getOrderInfo
|
||
|
||
▸ **getOrderInfo**(`order`: object): *`ContractFunctionObj<object>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | Order to gather information on. |
|
||
|
||
**Returns:** *`ContractFunctionObj<object>`*
|
||
|
||
orderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description.
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### isValidHashSignature
|
||
|
||
▸ **isValidHashSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`hash` | string | Any 32-byte hash. |
|
||
`signerAddress` | string | Address that should have signed the given hash. |
|
||
`signature` | string | Proof that the hash has been signed by signer. |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
isValid `true` if the signature is valid for the given hash and signer.
|
||
|
||
___
|
||
|
||
### isValidOrderSignature
|
||
|
||
▸ **isValidOrderSignature**(`order`: object, `signature`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`order` | object | The order. |
|
||
`signature` | string | Proof that the order has been signed by signer. |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
isValid `true` if the signature is valid for the given order and signer.
|
||
|
||
___
|
||
|
||
### isValidTransactionSignature
|
||
|
||
▸ **isValidTransactionSignature**(`transaction`: object, `signature`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`transaction` | object | The transaction. |
|
||
`signature` | string | Proof that the order has been signed by signer. |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
isValid `true` if the signature is valid for the given transaction and signer.
|
||
|
||
___
|
||
|
||
### marketBuyOrdersFillOrKill
|
||
|
||
▸ **marketBuyOrdersFillOrKill**(`orders`: `Array<object>`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. |
|
||
`signatures` | string[] | Proofs that orders have been signed by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### marketBuyOrdersNoThrow
|
||
|
||
▸ **marketBuyOrdersNoThrow**(`orders`: `Array<object>`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
NOTE: This function does not enforce that the makerAsset is the same for each order.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. |
|
||
`signatures` | string[] | Proofs that orders have been signed by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### marketSellOrdersFillOrKill
|
||
|
||
▸ **marketSellOrdersFillOrKill**(`orders`: `Array<object>`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. |
|
||
`signatures` | string[] | Proofs that orders have been signed by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### marketSellOrdersNoThrow
|
||
|
||
▸ **marketSellOrdersNoThrow**(`orders`: `Array<object>`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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.
|
||
NOTE: This function does not enforce that the takerAsset is the same for each order.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications. |
|
||
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
|
||
`signatures` | string[] | Proofs that orders have been signed by makers. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
fillResults Amounts filled and fees paid by makers and taker.
|
||
|
||
___
|
||
|
||
### matchOrders
|
||
|
||
▸ **matchOrders**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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
|
||
carried out as though the orders are both being filled at the right order's price point.
|
||
The profit made by the left order goes to the taker (who matched the two orders).
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`leftOrder` | object | First order to match. |
|
||
`rightOrder` | object | Second order to match. |
|
||
`leftSignature` | string | Proof that order was created by the left maker. |
|
||
`rightSignature` | string | Proof that order was created by the right maker. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
matchedFillResults Amounts filled and fees paid by maker and taker of matched orders.
|
||
|
||
___
|
||
|
||
### matchOrdersWithMaximalFill
|
||
|
||
▸ **matchOrdersWithMaximalFill**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj<object>`*
|
||
|
||
*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
|
||
the matcher receives a profit denominated in either the left maker asset,
|
||
right maker asset, or a combination of both.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`leftOrder` | object | First order to match. |
|
||
`rightOrder` | object | Second order to match. |
|
||
`leftSignature` | string | Proof that order was created by the left maker. |
|
||
`rightSignature` | string | Proof that order was created by the right maker. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<object>`*
|
||
|
||
matchedFillResults Amounts filled by maker and taker of matched orders.
|
||
|
||
___
|
||
|
||
### orderEpoch
|
||
|
||
▸ **orderEpoch**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
`index_1` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### owner
|
||
|
||
▸ **owner**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### preSign
|
||
|
||
▸ **preSign**(`hash`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`hash` | string | Any 32-byte hash. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### preSigned
|
||
|
||
▸ **preSigned**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
`index_1` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### protocolFeeCollector
|
||
|
||
▸ **protocolFeeCollector**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### protocolFeeMultiplier
|
||
|
||
▸ **protocolFeeMultiplier**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### registerAssetProxy
|
||
|
||
▸ **registerAssetProxy**(`assetProxy`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetProxy` | string | Address of new asset proxy to register. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### setProtocolFeeCollectorAddress
|
||
|
||
▸ **setProtocolFeeCollectorAddress**(`updatedProtocolFeeCollector`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### setProtocolFeeMultiplier
|
||
|
||
▸ **setProtocolFeeMultiplier**(`updatedProtocolFeeMultiplier`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### setSignatureValidatorApproval
|
||
|
||
▸ **setSignatureValidatorApproval**(`validatorAddress`: string, `approval`: boolean): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`validatorAddress` | string | Address of Validator contract. |
|
||
`approval` | boolean | Approval or disapproval of Validator contract. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### simulateDispatchTransferFromCalls
|
||
|
||
▸ **simulateDispatchTransferFromCalls**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
|
||
`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. |
|
||
`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. |
|
||
`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
This function does not return a value. However, it will always revert with `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful.
|
||
|
||
___
|
||
|
||
### subscribe
|
||
|
||
▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
|
||
|
||
*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.
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default | Description |
|
||
------ | ------ | ------ | ------ |
|
||
`eventName` | [ExchangeEvents](#enumeration-exchangeevents) | - | The Exchange contract event you would like to subscribe to. |
|
||
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
|
||
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
|
||
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
|
||
`blockPollingIntervalMs?` | undefined \| number | - | - |
|
||
|
||
**Returns:** *string*
|
||
|
||
Subscription token used later to unsubscribe
|
||
|
||
___
|
||
|
||
### transactionsExecuted
|
||
|
||
▸ **transactionsExecuted**(`index_0`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### transferOwnership
|
||
|
||
▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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 | Description |
|
||
------ | ------ | ------ |
|
||
`newOwner` | string | New owner address. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### unsubscribe
|
||
|
||
▸ **unsubscribe**(`subscriptionToken`: string): *void*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### unsubscribeAll
|
||
|
||
▸ **unsubscribeAll**(): *void*
|
||
|
||
*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
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise<ExchangeContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<ExchangeContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise<ExchangeContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<ExchangeContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise<ExchangeContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`chainId` | `BigNumber` |
|
||
|
||
**Returns:** *`Promise<ExchangeContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ForwarderContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ForwarderContract](#class-forwardercontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ForwarderContract.deployedBytecode |
|
||
|
||
**Returns:** *[ForwarderContract](#class-forwardercontract)*
|
||
|
||
## 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* = "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<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### ERC1155_RECEIVED
|
||
|
||
▸ **ERC1155_RECEIVED**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### EXCHANGE_V2_ORDER_ID
|
||
|
||
▸ **EXCHANGE_V2_ORDER_ID**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### approveMakerAssetProxy
|
||
|
||
▸ **approveMakerAssetProxy**(`assetData`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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
|
||
Forwarder contract to the fee recipient.
|
||
This method needs to be called before forwarding orders of a maker asset that hasn't
|
||
previously been approved.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`assetData` | string | Byte array encoded for the respective asset proxy. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/forwarder.ts:757](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/forwarder.ts#L757)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ForwarderEvents](#enumeration-forwarderevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### marketBuyOrdersWithEth
|
||
|
||
▸ **marketBuyOrdersWithEth**(`orders`: `Array<object>`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `ethFeeAmounts`: `BigNumber`[], `feeRecipients`: string[]): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`*
|
||
|
||
*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
|
||
pay takerFees where takerFeeAssetData == makerAssetData (i.e. percentage fees).
|
||
Any ETH not spent will be refunded to sender.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | 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. |
|
||
`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.
|
||
|
||
___
|
||
|
||
### marketSellAmountWithEth
|
||
|
||
▸ **marketSellAmountWithEth**(`orders`: `Array<object>`, `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<object>` | 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<object>`, `signatures`: string[], `ethFeeAmounts`: `BigNumber`[], `feeRecipients`: string[]): *`ContractTxFunctionObj<[BigNumber, BigNumber]>`*
|
||
|
||
*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.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`orders` | `Array<object>` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. |
|
||
`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.
|
||
|
||
___
|
||
|
||
### onERC1155BatchReceived
|
||
|
||
▸ **onERC1155BatchReceived**(`operator`: string, `from`: string, `ids`: `BigNumber`[], `values`: `BigNumber`[], `data`: string): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
`bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
|
||
|
||
___
|
||
|
||
### onERC1155Received
|
||
|
||
▸ **onERC1155Received**(`operator`: string, `from`: string, `id`: `BigNumber`, `value`: `BigNumber`, `data`: string): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
`bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
|
||
|
||
___
|
||
|
||
### owner
|
||
|
||
▸ **owner**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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 | Description |
|
||
------ | ------ | ------ |
|
||
`newOwner` | string | New owner address. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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. 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 the asset to withdraw. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise<ForwarderContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_exchange` | string |
|
||
`_exchangeV2` | string |
|
||
`_weth` | string |
|
||
|
||
**Returns:** *`Promise<ForwarderContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise<ForwarderContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_exchange` | string |
|
||
`_exchangeV2` | string |
|
||
`_weth` | string |
|
||
|
||
**Returns:** *`Promise<ForwarderContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_exchangeV2`: string, `_weth`: string): *`Promise<ForwarderContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_exchange` | string |
|
||
`_exchangeV2` | string |
|
||
`_weth` | string |
|
||
|
||
**Returns:** *`Promise<ForwarderContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: IAssetDataContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new IAssetDataContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IAssetDataContract](#class-iassetdatacontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | IAssetDataContract.deployedBytecode |
|
||
|
||
**Returns:** *[IAssetDataContract](#class-iassetdatacontract)*
|
||
|
||
## 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* = "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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### ERC20Bridge
|
||
|
||
▸ **ERC20Bridge**(`tokenAddress`: string, `bridgeAddress`: string, `bridgeData`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### ERC20Token
|
||
|
||
▸ **ERC20Token**(`tokenAddress`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### ERC721Token
|
||
|
||
▸ **ERC721Token**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### MultiAsset
|
||
|
||
▸ **MultiAsset**(`values`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### StaticCall
|
||
|
||
▸ **StaticCall**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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_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:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IAssetDataContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IAssetDataContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IAssetDataContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IAssetDataContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IAssetDataContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IAssetDataContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: IERC20BridgeSamplerContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new IERC20BridgeSamplerContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IERC20BridgeSamplerContract](#class-ierc20bridgesamplercontract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | IERC20BridgeSamplerContract.deployedBytecode |
|
||
|
||
**Returns:** *[IERC20BridgeSamplerContract](#class-ierc20bridgesamplercontract)*
|
||
|
||
## 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* = "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<string[]>`*
|
||
|
||
*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<string[]>`*
|
||
|
||
callResults ABI-encoded results data for each call.
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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_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:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLiquidityProviderFromRegistry
|
||
|
||
▸ **getLiquidityProviderFromRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
providerAddress Address of the liquidity provider.
|
||
|
||
___
|
||
|
||
### getOrderFillableMakerAssetAmounts
|
||
|
||
▸ **getOrderFillableMakerAssetAmounts**(`orders`: `Array<object>`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<object>` | Native orders to query. |
|
||
`orderSignatures` | string[] | Signatures for each respective order in `orders`. |
|
||
`devUtilsAddress` | string | Address to the DevUtils contract. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
orderFillableMakerAssetAmounts How much maker asset can be filled by each order in `orders`.
|
||
|
||
___
|
||
|
||
### getOrderFillableTakerAssetAmounts
|
||
|
||
▸ **getOrderFillableTakerAssetAmounts**(`orders`: `Array<object>`, `orderSignatures`: string[], `devUtilsAddress`: string): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<object>` | Native orders to query. |
|
||
`orderSignatures` | string[] | Signatures for each respective order in `orders`. |
|
||
`devUtilsAddress` | string | Address to the DevUtils contract. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
orderFillableTakerAssetAmounts How much taker asset can be filled by each order in `orders`.
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### sampleBuysFromCurve
|
||
|
||
▸ **sampleBuysFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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)*
|
||
|
||
Sample buy 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). |
|
||
`makerTokenAmounts` | `BigNumber`[] | Maker token buy amount for each sample. |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromEth2Dai
|
||
|
||
▸ **sampleBuysFromEth2Dai**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromKyberNetwork
|
||
|
||
▸ **sampleBuysFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromLiquidityProviderRegistry
|
||
|
||
▸ **sampleBuysFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[], `opts`: object): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromUniswap
|
||
|
||
▸ **sampleBuysFromUniswap**(`takerToken`: string, `makerToken`: string, `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleBuysFromUniswapV2
|
||
|
||
▸ **sampleBuysFromUniswapV2**(`path`: string[], `makerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
takerTokenAmounts Taker amounts sold at each maker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromCurve
|
||
|
||
▸ **sampleSellsFromCurve**(`curveAddress`: string, `fromTokenIdx`: `BigNumber`, `toTokenIdx`: `BigNumber`, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromEth2Dai
|
||
|
||
▸ **sampleSellsFromEth2Dai**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromKyberNetwork
|
||
|
||
▸ **sampleSellsFromKyberNetwork**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromLiquidityProviderRegistry
|
||
|
||
▸ **sampleSellsFromLiquidityProviderRegistry**(`registryAddress`: string, `takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromMultiBridge
|
||
|
||
▸ **sampleSellsFromMultiBridge**(`multibridge`: string, `takerToken`: string, `intermediateToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromUniswap
|
||
|
||
▸ **sampleSellsFromUniswap**(`takerToken`: string, `makerToken`: string, `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### sampleSellsFromUniswapV2
|
||
|
||
▸ **sampleSellsFromUniswapV2**(`path`: string[], `takerTokenAmounts`: `BigNumber`[]): *`ContractFunctionObj<BigNumber[]>`*
|
||
|
||
*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<BigNumber[]>`*
|
||
|
||
makerTokenAmounts Maker amounts bought at each taker token amount.
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IERC20BridgeSamplerContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: ITransformERC20Contract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new ITransformERC20Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ITransformERC20Contract](#class-itransformerc20contract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | ITransformERC20Contract.deployedBytecode |
|
||
|
||
**Returns:** *[ITransformERC20Contract](#class-itransformerc20contract)*
|
||
|
||
## 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* = "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<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### createTransformWallet
|
||
|
||
▸ **createTransformWallet**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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_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:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ITransformERC20Events](#enumeration-itransformerc20events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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 | 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:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getQuoteSigner
|
||
|
||
▸ **getQuoteSigner**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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)*
|
||
|
||
Return the optional signer for `transformERC20()` calldata.
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getTransformWallet
|
||
|
||
▸ **getTransformWallet**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### getTransformerDeployer
|
||
|
||
▸ **getTransformerDeployer**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### setQuoteSigner
|
||
|
||
▸ **setQuoteSigner**(`quoteSigner`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### setTransformerDeployer
|
||
|
||
▸ **setTransformerDeployer**(`transformerDeployer`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<object>`): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
*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<object>` | The transformations to execute on the token balance(s) in sequence. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### 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<TxData>`, `logDecodeDependencies`: object): *`Promise<ITransformERC20Contract>`*
|
||
|
||
*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 |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ITransformERC20Contract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ITransformERC20Contract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ITransformERC20Contract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ITransformERC20Contract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<ITransformERC20Contract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: IZeroExContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new IZeroExContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `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<TxData>` | - |
|
||
`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<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### _spendERC20Tokens
|
||
|
||
▸ **_spendERC20Tokens**(`token`: string, `owner`: string, `to`: string, `amount`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### _transformERC20
|
||
|
||
▸ **_transformERC20**(`args`: object): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### batchExecuteMetaTransactions
|
||
|
||
▸ **batchExecuteMetaTransactions**(`mtxs`: `Array<object>`, `signatures`: string[]): *`ContractTxFunctionObj<string[]>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1382
|
||
|
||
Execute multiple meta-transactions.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`mtxs` | `Array<object>` | The meta-transactions. |
|
||
`signatures` | string[] | The signature by each respective `mtx.signer`. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string[]>`*
|
||
|
||
___
|
||
|
||
### createTransformWallet
|
||
|
||
▸ **createTransformWallet**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### executeMetaTransaction
|
||
|
||
▸ **executeMetaTransaction**(`mtx`: object, `signature`: string): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### extend
|
||
|
||
▸ **extend**(`selector`: string, `impl`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### 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<string>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1620
|
||
|
||
Get the address of the allowance target.
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### getFunctionImplementation
|
||
|
||
▸ **getFunctionImplementation**(`selector`: string): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### 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<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
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<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getMetaTransactionExecutedBlock
|
||
|
||
▸ **getMetaTransactionExecutedBlock**(`mtx`: object): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### getMetaTransactionHash
|
||
|
||
▸ **getMetaTransactionHash**(`mtx`: object): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### getMetaTransactionHashExecutedBlock
|
||
|
||
▸ **getMetaTransactionHashExecutedBlock**(`mtxHash`: string): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### getQuoteSigner
|
||
|
||
▸ **getQuoteSigner**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:1897
|
||
|
||
Return the optional signer for `transformERC20()` calldata.
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### getRollbackEntryAtIndex
|
||
|
||
▸ **getRollbackEntryAtIndex**(`selector`: string, `idx`: `BigNumber`): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### getRollbackLength
|
||
|
||
▸ **getRollbackLength**(`selector`: string): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### 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<BigNumber>`*
|
||
|
||
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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### getTransformWallet
|
||
|
||
▸ **getTransformWallet**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
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<string>`*
|
||
|
||
___
|
||
|
||
### getTransformerDeployer
|
||
|
||
▸ **getTransformerDeployer**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2154
|
||
|
||
Return the allowed deployer for transformers.
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### isValidHashSignature
|
||
|
||
▸ **isValidHashSignature**(`hash`: string, `signer`: string, `signature`: string): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
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<boolean>`*
|
||
|
||
___
|
||
|
||
### migrate
|
||
|
||
▸ **migrate**(`target`: string, `data`: string, `newOwner`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### owner
|
||
|
||
▸ **owner**(): *`ContractTxFunctionObj<string>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:2322
|
||
|
||
The owner of this contract.
|
||
|
||
**Returns:** *`ContractTxFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### rollback
|
||
|
||
▸ **rollback**(`selector`: string, `targetImpl`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### setQuoteSigner
|
||
|
||
▸ **setQuoteSigner**(`quoteSigner`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### setTransformerDeployer
|
||
|
||
▸ **setTransformerDeployer**(`transformerDeployer`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### transformERC20
|
||
|
||
▸ **transformERC20**(`inputToken`: string, `outputToken`: string, `inputTokenAmount`: `BigNumber`, `minOutputTokenAmount`: `BigNumber`, `transformations`: `Array<object>`): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
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<object>` | The transformations to execute on the token balance(s) in sequence. |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
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<void>`*
|
||
|
||
___
|
||
|
||
### `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<TxData>`, `logDecodeDependencies`: object): *`Promise<IZeroExContract>`*
|
||
|
||
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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IZeroExContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IZeroExContract>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:109
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IZeroExContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IZeroExContract>`*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:135
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` |
|
||
`libraryArtifacts` | object |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<IZeroExContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: StakingContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new StakingContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `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<TxData>` | - |
|
||
`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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### addExchangeAddress
|
||
|
||
▸ **addExchangeAddress**(`addr`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### authorized
|
||
|
||
▸ **authorized**(`index_0`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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<boolean>`*
|
||
|
||
___
|
||
|
||
### cobbDouglasAlphaDenominator
|
||
|
||
▸ **cobbDouglasAlphaDenominator**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### cobbDouglasAlphaNumerator
|
||
|
||
▸ **cobbDouglasAlphaNumerator**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### computeRewardBalanceOfDelegator
|
||
|
||
▸ **computeRewardBalanceOfDelegator**(`poolId`: string, `member`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
totalReward Balance in ETH.
|
||
|
||
___
|
||
|
||
### computeRewardBalanceOfOperator
|
||
|
||
▸ **computeRewardBalanceOfOperator**(`poolId`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
totalReward Balance in ETH.
|
||
|
||
___
|
||
|
||
### createStakingPool
|
||
|
||
▸ **createStakingPool**(`operatorShare`: number | `BigNumber`, `addOperatorAsMaker`: boolean): *`ContractTxFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
poolId The unique pool id generated for this pool.
|
||
|
||
___
|
||
|
||
### currentEpoch
|
||
|
||
▸ **currentEpoch**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### currentEpochStartTimeInSeconds
|
||
|
||
▸ **currentEpochStartTimeInSeconds**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### decreaseStakingPoolOperatorShare
|
||
|
||
▸ **decreaseStakingPoolOperatorShare**(`poolId`: string, `newOperatorShare`: number | `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### endEpoch
|
||
|
||
▸ **endEpoch**(): *`ContractTxFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
numPoolsToFinalize The number of unfinalized pools.
|
||
|
||
___
|
||
|
||
### epochDurationInSeconds
|
||
|
||
▸ **epochDurationInSeconds**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### finalizePool
|
||
|
||
▸ **finalizePool**(`poolId`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<string[]>`*
|
||
|
||
*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<string[]>`*
|
||
|
||
Array of authorized addresses.
|
||
|
||
___
|
||
|
||
### getCurrentEpochEarliestEndTimeInSeconds
|
||
|
||
▸ **getCurrentEpochEarliestEndTimeInSeconds**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
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<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
Global stake for given status.
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [StakingEvents](#enumeration-stakingevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getOwnerStakeByStatus
|
||
|
||
▸ **getOwnerStakeByStatus**(`staker`: string, `stakeStatus`: number | `BigNumber`): *`ContractFunctionObj<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
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<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
Stake delegated to pool by staker.
|
||
|
||
___
|
||
|
||
### getStakingPool
|
||
|
||
▸ **getStakingPool**(`poolId`: string): *`ContractFunctionObj<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
___
|
||
|
||
### getStakingPoolStatsThisEpoch
|
||
|
||
▸ **getStakingPoolStatsThisEpoch**(`poolId`: string): *`ContractFunctionObj<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
PoolStats struct for pool id.
|
||
|
||
___
|
||
|
||
### getTotalStake
|
||
|
||
▸ **getTotalStake**(`staker`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
Total ZRX staked by `staker`.
|
||
|
||
___
|
||
|
||
### getTotalStakeDelegatedToPool
|
||
|
||
▸ **getTotalStakeDelegatedToPool**(`poolId`: string): *`ContractFunctionObj<object>`*
|
||
|
||
*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<object>`*
|
||
|
||
Total stake delegated to pool.
|
||
|
||
___
|
||
|
||
### getWethContract
|
||
|
||
▸ **getWethContract**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
wethContract The WETH contract instance.
|
||
|
||
___
|
||
|
||
### getZrxVault
|
||
|
||
▸ **getZrxVault**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
zrxVault The zrxVault contract.
|
||
|
||
___
|
||
|
||
### init
|
||
|
||
▸ **init**(): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### joinStakingPoolAsMaker
|
||
|
||
▸ **joinStakingPoolAsMaker**(`poolId`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### lastPoolId
|
||
|
||
▸ **lastPoolId**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### minimumPoolStake
|
||
|
||
▸ **minimumPoolStake**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### moveStake
|
||
|
||
▸ **moveStake**(`from`: object, `to`: object, `amount`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### owner
|
||
|
||
▸ **owner**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### payProtocolFee
|
||
|
||
▸ **payProtocolFee**(`makerAddress`: string, `payerAddress`: string, `protocolFee`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### poolIdByMaker
|
||
|
||
▸ **poolIdByMaker**(`index_0`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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 |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<string>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### removeAuthorizedAddressAtIndex
|
||
|
||
▸ **removeAuthorizedAddressAtIndex**(`target`: string, `index`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### removeExchangeAddress
|
||
|
||
▸ **removeExchangeAddress**(`addr`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### rewardDelegatedStakeWeight
|
||
|
||
▸ **rewardDelegatedStakeWeight**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### rewardsByPoolId
|
||
|
||
▸ **rewardsByPoolId**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### setParams
|
||
|
||
▸ **setParams**(`_epochDurationInSeconds`: `BigNumber`, `_rewardDelegatedStakeWeight`: number | `BigNumber`, `_minimumPoolStake`: `BigNumber`, `_cobbDouglasAlphaNumerator`: number | `BigNumber`, `_cobbDouglasAlphaDenominator`: number | `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### stake
|
||
|
||
▸ **stake**(`amount`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### stakingContract
|
||
|
||
▸ **stakingContract**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### unstake
|
||
|
||
▸ **unstake**(`amount`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<boolean>`*
|
||
|
||
*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<boolean>`*
|
||
|
||
___
|
||
|
||
### wethReservedForPoolRewards
|
||
|
||
▸ **wethReservedForPoolRewards**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### withdrawDelegatorRewards
|
||
|
||
▸ **withdrawDelegatorRewards**(`poolId`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<StakingContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<StakingContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<StakingContract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<StakingContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<StakingContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<StakingContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: StakingProxyContract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new StakingProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `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<TxData>` | - |
|
||
`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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### attachStakingContract
|
||
|
||
▸ **attachStakingContract**(`_stakingContract`: string): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### authorities
|
||
|
||
▸ **authorities**(`index_0`: `BigNumber`): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### authorized
|
||
|
||
▸ **authorized**(`index_0`: string): *`ContractFunctionObj<boolean>`*
|
||
|
||
*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<boolean>`*
|
||
|
||
___
|
||
|
||
### batchExecute
|
||
|
||
▸ **batchExecute**(`data`: string[]): *`ContractTxFunctionObj<string[]>`*
|
||
|
||
*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<string[]>`*
|
||
|
||
___
|
||
|
||
### cobbDouglasAlphaDenominator
|
||
|
||
▸ **cobbDouglasAlphaDenominator**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### cobbDouglasAlphaNumerator
|
||
|
||
▸ **cobbDouglasAlphaNumerator**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### currentEpoch
|
||
|
||
▸ **currentEpoch**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### currentEpochStartTimeInSeconds
|
||
|
||
▸ **currentEpochStartTimeInSeconds**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### detachStakingContract
|
||
|
||
▸ **detachStakingContract**(): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### epochDurationInSeconds
|
||
|
||
▸ **epochDurationInSeconds**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### 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<string[]>`*
|
||
|
||
*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<string[]>`*
|
||
|
||
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<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
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<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### minimumPoolStake
|
||
|
||
▸ **minimumPoolStake**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### owner
|
||
|
||
▸ **owner**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### poolIdByMaker
|
||
|
||
▸ **poolIdByMaker**(`index_0`: string): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### removeAuthorizedAddressAtIndex
|
||
|
||
▸ **removeAuthorizedAddressAtIndex**(`target`: string, `index`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### rewardDelegatedStakeWeight
|
||
|
||
▸ **rewardDelegatedStakeWeight**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### rewardsByPoolId
|
||
|
||
▸ **rewardsByPoolId**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### stakingContract
|
||
|
||
▸ **stakingContract**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### 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<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### 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<boolean>`*
|
||
|
||
*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<boolean>`*
|
||
|
||
___
|
||
|
||
### wethReservedForPoolRewards
|
||
|
||
▸ **wethReservedForPoolRewards**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### `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<TxData>`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise<StakingProxyContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_stakingContract` | string |
|
||
|
||
**Returns:** *`Promise<StakingProxyContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise<StakingProxyContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_stakingContract` | string |
|
||
|
||
**Returns:** *`Promise<StakingProxyContract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_stakingContract`: string): *`Promise<StakingProxyContract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
`_stakingContract` | string |
|
||
|
||
**Returns:** *`Promise<StakingProxyContract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: WETH9Contract
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)*
|
||
|
||
*Overrides void*
|
||
|
||
*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:**
|
||
|
||
Name | Type | Default |
|
||
------ | ------ | ------ |
|
||
`address` | string | - |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
|
||
`txDefaults?` | `Partial<TxData>` | - |
|
||
`logDecodeDependencies?` | undefined \| object | - |
|
||
`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode |
|
||
|
||
**Returns:** *[WETH9Contract](#class-weth9contract)*
|
||
|
||
## 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* = "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
|
||
|
||
### allowance
|
||
|
||
▸ **allowance**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
`index_1` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### approve
|
||
|
||
▸ **approve**(`guy`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`guy` | string |
|
||
`wad` | `BigNumber` |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### balanceOf
|
||
|
||
▸ **balanceOf**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`index_0` | string |
|
||
|
||
**Returns:** *`ContractFunctionObj<BigNumber>`*
|
||
|
||
___
|
||
|
||
### decimals
|
||
|
||
▸ **decimals**(): *`ContractFunctionObj<number>`*
|
||
|
||
*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<number>`*
|
||
|
||
___
|
||
|
||
### deposit
|
||
|
||
▸ **deposit**(): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### getABIDecodedReturnData
|
||
|
||
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
|
||
|
||
*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:**
|
||
|
||
▪ **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/weth9.ts:529](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/generated-wrappers/weth9.ts#L529)*
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **T**
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
`callData` | string |
|
||
|
||
**Returns:** *`T`*
|
||
|
||
___
|
||
|
||
### getFunctionSignature
|
||
|
||
▸ **getFunctionSignature**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### getLogsAsync
|
||
|
||
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
*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
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`eventName` | [WETH9Events](#enumeration-weth9events) | The WETH9 contract event you would like to subscribe to. |
|
||
`blockRange` | `BlockRange` | Block range to get logs from. |
|
||
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
|
||
|
||
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
|
||
|
||
Array of logs that match the parameters
|
||
|
||
___
|
||
|
||
### getSelector
|
||
|
||
▸ **getSelector**(`methodName`: string): *string*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`methodName` | string |
|
||
|
||
**Returns:** *string*
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
▸ **name**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### subscribe
|
||
|
||
▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
|
||
|
||
*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.
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Default | Description |
|
||
------ | ------ | ------ | ------ |
|
||
`eventName` | [WETH9Events](#enumeration-weth9events) | - | The WETH9 contract event you would like to subscribe to. |
|
||
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
|
||
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
|
||
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
|
||
`blockPollingIntervalMs?` | undefined \| number | - | - |
|
||
|
||
**Returns:** *string*
|
||
|
||
Subscription token used later to unsubscribe
|
||
|
||
___
|
||
|
||
### symbol
|
||
|
||
▸ **symbol**(): *`ContractFunctionObj<string>`*
|
||
|
||
*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<string>`*
|
||
|
||
___
|
||
|
||
### totalSupply
|
||
|
||
▸ **totalSupply**(): *`ContractFunctionObj<BigNumber>`*
|
||
|
||
*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<BigNumber>`*
|
||
|
||
___
|
||
|
||
### transfer
|
||
|
||
▸ **transfer**(`dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`dst` | string |
|
||
`wad` | `BigNumber` |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### transferFrom
|
||
|
||
▸ **transferFrom**(`src`: string, `dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`src` | string |
|
||
`dst` | string |
|
||
`wad` | `BigNumber` |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<boolean>`*
|
||
|
||
___
|
||
|
||
### unsubscribe
|
||
|
||
▸ **unsubscribe**(`subscriptionToken`: string): *void*
|
||
|
||
*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
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### unsubscribeAll
|
||
|
||
▸ **unsubscribeAll**(): *void*
|
||
|
||
*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
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### withdraw
|
||
|
||
▸ **withdraw**(`wad`: `BigNumber`): *`ContractTxFunctionObj<void>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`wad` | `BigNumber` |
|
||
|
||
**Returns:** *`ContractTxFunctionObj<void>`*
|
||
|
||
___
|
||
|
||
### `Static` ABI
|
||
|
||
▸ **ABI**(): *[ContractAbi](#contractabi)*
|
||
|
||
*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)*
|
||
|
||
The contract ABI
|
||
|
||
___
|
||
|
||
### `Static` deployAsync
|
||
|
||
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<WETH9Contract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`bytecode` | string |
|
||
`abi` | [ContractAbi](#contractabi) |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<WETH9Contract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployFrom0xArtifactAsync
|
||
|
||
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<WETH9Contract>`*
|
||
|
||
*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:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
|
||
`supportedProvider` | [SupportedProvider](#supportedprovider) |
|
||
`txDefaults` | `Partial<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<WETH9Contract>`*
|
||
|
||
___
|
||
|
||
### `Static` deployWithLibrariesFrom0xArtifactAsync
|
||
|
||
▸ **deployWithLibrariesFrom0xArtifactAsync**(`artifact`: `ContractArtifact`, `libraryArtifacts`: object, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<WETH9Contract>`*
|
||
|
||
*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<TxData>` |
|
||
`logDecodeDependencies` | object |
|
||
|
||
**Returns:** *`Promise<WETH9Contract>`*
|
||
|
||
___
|
||
|
||
### `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*
|
||
|
||
<hr />
|
||
|
||
# Class: AbiDecoder
|
||
|
||
AbiDecoder allows you to decode event logs given a set of supplied contract ABI's. It takes the contract's event
|
||
signature from the ABI and attempts to decode the logs using it.
|
||
|
||
|
||
## Constructors
|
||
|
||
|
||
|
||
\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)*
|
||
|
||
*Defined in [utils/src/abi_decoder.ts:39](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L39)*
|
||
|
||
Instantiate an AbiDecoder
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's |
|
||
|
||
**Returns:** *[AbiDecoder](#class-abidecoder)*
|
||
|
||
AbiDecoder instance
|
||
|
||
## Methods
|
||
|
||
### addABI
|
||
|
||
▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void*
|
||
|
||
*Defined in [utils/src/abi_decoder.ts: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
|
||
have the same signature but different parameter names, then their ABI definitions can be disambiguated
|
||
by specifying a contract name.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`abiArray` | [AbiDefinition](#abidefinition)[] | - |
|
||
`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### decodeCalldataOrThrow
|
||
|
||
▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`*
|
||
|
||
*Defined in [utils/src/abi_decoder.ts:110](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/utils/src/abi_decoder.ts#L110)*
|
||
|
||
Decodes calldata for a known ABI.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`calldata` | string | hex-encoded calldata. |
|
||
`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). |
|
||
|
||
**Returns:** *`DecodedCalldata`*
|
||
|
||
Decoded calldata. Includes: function name and signature, along with the decoded arguments.
|
||
|
||
___
|
||
|
||
### tryToDecodeLogOrNoop
|
||
|
||
▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs<ArgsType>` | [RawLog](#rawlog)*
|
||
|
||
*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.
|
||
|
||
**Type parameters:**
|
||
|
||
▪ **ArgsType**: *`DecodedLogArgs`*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`log` | `LogEntry` | The log to attempt to decode |
|
||
|
||
**Returns:** *`LogWithDecodedArgs<ArgsType>` | [RawLog](#rawlog)*
|
||
|
||
The decoded log if the requisite ABI was available. Otherwise the log unaltered.
|
||
|
||
<hr />
|
||
|
||
# Enumeration: SubscriptionErrors
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### SubscriptionAlreadyPresent
|
||
|
||
• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT"
|
||
|
||
*Defined in [base-contract/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L21)*
|
||
|
||
___
|
||
|
||
### SubscriptionNotFound
|
||
|
||
• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND"
|
||
|
||
*Defined in [base-contract/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L20)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
# Enumeration: ERC20TokenEvents
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### Approval
|
||
|
||
• **Approval**: = "Approval"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Transfer
|
||
|
||
• **Transfer**: = "Transfer"
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Enumeration: ERC721TokenEvents
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### Approval
|
||
|
||
• **Approval**: = "Approval"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### ApprovalForAll
|
||
|
||
• **ApprovalForAll**: = "ApprovalForAll"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Transfer
|
||
|
||
• **Transfer**: = "Transfer"
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Enumeration: ExchangeEvents
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### AssetProxyRegistered
|
||
|
||
• **AssetProxyRegistered**: = "AssetProxyRegistered"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Cancel
|
||
|
||
• **Cancel**: = "Cancel"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### CancelUpTo
|
||
|
||
• **CancelUpTo**: = "CancelUpTo"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Fill
|
||
|
||
• **Fill**: = "Fill"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### ProtocolFeeCollectorAddress
|
||
|
||
• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### ProtocolFeeMultiplier
|
||
|
||
• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### SignatureValidatorApproval
|
||
|
||
• **SignatureValidatorApproval**: = "SignatureValidatorApproval"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### TransactionExecution
|
||
|
||
• **TransactionExecution**: = "TransactionExecution"
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# Enumeration: WETH9Events
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### Approval
|
||
|
||
• **Approval**: = "Approval"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Deposit
|
||
|
||
• **Deposit**: = "Deposit"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Transfer
|
||
|
||
• **Transfer**: = "Transfer"
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### Withdrawal
|
||
|
||
• **Withdrawal**: = "Withdrawal"
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Enumeration: ContractError
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### ContractNotDeployedOnChain
|
||
|
||
• **ContractNotDeployedOnChain**: = "CONTRACT_NOT_DEPLOYED_ON_CHAIN"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L9)*
|
||
|
||
___
|
||
|
||
### ERC721NoApproval
|
||
|
||
• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L19)*
|
||
|
||
___
|
||
|
||
### ERC721OwnerNotFound
|
||
|
||
• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L18)*
|
||
|
||
___
|
||
|
||
### InsufficientAllowanceForTransfer
|
||
|
||
• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L10)*
|
||
|
||
___
|
||
|
||
### InsufficientBalanceForTransfer
|
||
|
||
• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L11)*
|
||
|
||
___
|
||
|
||
### InsufficientEthBalanceForDeposit
|
||
|
||
• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L12)*
|
||
|
||
___
|
||
|
||
### InsufficientWEthBalanceForWithdrawal
|
||
|
||
• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L13)*
|
||
|
||
___
|
||
|
||
### InvalidJump
|
||
|
||
• **InvalidJump**: = "INVALID_JUMP"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L14)*
|
||
|
||
___
|
||
|
||
### OutOfGas
|
||
|
||
• **OutOfGas**: = "OUT_OF_GAS"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L15)*
|
||
|
||
___
|
||
|
||
### SignatureRequestDenied
|
||
|
||
• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L20)*
|
||
|
||
___
|
||
|
||
### SubscriptionAlreadyPresent
|
||
|
||
• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L17)*
|
||
|
||
___
|
||
|
||
### SubscriptionNotFound
|
||
|
||
• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L16)*
|
||
|
||
<hr />
|
||
|
||
# Enumeration: ForwarderError
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### CompleteFillFailed
|
||
|
||
• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED"
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L5)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
# Enumeration: BlockParamLiteral
|
||
|
||
|
||
## Enumeration members
|
||
|
||
### Earliest
|
||
|
||
• **Earliest**: = "earliest"
|
||
|
||
*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L488)*
|
||
|
||
___
|
||
|
||
### Latest
|
||
|
||
• **Latest**: = "latest"
|
||
|
||
*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L489)*
|
||
|
||
___
|
||
|
||
### Pending
|
||
|
||
• **Pending**: = "pending"
|
||
|
||
*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L490)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# 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/b1b9949e7/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/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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractEvent <**ContractEventArgs**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **ContractEventArgs**
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Defined in [base-contract/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L13)*
|
||
|
||
___
|
||
|
||
### args
|
||
|
||
• **args**: *`ContractEventArgs`*
|
||
|
||
*Defined in [base-contract/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L16)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractFunctionObj <**T**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **T**
|
||
|
||
|
||
## Methods
|
||
|
||
### callAsync
|
||
|
||
▸ **callAsync**(`callData?`: `Partial<CallData>`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<T>`*
|
||
|
||
*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<CallData>` |
|
||
`defaultBlock?` | [BlockParam](#blockparam) |
|
||
|
||
**Returns:** *`Promise<T>`*
|
||
|
||
___
|
||
|
||
### getABIEncodedTransactionData
|
||
|
||
▸ **getABIEncodedTransactionData**(): *string*
|
||
|
||
*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*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractTxFunctionObj <**T**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **T**
|
||
|
||
|
||
## Methods
|
||
|
||
### awaitTransactionSuccessAsync
|
||
|
||
▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial<TxData>`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash<TransactionReceiptWithDecodedLogs>`*
|
||
|
||
*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L50)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`txData?` | `Partial<TxData>` |
|
||
`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) |
|
||
|
||
**Returns:** *`PromiseWithTransactionHash<TransactionReceiptWithDecodedLogs>`*
|
||
|
||
___
|
||
|
||
### callAsync
|
||
|
||
▸ **callAsync**(`callData?`: `Partial<CallData>`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<T>`*
|
||
|
||
*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<CallData>` |
|
||
`defaultBlock?` | [BlockParam](#blockparam) |
|
||
|
||
**Returns:** *`Promise<T>`*
|
||
|
||
___
|
||
|
||
### estimateGasAsync
|
||
|
||
▸ **estimateGasAsync**(`txData?`: `Partial<TxData>`): *`Promise<number>`*
|
||
|
||
*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<TxData>` |
|
||
|
||
**Returns:** *`Promise<number>`*
|
||
|
||
___
|
||
|
||
### 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<TxData>`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise<string>`*
|
||
|
||
*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<TxData>` |
|
||
`opts?` | [SendTransactionOpts](#class-sendtransactionopts) |
|
||
|
||
**Returns:** *`Promise<string>`*
|
||
|
||
<hr />
|
||
|
||
# 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.
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` shouldValidate
|
||
|
||
• **shouldValidate**? : *undefined | false | true*
|
||
|
||
*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/base-contract/src/types.ts#L30)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractAddresses
|
||
|
||
|
||
## Properties
|
||
|
||
### assetProxyOwner
|
||
|
||
• **assetProxyOwner**: *string*
|
||
|
||
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L10)*
|
||
|
||
___
|
||
|
||
### balancerBridge
|
||
|
||
• **balancerBridge**: *string*
|
||
|
||
*Defined in [contract-addresses/src/index.ts:37](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-addresses/src/index.ts#L37)*
|
||
|
||
___
|
||
|
||
### broker
|
||
|
||
• **broker**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ERC20TokenApprovalEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_owner](#_owner)
|
||
* [_spender](#_spender)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _spender
|
||
|
||
• **_spender**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ERC20TokenTransferEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_from](#_from)
|
||
* [_to](#_to)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _from
|
||
|
||
• **_from**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _to
|
||
|
||
• **_to**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ERC721TokenApprovalEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_approved](#_approved)
|
||
* [_owner](#_owner)
|
||
* [_tokenId](#_tokenid)
|
||
|
||
## Properties
|
||
|
||
### _approved
|
||
|
||
• **_approved**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _tokenId
|
||
|
||
• **_tokenId**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ERC721TokenApprovalForAllEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_approved](#_approved)
|
||
* [_operator](#_operator)
|
||
* [_owner](#_owner)
|
||
|
||
## Properties
|
||
|
||
### _approved
|
||
|
||
• **_approved**: *boolean*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _operator
|
||
|
||
• **_operator**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ERC721TokenTransferEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_from](#_from)
|
||
* [_to](#_to)
|
||
* [_tokenId](#_tokenid)
|
||
|
||
## Properties
|
||
|
||
### _from
|
||
|
||
• **_from**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _to
|
||
|
||
• **_to**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _tokenId
|
||
|
||
• **_tokenId**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeAssetProxyRegisteredEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [assetProxy](#assetproxy)
|
||
* [id](#id)
|
||
|
||
## Properties
|
||
|
||
### assetProxy
|
||
|
||
• **assetProxy**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### id
|
||
|
||
• **id**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeCancelEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [feeRecipientAddress](#feerecipientaddress)
|
||
* [makerAddress](#makeraddress)
|
||
* [makerAssetData](#makerassetdata)
|
||
* [orderHash](#orderhash)
|
||
* [senderAddress](#senderaddress)
|
||
* [takerAssetData](#takerassetdata)
|
||
|
||
## Properties
|
||
|
||
### feeRecipientAddress
|
||
|
||
• **feeRecipientAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerAddress
|
||
|
||
• **makerAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerAssetData
|
||
|
||
• **makerAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### orderHash
|
||
|
||
• **orderHash**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### senderAddress
|
||
|
||
• **senderAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerAssetData
|
||
|
||
• **takerAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeCancelUpToEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [makerAddress](#makeraddress)
|
||
* [orderEpoch](#orderepoch)
|
||
* [orderSenderAddress](#ordersenderaddress)
|
||
|
||
## Properties
|
||
|
||
### makerAddress
|
||
|
||
• **makerAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### orderEpoch
|
||
|
||
• **orderEpoch**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### orderSenderAddress
|
||
|
||
• **orderSenderAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeFillEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [feeRecipientAddress](#feerecipientaddress)
|
||
* [makerAddress](#makeraddress)
|
||
* [makerAssetData](#makerassetdata)
|
||
* [makerAssetFilledAmount](#makerassetfilledamount)
|
||
* [makerFeeAssetData](#makerfeeassetdata)
|
||
* [makerFeePaid](#makerfeepaid)
|
||
* [orderHash](#orderhash)
|
||
* [protocolFeePaid](#protocolfeepaid)
|
||
* [senderAddress](#senderaddress)
|
||
* [takerAddress](#takeraddress)
|
||
* [takerAssetData](#takerassetdata)
|
||
* [takerAssetFilledAmount](#takerassetfilledamount)
|
||
* [takerFeeAssetData](#takerfeeassetdata)
|
||
* [takerFeePaid](#takerfeepaid)
|
||
|
||
## Properties
|
||
|
||
### feeRecipientAddress
|
||
|
||
• **feeRecipientAddress**: *string*
|
||
|
||
*Defined in [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)*
|
||
|
||
___
|
||
|
||
### makerAddress
|
||
|
||
• **makerAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerAssetData
|
||
|
||
• **makerAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerAssetFilledAmount
|
||
|
||
• **makerAssetFilledAmount**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerFeeAssetData
|
||
|
||
• **makerFeeAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### makerFeePaid
|
||
|
||
• **makerFeePaid**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### orderHash
|
||
|
||
• **orderHash**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### protocolFeePaid
|
||
|
||
• **protocolFeePaid**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### senderAddress
|
||
|
||
• **senderAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerAddress
|
||
|
||
• **takerAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerAssetData
|
||
|
||
• **takerAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerAssetFilledAmount
|
||
|
||
• **takerAssetFilledAmount**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerFeeAssetData
|
||
|
||
• **takerFeeAssetData**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### takerFeePaid
|
||
|
||
• **takerFeePaid**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeProtocolFeeCollectorAddressEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [oldProtocolFeeCollector](#oldprotocolfeecollector)
|
||
* [updatedProtocolFeeCollector](#updatedprotocolfeecollector)
|
||
|
||
## Properties
|
||
|
||
### oldProtocolFeeCollector
|
||
|
||
• **oldProtocolFeeCollector**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### updatedProtocolFeeCollector
|
||
|
||
• **updatedProtocolFeeCollector**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeProtocolFeeMultiplierEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier)
|
||
* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier)
|
||
|
||
## Properties
|
||
|
||
### oldProtocolFeeMultiplier
|
||
|
||
• **oldProtocolFeeMultiplier**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### updatedProtocolFeeMultiplier
|
||
|
||
• **updatedProtocolFeeMultiplier**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeSignatureValidatorApprovalEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [isApproved](#isapproved)
|
||
* [signerAddress](#signeraddress)
|
||
* [validatorAddress](#validatoraddress)
|
||
|
||
## Properties
|
||
|
||
### isApproved
|
||
|
||
• **isApproved**: *boolean*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### signerAddress
|
||
|
||
• **signerAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### validatorAddress
|
||
|
||
• **validatorAddress**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ExchangeTransactionExecutionEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [transactionHash](#transactionhash)
|
||
|
||
## Properties
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# Interface: IZeroExQuoteSignerUpdatedEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [quoteSigner](#quotesigner)
|
||
|
||
## Properties
|
||
|
||
### quoteSigner
|
||
|
||
• **quoteSigner**: *string*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:82
|
||
|
||
<hr />
|
||
|
||
# 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
|
||
|
||
<hr />
|
||
|
||
# Interface: IZeroExTransformerDeployerUpdatedEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [transformerDeployer](#transformerdeployer)
|
||
|
||
## Properties
|
||
|
||
### transformerDeployer
|
||
|
||
• **transformerDeployer**: *string*
|
||
|
||
Defined in contract-wrappers/src/generated-wrappers/i_zero_ex.ts:94
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# 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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: StakingProxyStakingContractDetachedFromProxyEventArgs
|
||
|
||
|
||
## Hierarchy
|
||
|
||
* `DecodedLogArgs`
|
||
|
||
* **WETH9ApprovalEventArgs**
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_owner](#_owner)
|
||
* [_spender](#_spender)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _spender
|
||
|
||
• **_spender**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: WETH9DepositEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_owner](#_owner)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: WETH9TransferEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_from](#_from)
|
||
* [_to](#_to)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _from
|
||
|
||
• **_from**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _to
|
||
|
||
• **_to**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: WETH9WithdrawalEventArgs
|
||
|
||
|
||
## Index
|
||
|
||
### Properties
|
||
|
||
* [_owner](#_owner)
|
||
* [_value](#_value)
|
||
|
||
## Properties
|
||
|
||
### _owner
|
||
|
||
• **_owner**: *string*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### _value
|
||
|
||
• **_value**: *`BigNumber`*
|
||
|
||
*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)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractWrappersConfig
|
||
|
||
chainId: The id of the underlying ethereum chain your provider is connected to. (1-mainnet, 3-ropsten, 4-rinkeby, 42-kovan, 1337-testrpc)
|
||
gasPrice: Gas price to use with every transaction
|
||
contractAddresses: The address of all contracts to use. Defaults to the known addresses based on chainId.
|
||
blockPollingIntervalMs: The interval to use for block polling in event watching methods (defaults to 1000)
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` blockPollingIntervalMs
|
||
|
||
• **blockPollingIntervalMs**? : *undefined | number*
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L33)*
|
||
|
||
___
|
||
|
||
### chainId
|
||
|
||
• **chainId**: *number*
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L30)*
|
||
|
||
___
|
||
|
||
### `Optional` contractAddresses
|
||
|
||
• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)*
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L32)*
|
||
|
||
___
|
||
|
||
### `Optional` gasPrice
|
||
|
||
• **gasPrice**? : *`BigNumber`*
|
||
|
||
*Defined in [contract-wrappers/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/contract-wrappers/src/types.ts#L31)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: BlockRange
|
||
|
||
|
||
## Properties
|
||
|
||
### fromBlock
|
||
|
||
• **fromBlock**: *[BlockParam](#blockparam)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:759](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L759)*
|
||
|
||
___
|
||
|
||
### toBlock
|
||
|
||
• **toBlock**: *[BlockParam](#blockparam)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:760](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L760)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: CallData
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` data
|
||
|
||
• **data**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)*
|
||
|
||
___
|
||
|
||
### `Optional` from
|
||
|
||
• **from**? : *undefined | string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L411)*
|
||
|
||
___
|
||
|
||
### `Optional` gas
|
||
|
||
• **gas**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)*
|
||
|
||
___
|
||
|
||
### `Optional` gasPrice
|
||
|
||
• **gasPrice**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)*
|
||
|
||
___
|
||
|
||
### `Optional` nonce
|
||
|
||
• **nonce**? : *undefined | number*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
|
||
|
||
*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)*
|
||
|
||
___
|
||
|
||
### `Optional` to
|
||
|
||
• **to**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)*
|
||
|
||
___
|
||
|
||
### `Optional` value
|
||
|
||
• **value**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L391)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: CompilerOpts
|
||
|
||
|
||
## Properties
|
||
|
||
### name
|
||
|
||
• **name**: *"solc"*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:672](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L672)*
|
||
|
||
___
|
||
|
||
### settings
|
||
|
||
• **settings**: *[CompilerSettings](#class-compilersettings)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L674)*
|
||
|
||
___
|
||
|
||
### version
|
||
|
||
• **version**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:673](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L673)*
|
||
|
||
<hr />
|
||
|
||
# Interface: CompilerSettings
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` evmVersion
|
||
|
||
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:706](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L706)*
|
||
|
||
___
|
||
|
||
### `Optional` libraries
|
||
|
||
• **libraries**? : *undefined | object*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L708)*
|
||
|
||
___
|
||
|
||
### `Optional` metadata
|
||
|
||
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:707](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L707)*
|
||
|
||
___
|
||
|
||
### `Optional` optimizer
|
||
|
||
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L705)*
|
||
|
||
___
|
||
|
||
### outputSelection
|
||
|
||
• **outputSelection**: *object*
|
||
|
||
*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:
|
||
|
||
● \[▪ **fileName**: *string*\]: object
|
||
|
||
● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[]
|
||
|
||
___
|
||
|
||
### `Optional` remappings
|
||
|
||
• **remappings**? : *string[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L704)*
|
||
|
||
<hr />
|
||
|
||
# Interface: CompilerSettingsMetadata
|
||
|
||
|
||
## Properties
|
||
|
||
### useLiteralContent
|
||
|
||
• **useLiteralContent**: *true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L721)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ConstructorAbi
|
||
|
||
|
||
## Properties
|
||
|
||
### inputs
|
||
|
||
• **inputs**: *[DataItem](#class-dataitem)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L103)*
|
||
|
||
___
|
||
|
||
### payable
|
||
|
||
• **payable**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L104)*
|
||
|
||
___
|
||
|
||
### stateMutability
|
||
|
||
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L105)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L102)*
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractArtifact
|
||
|
||
This type defines the schema of the artifact.json file generated by Sol-compiler
|
||
schemaVersion: The version of the artifact schema
|
||
contractName: The contract name it represents
|
||
chains: Chain specific information by chain (address, id, constructor args, etc...)
|
||
compilerOutput: The Solidity compiler output generated from the specified compiler input
|
||
description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description)
|
||
compiler: The compiler settings used
|
||
sourceCodes: The source code of the contract and all it's dependencies
|
||
sources: A mapping from source filePath to sourceMap id
|
||
sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies.
|
||
If any of the sources change, the hash would change notifying us that a re-compilation is necessary
|
||
|
||
|
||
## Properties
|
||
|
||
### chains
|
||
|
||
• **chains**: *[ContractChains](#class-contractchains)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L693)*
|
||
|
||
___
|
||
|
||
### compiler
|
||
|
||
• **compiler**: *[CompilerOpts](#class-compileropts)*
|
||
|
||
*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L658)*
|
||
|
||
___
|
||
|
||
### compilerOutput
|
||
|
||
• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)*
|
||
|
||
*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L668)*
|
||
|
||
___
|
||
|
||
### contractName
|
||
|
||
• **contractName**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L692)*
|
||
|
||
___
|
||
|
||
### schemaVersion
|
||
|
||
• **schemaVersion**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L691)*
|
||
|
||
___
|
||
|
||
### sourceCodes
|
||
|
||
• **sourceCodes**: *object*
|
||
|
||
*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)*
|
||
|
||
*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:
|
||
|
||
● \[▪ **sourceName**: *string*\]: string
|
||
|
||
___
|
||
|
||
### sourceTreeHashHex
|
||
|
||
• **sourceTreeHashHex**: *string*
|
||
|
||
*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L667)*
|
||
|
||
___
|
||
|
||
### sources
|
||
|
||
• **sources**: *object*
|
||
|
||
*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)*
|
||
|
||
*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:
|
||
|
||
● \[▪ **sourceName**: *string*\]: object
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractChainData
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L564)*
|
||
|
||
___
|
||
|
||
Args
|
||
|
||
• **constructorArgs**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:568](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L568)*
|
||
|
||
___
|
||
|
||
### links
|
||
|
||
• **links**: *object*
|
||
|
||
*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:
|
||
|
||
● \[▪ **linkName**: *string*\]: string
|
||
|
||
<hr />
|
||
|
||
# Interface: ContractChains
|
||
|
||
|
||
## Hierarchy
|
||
|
||
* **ContractVersionData**
|
||
|
||
* [ContractArtifact](#class-contractartifact)
|
||
|
||
|
||
## Properties
|
||
|
||
### compiler
|
||
|
||
• **compiler**: *[CompilerOpts](#class-compileropts)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L658)*
|
||
|
||
___
|
||
|
||
### compilerOutput
|
||
|
||
• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L668)*
|
||
|
||
___
|
||
|
||
### sourceCodes
|
||
|
||
• **sourceCodes**: *object*
|
||
|
||
*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:
|
||
|
||
● \[▪ **sourceName**: *string*\]: string
|
||
|
||
___
|
||
|
||
### sourceTreeHashHex
|
||
|
||
• **sourceTreeHashHex**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L667)*
|
||
|
||
___
|
||
|
||
### sources
|
||
|
||
• **sources**: *object*
|
||
|
||
*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:
|
||
|
||
● \[▪ **sourceName**: *string*\]: object
|
||
|
||
<hr />
|
||
|
||
# Interface: DataItem
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` components
|
||
|
||
• **components**? : *[DataItem](#class-dataitem)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L138)*
|
||
|
||
___
|
||
|
||
### `Optional` internalType
|
||
|
||
• **internalType**? : *undefined | string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L137)*
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
• **name**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L135)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L136)*
|
||
|
||
<hr />
|
||
|
||
# Interface: DecodedLogArgs
|
||
|
||
|
||
## Type parameters
|
||
|
||
▪ **A**
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)*
|
||
|
||
___
|
||
|
||
### args
|
||
|
||
• **args**: *`A`*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)*
|
||
|
||
___
|
||
|
||
### blockNumber
|
||
|
||
• **blockNumber**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)*
|
||
|
||
___
|
||
|
||
### data
|
||
|
||
• **data**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)*
|
||
|
||
___
|
||
|
||
### event
|
||
|
||
• **event**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)*
|
||
|
||
___
|
||
|
||
### logIndex
|
||
|
||
• **logIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)*
|
||
|
||
___
|
||
|
||
### topics
|
||
|
||
• **topics**: *string[]*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)*
|
||
|
||
___
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)*
|
||
|
||
___
|
||
|
||
### transactionIndex
|
||
|
||
• **transactionIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
|
||
|
||
<hr />
|
||
|
||
# Interface: DecodedLogEntryEvent <**A**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **A**
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)*
|
||
|
||
___
|
||
|
||
### args
|
||
|
||
• **args**: *`A`*
|
||
|
||
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)*
|
||
|
||
___
|
||
|
||
### blockNumber
|
||
|
||
• **blockNumber**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)*
|
||
|
||
___
|
||
|
||
### data
|
||
|
||
• **data**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)*
|
||
|
||
___
|
||
|
||
### event
|
||
|
||
• **event**: *string*
|
||
|
||
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)*
|
||
|
||
___
|
||
|
||
### logIndex
|
||
|
||
• **logIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)*
|
||
|
||
___
|
||
|
||
### removed
|
||
|
||
• **removed**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L431)*
|
||
|
||
___
|
||
|
||
### topics
|
||
|
||
• **topics**: *string[]*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)*
|
||
|
||
___
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)*
|
||
|
||
___
|
||
|
||
### transactionIndex
|
||
|
||
• **transactionIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
|
||
|
||
<hr />
|
||
|
||
# Interface: DevdocOutput
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` author
|
||
|
||
• **author**? : *undefined | string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:645](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L645)*
|
||
|
||
___
|
||
|
||
### methods
|
||
|
||
• **methods**: *object*
|
||
|
||
*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:
|
||
|
||
● \[▪ **signature**: *string*\]: object
|
||
|
||
___
|
||
|
||
### `Optional` title
|
||
|
||
• **title**? : *undefined | string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:644](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L644)*
|
||
|
||
<hr />
|
||
|
||
# Interface: EIP1193Provider
|
||
|
||
|
||
## Properties
|
||
|
||
### isEIP1193
|
||
|
||
• **isEIP1193**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L73)*
|
||
|
||
## Methods
|
||
|
||
### on
|
||
|
||
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L75)*
|
||
|
||
**Parameters:**
|
||
|
||
▪ **event**: *[EIP1193Event](#eip1193event)*
|
||
|
||
▪ **listener**: *function*
|
||
|
||
▸ (`result`: any): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`result` | any |
|
||
|
||
**Returns:** *this*
|
||
|
||
___
|
||
|
||
### send
|
||
|
||
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L74)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`method` | string |
|
||
`params?` | any[] |
|
||
|
||
**Returns:** *`Promise<any>`*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: EvmBytecodeOutput
|
||
|
||
|
||
## 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:633](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L633)*
|
||
|
||
___
|
||
|
||
### sourceMap
|
||
|
||
• **sourceMap**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L634)*
|
||
|
||
<hr />
|
||
|
||
# Interface: EvmBytecodeOutputLinkReferences
|
||
|
||
|
||
## Hierarchy
|
||
|
||
* **EvmOutput**
|
||
|
||
|
||
## Properties
|
||
|
||
### bytecode
|
||
|
||
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L627)*
|
||
|
||
___
|
||
|
||
### deployedBytecode
|
||
|
||
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L628)*
|
||
|
||
<hr />
|
||
|
||
# Interface: FallbackAbi
|
||
|
||
|
||
## Properties
|
||
|
||
### payable
|
||
|
||
• **payable**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L112)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L111)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
# Interface: GanacheProvider
|
||
|
||
|
||
## Methods
|
||
|
||
### sendAsync
|
||
|
||
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L14)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
|
||
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
|
||
|
||
**Returns:** *void*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
# Interface: GethCallOverrides
|
||
|
||
|
||
## Hierarchy
|
||
|
||
* **JSONRPCRequestPayload**
|
||
|
||
|
||
## Properties
|
||
|
||
### id
|
||
|
||
• **id**: *number*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L331)*
|
||
|
||
___
|
||
|
||
### jsonrpc
|
||
|
||
• **jsonrpc**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L332)*
|
||
|
||
___
|
||
|
||
### method
|
||
|
||
• **method**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L330)*
|
||
|
||
___
|
||
|
||
### params
|
||
|
||
• **params**: *any[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L329)*
|
||
|
||
<hr />
|
||
|
||
# Interface: JSONRPCResponseError
|
||
|
||
|
||
## Properties
|
||
|
||
### code
|
||
|
||
• **code**: *number*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L337)*
|
||
|
||
___
|
||
|
||
### message
|
||
|
||
• **message**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L336)*
|
||
|
||
<hr />
|
||
|
||
# Interface: JSONRPCResponsePayload
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` error
|
||
|
||
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L344)*
|
||
|
||
___
|
||
|
||
### id
|
||
|
||
• **id**: *number*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L342)*
|
||
|
||
___
|
||
|
||
### jsonrpc
|
||
|
||
• **jsonrpc**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L343)*
|
||
|
||
___
|
||
|
||
### result
|
||
|
||
• **result**: *any*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L341)*
|
||
|
||
<hr />
|
||
|
||
# Interface: LogEntry
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string | null*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)*
|
||
|
||
___
|
||
|
||
### blockNumber
|
||
|
||
• **blockNumber**: *number | null*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)*
|
||
|
||
___
|
||
|
||
### data
|
||
|
||
• **data**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)*
|
||
|
||
___
|
||
|
||
### logIndex
|
||
|
||
• **logIndex**: *number | null*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)*
|
||
|
||
___
|
||
|
||
### topics
|
||
|
||
• **topics**: *string[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)*
|
||
|
||
___
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)*
|
||
|
||
___
|
||
|
||
### transactionIndex
|
||
|
||
• **transactionIndex**: *number | null*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
|
||
|
||
<hr />
|
||
|
||
# Interface: LogEntryEvent
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)*
|
||
|
||
___
|
||
|
||
### blockNumber
|
||
|
||
• **blockNumber**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)*
|
||
|
||
___
|
||
|
||
### data
|
||
|
||
• **data**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)*
|
||
|
||
___
|
||
|
||
### logIndex
|
||
|
||
• **logIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)*
|
||
|
||
___
|
||
|
||
### removed
|
||
|
||
• **removed**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L435)*
|
||
|
||
___
|
||
|
||
### topics
|
||
|
||
• **topics**: *string[]*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)*
|
||
|
||
___
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)*
|
||
|
||
___
|
||
|
||
### transactionIndex
|
||
|
||
• **transactionIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
|
||
|
||
<hr />
|
||
|
||
# Interface: LogWithDecodedArgs <**ArgsType**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)*
|
||
|
||
|
||
## Properties
|
||
|
||
### address
|
||
|
||
• **address**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:444](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L444)*
|
||
|
||
___
|
||
|
||
### args
|
||
|
||
• **args**: *`ArgsType`*
|
||
|
||
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L427)*
|
||
|
||
___
|
||
|
||
### blockHash
|
||
|
||
• **blockHash**: *string | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L442)*
|
||
|
||
___
|
||
|
||
### blockNumber
|
||
|
||
• **blockNumber**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L443)*
|
||
|
||
___
|
||
|
||
### data
|
||
|
||
• **data**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L445)*
|
||
|
||
___
|
||
|
||
### event
|
||
|
||
• **event**: *string*
|
||
|
||
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L426)*
|
||
|
||
___
|
||
|
||
### logIndex
|
||
|
||
• **logIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:439](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L439)*
|
||
|
||
___
|
||
|
||
### topics
|
||
|
||
• **topics**: *string[]*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L446)*
|
||
|
||
___
|
||
|
||
### transactionHash
|
||
|
||
• **transactionHash**: *string*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:441](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L441)*
|
||
|
||
___
|
||
|
||
### transactionIndex
|
||
|
||
• **transactionIndex**: *number | null*
|
||
|
||
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:440](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L440)*
|
||
|
||
<hr />
|
||
|
||
# Interface: MethodAbi
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` constant
|
||
|
||
• **constant**? : *undefined | false | true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L94)*
|
||
|
||
___
|
||
|
||
### inputs
|
||
|
||
• **inputs**: *[DataItem](#class-dataitem)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L92)*
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
• **name**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L91)*
|
||
|
||
___
|
||
|
||
### outputs
|
||
|
||
• **outputs**: *[DataItem](#class-dataitem)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L93)*
|
||
|
||
___
|
||
|
||
### `Optional` payable
|
||
|
||
• **payable**? : *undefined | false | true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L96)*
|
||
|
||
___
|
||
|
||
### stateMutability
|
||
|
||
• **stateMutability**: *[StateMutability](#statemutability)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L95)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L90)*
|
||
|
||
<hr />
|
||
|
||
# Interface: OptimizerSettings
|
||
|
||
|
||
## Properties
|
||
|
||
### enabled
|
||
|
||
• **enabled**: *boolean*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:725](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L725)*
|
||
|
||
___
|
||
|
||
### `Optional` runs
|
||
|
||
• **runs**? : *undefined | number*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:726](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L726)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: RevertErrorAbi
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` arguments
|
||
|
||
• **arguments**? : *[DataItem](#class-dataitem)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L122)*
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
• **name**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L121)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *"error"*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L120)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: StandardContractOutput
|
||
|
||
|
||
## Properties
|
||
|
||
### abi
|
||
|
||
• **abi**: *[ContractAbi](#contractabi)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:574](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L574)*
|
||
|
||
___
|
||
|
||
### `Optional` devdoc
|
||
|
||
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:576](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L576)*
|
||
|
||
___
|
||
|
||
### evm
|
||
|
||
• **evm**: *[EvmOutput](#class-evmoutput)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:575](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L575)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: TupleDataItem
|
||
|
||
|
||
## Properties
|
||
|
||
### components
|
||
|
||
• **components**: *[DataItem](#class-dataitem)[]*
|
||
|
||
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L142)*
|
||
|
||
___
|
||
|
||
### `Optional` internalType
|
||
|
||
• **internalType**? : *undefined | string*
|
||
|
||
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L137)*
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
• **name**: *string*
|
||
|
||
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L135)*
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: *string*
|
||
|
||
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L136)*
|
||
|
||
<hr />
|
||
|
||
# Interface: TxData
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` data
|
||
|
||
• **data**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)*
|
||
|
||
___
|
||
|
||
### from
|
||
|
||
• **from**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L399)*
|
||
|
||
___
|
||
|
||
### `Optional` gas
|
||
|
||
• **gas**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)*
|
||
|
||
___
|
||
|
||
### `Optional` gasPrice
|
||
|
||
• **gasPrice**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)*
|
||
|
||
___
|
||
|
||
### `Optional` nonce
|
||
|
||
• **nonce**? : *undefined | number*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L395)*
|
||
|
||
___
|
||
|
||
### `Optional` to
|
||
|
||
• **to**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)*
|
||
|
||
___
|
||
|
||
### `Optional` value
|
||
|
||
• **value**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L391)*
|
||
|
||
<hr />
|
||
|
||
# Interface: TxDataPayable
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` data
|
||
|
||
• **data**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L394)*
|
||
|
||
___
|
||
|
||
### from
|
||
|
||
• **from**: *string*
|
||
|
||
*Inherited from [TxData](#interface-txdata).[from](#from)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L399)*
|
||
|
||
___
|
||
|
||
### `Optional` gas
|
||
|
||
• **gas**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L392)*
|
||
|
||
___
|
||
|
||
### `Optional` gasPrice
|
||
|
||
• **gasPrice**? : *number | string | `BigNumber`*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L393)*
|
||
|
||
___
|
||
|
||
### `Optional` nonce
|
||
|
||
• **nonce**? : *undefined | number*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L395)*
|
||
|
||
___
|
||
|
||
### `Optional` to
|
||
|
||
• **to**? : *undefined | string*
|
||
|
||
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L390)*
|
||
|
||
___
|
||
|
||
### `Optional` value
|
||
|
||
• **value**? : *`BigNumber`*
|
||
|
||
*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L452)*
|
||
|
||
<hr />
|
||
|
||
# Interface: Web3JsV1Provider
|
||
|
||
Web3.js version 1 provider interface
|
||
This provider interface was implemented in the pre-1.0Beta releases for Web3.js.
|
||
This interface allowed sending synchonous requests, support for which was later dropped.
|
||
|
||
|
||
## Methods
|
||
|
||
### send
|
||
|
||
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L45)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
|
||
|
||
**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
|
||
|
||
___
|
||
|
||
### sendAsync
|
||
|
||
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L44)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
|
||
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
|
||
|
||
**Returns:** *void*
|
||
|
||
<hr />
|
||
|
||
# Interface: Web3JsV2Provider
|
||
|
||
Web3.js version 2 provider interface
|
||
This provider interface was used in a couple of Web3.js 1.0 beta releases
|
||
before the first attempts to conform to EIP1193
|
||
|
||
|
||
## Methods
|
||
|
||
### send
|
||
|
||
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L54)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
|
||
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
|
||
|
||
**Returns:** *void*
|
||
|
||
<hr />
|
||
|
||
# Interface: Web3JsV3Provider
|
||
|
||
Web3.js version 3 provider interface
|
||
This provider interface was implemented with the hopes for conforming to the EIP1193 spec,
|
||
however it does not conform entirely.
|
||
|
||
|
||
## Methods
|
||
|
||
### send
|
||
|
||
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L63)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`method` | string |
|
||
`params?` | any[] |
|
||
|
||
**Returns:** *`Promise<any>`*
|
||
|
||
<hr />
|
||
|
||
# Interface: ZeroExProvider
|
||
|
||
The interface for the provider used internally by 0x libraries
|
||
Any property we use from any SupportedProvider should we explicitly
|
||
add here
|
||
|
||
|
||
## Properties
|
||
|
||
### `Optional` isMetaMask
|
||
|
||
• **isMetaMask**? : *undefined | false | true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L31)*
|
||
|
||
___
|
||
|
||
### `Optional` isParity
|
||
|
||
• **isParity**? : *undefined | false | true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L32)*
|
||
|
||
___
|
||
|
||
### `Optional` isZeroExProvider
|
||
|
||
• **isZeroExProvider**? : *undefined | false | true*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L30)*
|
||
|
||
## Methods
|
||
|
||
### `Optional` enable
|
||
|
||
▸ **enable**(): *`Promise<void>`*
|
||
|
||
*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<void>`*
|
||
|
||
___
|
||
|
||
### sendAsync
|
||
|
||
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L35)*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
|
||
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
|
||
|
||
**Returns:** *void*
|
||
|
||
___
|
||
|
||
### `Optional` stop
|
||
|
||
▸ **stop**(): *void*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L33)*
|
||
|
||
**Returns:** *void*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: DecodedLogEvent <**ArgsType**>
|
||
|
||
## Type parameters
|
||
|
||
▪ **ArgsType**: *`DecodedLogArgs`*
|
||
|
||
|
||
## Properties
|
||
|
||
### isRemoved
|
||
|
||
• **isRemoved**: *boolean*
|
||
|
||
*Defined in [types/src/index.ts:872](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L872)*
|
||
|
||
___
|
||
|
||
### log
|
||
|
||
• **log**: *`LogWithDecodedArgs<ArgsType>`*
|
||
|
||
*Defined in [types/src/index.ts:873](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L873)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: IndexedFilterValues
|
||
|
||
|
||
## Hierarchy
|
||
|
||
* **IndexSignature**
|
||
|
||
|
||
## Properties
|
||
|
||
### keyName
|
||
|
||
• **keyName**: *string*
|
||
|
||
*Defined in [types/src/index.ts:719](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L719)*
|
||
|
||
___
|
||
|
||
### keyType
|
||
|
||
• **keyType**: *[Type](#class-type)*
|
||
|
||
*Defined in [types/src/index.ts:720](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L720)*
|
||
|
||
___
|
||
|
||
### valueName
|
||
|
||
• **valueName**: *string*
|
||
|
||
*Defined in [types/src/index.ts:721](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L721)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# Interface: SimpleContractArtifact
|
||
|
||
|
||
## Properties
|
||
|
||
### chains
|
||
|
||
• **chains**: *`ContractChains`*
|
||
|
||
*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L889)*
|
||
|
||
___
|
||
|
||
### compilerOutput
|
||
|
||
• **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)*
|
||
|
||
*Defined in [types/src/index.ts:888](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L888)*
|
||
|
||
___
|
||
|
||
### contractName
|
||
|
||
• **contractName**: *string*
|
||
|
||
*Defined in [types/src/index.ts:887](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L887)*
|
||
|
||
___
|
||
|
||
### schemaVersion
|
||
|
||
• **schemaVersion**: *string*
|
||
|
||
*Defined in [types/src/index.ts:886](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L886)*
|
||
|
||
<hr />
|
||
|
||
# Interface: SimpleEvmBytecodeOutput
|
||
|
||
|
||
## Properties
|
||
|
||
### object
|
||
|
||
• **object**: *string*
|
||
|
||
*Defined in [types/src/index.ts:903](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L903)*
|
||
|
||
<hr />
|
||
|
||
# Interface: SimpleEvmOutput
|
||
|
||
|
||
## Properties
|
||
|
||
### bytecode
|
||
|
||
• **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)*
|
||
|
||
*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L899)*
|
||
|
||
<hr />
|
||
|
||
# Interface: SimpleStandardContractOutput
|
||
|
||
|
||
## Properties
|
||
|
||
### abi
|
||
|
||
• **abi**: *[ContractAbi](#contractabi)*
|
||
|
||
*Defined in [types/src/index.ts:893](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L893)*
|
||
|
||
___
|
||
|
||
### `Optional` devdoc
|
||
|
||
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
|
||
|
||
*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L895)*
|
||
|
||
___
|
||
|
||
### evm
|
||
|
||
• **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)*
|
||
|
||
*Defined in [types/src/index.ts:894](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/types/src/index.ts#L894)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## Type aliases
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## Functions
|
||
|
||
### getContractAddressesForChainOrThrow
|
||
|
||
▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)*
|
||
|
||
*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
|
||
contracts deployed on the corresponding chain.
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type | Description |
|
||
------ | ------ | ------ |
|
||
`chainId` | [ChainId](#enumeration-chainid) | The desired chainId. |
|
||
|
||
**Returns:** *[ContractAddresses](#interface-contractaddresses)*
|
||
|
||
The set of addresses for contracts which have been deployed on the
|
||
given chainId.
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## Type aliases
|
||
|
||
### AbiDefinition
|
||
|
||
Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L80)*
|
||
|
||
___
|
||
|
||
### BlockParam
|
||
|
||
Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L493)*
|
||
|
||
___
|
||
|
||
### ConstructorStateMutability
|
||
|
||
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L84)*
|
||
|
||
___
|
||
|
||
### ContractAbi
|
||
|
||
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L78)*
|
||
|
||
___
|
||
|
||
### ContractEventArg
|
||
|
||
Ƭ **ContractEventArg**: *any*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L478)*
|
||
|
||
___
|
||
|
||
|
||
|
||
### EIP1193Event
|
||
|
||
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
|
||
|
||
*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
|
||
|
||
___
|
||
|
||
|
||
|
||
|
||
|
||
### FunctionAbi
|
||
|
||
Ƭ **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/b1b9949e7/packages/ethereum-types/src/index.ts#L82)*
|
||
|
||
___
|
||
|
||
### JSONRPCErrorCallback
|
||
|
||
Ƭ **JSONRPCErrorCallback**: *function*
|
||
|
||
*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:
|
||
|
||
▸ (`err`: `Error` | null, `result?`: [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload)): *void*
|
||
|
||
**Parameters:**
|
||
|
||
Name | Type |
|
||
------ | ------ |
|
||
`err` | `Error` \| null |
|
||
`result?` | [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload) |
|
||
|
||
___
|
||
|
||
|
||
|
||
### OutputField
|
||
|
||
Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:535](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L535)*
|
||
|
||
___
|
||
|
||
### ParamDescription
|
||
|
||
Ƭ **ParamDescription**: *string*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L571)*
|
||
|
||
___
|
||
|
||
### RawLog
|
||
|
||
Ƭ **RawLog**: *[LogEntry](#interface-logentry)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:485](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L485)*
|
||
|
||
___
|
||
|
||
### StateMutability
|
||
|
||
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L85)*
|
||
|
||
___
|
||
|
||
### SupportedProvider
|
||
|
||
Ƭ **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/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.
|
||
|
||
___
|
||
|
||
|
||
|
||
|
||
|
||
### Web3JsProvider
|
||
|
||
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
|
||
|
||
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/b1b9949e7/packages/ethereum-types/src/index.ts#L11)*
|
||
|
||
<hr />
|
||
|
||
|
||
|
||
|
||
## 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`*› |
|
||
|
||
___
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<hr />
|
||
|