"""Generated wrapper for ZRXToken Solidity contract."""
# pylint: disable=too-many-arguments
import json
from typing import ( # pylint: disable=unused-import
Any,
List,
Optional,
Tuple,
Union,
)
from eth_utils import to_checksum_address
from mypy_extensions import TypedDict # pylint: disable=unused-import
from hexbytes import HexBytes
from web3 import Web3
from web3.contract import ContractFunction
from web3.datastructures import AttributeDict
from web3.providers.base import BaseProvider
from zero_ex.contract_wrappers.bases import ContractMethod, Validator
from zero_ex.contract_wrappers.tx_params import TxParams
# Try to import a custom validator class definition; if there isn't one,
# declare one that we can instantiate for the default argument to the
# constructor for ZRXToken below.
try:
# both mypy and pylint complain about what we're doing here, but this
# works just fine, so their messages have been disabled here.
from . import ( # type: ignore # pylint: disable=import-self
ZRXTokenValidator,
)
except ImportError:
[docs] class ZRXTokenValidator( # type: ignore
Validator
):
"""No-op input validator."""
try:
from .middleware import MIDDLEWARE # type: ignore
except ImportError:
pass
[docs]class NameMethod(ContractMethod):
"""Various interfaces to the name method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address)
self._underlying_method = contract_function
[docs] def call(self, tx_params: Optional[TxParams] = None) -> str:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method().call(tx_params.as_dict())
return str(returned)
[docs] def estimate_gas(self, tx_params: Optional[TxParams] = None) -> int:
"""Estimate gas consumption of method call."""
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method().estimateGas(tx_params.as_dict())
[docs]class ApproveMethod(ContractMethod):
"""Various interfaces to the approve method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
validator: Validator = None,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address, validator)
self._underlying_method = contract_function
[docs] def call(
self, _spender: str, _value: int, tx_params: Optional[TxParams] = None
) -> bool:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
:returns: the return value of the underlying method.
"""
(_spender, _value) = self.validate_and_normalize_inputs(
_spender, _value
)
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method(_spender, _value).call(
tx_params.as_dict()
)
return bool(returned)
[docs] def send_transaction(
self, _spender: str, _value: int, tx_params: Optional[TxParams] = None
) -> Union[HexBytes, bytes]:
"""Execute underlying contract method via eth_sendTransaction.
:param tx_params: transaction parameters
"""
(_spender, _value) = self.validate_and_normalize_inputs(
_spender, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_spender, _value).transact(
tx_params.as_dict()
)
[docs] def build_transaction(
self, _spender: str, _value: int, tx_params: Optional[TxParams] = None
) -> dict:
"""Construct calldata to be used as input to the method."""
(_spender, _value) = self.validate_and_normalize_inputs(
_spender, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_spender, _value).buildTransaction(
tx_params.as_dict()
)
[docs] def estimate_gas(
self, _spender: str, _value: int, tx_params: Optional[TxParams] = None
) -> int:
"""Estimate gas consumption of method call."""
(_spender, _value) = self.validate_and_normalize_inputs(
_spender, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_spender, _value).estimateGas(
tx_params.as_dict()
)
[docs]class TotalSupplyMethod(ContractMethod):
"""Various interfaces to the totalSupply method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address)
self._underlying_method = contract_function
[docs] def call(self, tx_params: Optional[TxParams] = None) -> int:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method().call(tx_params.as_dict())
return int(returned)
[docs] def estimate_gas(self, tx_params: Optional[TxParams] = None) -> int:
"""Estimate gas consumption of method call."""
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method().estimateGas(tx_params.as_dict())
[docs]class TransferFromMethod(ContractMethod):
"""Various interfaces to the transferFrom method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
validator: Validator = None,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address, validator)
self._underlying_method = contract_function
[docs] def call(
self,
_from: str,
_to: str,
_value: int,
tx_params: Optional[TxParams] = None,
) -> bool:
"""Execute underlying contract method via eth_call.
ERC20 transferFrom, modified such that an allowance of MAX_UINT
represents an unlimited allowance.
:param _from: Address to transfer from.
:param _to: Address to transfer to.
:param _value: Amount to transfer.
:param tx_params: transaction parameters
:returns: the return value of the underlying method.
"""
(_from, _to, _value) = self.validate_and_normalize_inputs(
_from, _to, _value
)
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method(_from, _to, _value).call(
tx_params.as_dict()
)
return bool(returned)
[docs] def send_transaction(
self,
_from: str,
_to: str,
_value: int,
tx_params: Optional[TxParams] = None,
) -> Union[HexBytes, bytes]:
"""Execute underlying contract method via eth_sendTransaction.
ERC20 transferFrom, modified such that an allowance of MAX_UINT
represents an unlimited allowance.
:param _from: Address to transfer from.
:param _to: Address to transfer to.
:param _value: Amount to transfer.
:param tx_params: transaction parameters
"""
(_from, _to, _value) = self.validate_and_normalize_inputs(
_from, _to, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_from, _to, _value).transact(
tx_params.as_dict()
)
[docs] def build_transaction(
self,
_from: str,
_to: str,
_value: int,
tx_params: Optional[TxParams] = None,
) -> dict:
"""Construct calldata to be used as input to the method."""
(_from, _to, _value) = self.validate_and_normalize_inputs(
_from, _to, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_from, _to, _value).buildTransaction(
tx_params.as_dict()
)
[docs] def estimate_gas(
self,
_from: str,
_to: str,
_value: int,
tx_params: Optional[TxParams] = None,
) -> int:
"""Estimate gas consumption of method call."""
(_from, _to, _value) = self.validate_and_normalize_inputs(
_from, _to, _value
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_from, _to, _value).estimateGas(
tx_params.as_dict()
)
[docs]class DecimalsMethod(ContractMethod):
"""Various interfaces to the decimals method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address)
self._underlying_method = contract_function
[docs] def call(self, tx_params: Optional[TxParams] = None) -> int:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method().call(tx_params.as_dict())
return int(returned)
[docs] def estimate_gas(self, tx_params: Optional[TxParams] = None) -> int:
"""Estimate gas consumption of method call."""
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method().estimateGas(tx_params.as_dict())
[docs]class BalanceOfMethod(ContractMethod):
"""Various interfaces to the balanceOf method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
validator: Validator = None,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address, validator)
self._underlying_method = contract_function
[docs] def call(self, _owner: str, tx_params: Optional[TxParams] = None) -> int:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
(_owner) = self.validate_and_normalize_inputs(_owner)
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method(_owner).call(tx_params.as_dict())
return int(returned)
[docs] def estimate_gas(
self, _owner: str, tx_params: Optional[TxParams] = None
) -> int:
"""Estimate gas consumption of method call."""
(_owner) = self.validate_and_normalize_inputs(_owner)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_owner).estimateGas(tx_params.as_dict())
[docs]class SymbolMethod(ContractMethod):
"""Various interfaces to the symbol method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address)
self._underlying_method = contract_function
[docs] def call(self, tx_params: Optional[TxParams] = None) -> str:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method().call(tx_params.as_dict())
return str(returned)
[docs] def estimate_gas(self, tx_params: Optional[TxParams] = None) -> int:
"""Estimate gas consumption of method call."""
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method().estimateGas(tx_params.as_dict())
[docs]class TransferMethod(ContractMethod):
"""Various interfaces to the transfer method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
validator: Validator = None,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address, validator)
self._underlying_method = contract_function
[docs] def call(
self, _to: str, _value: int, tx_params: Optional[TxParams] = None
) -> bool:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
:returns: the return value of the underlying method.
"""
(_to, _value) = self.validate_and_normalize_inputs(_to, _value)
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method(_to, _value).call(
tx_params.as_dict()
)
return bool(returned)
[docs] def send_transaction(
self, _to: str, _value: int, tx_params: Optional[TxParams] = None
) -> Union[HexBytes, bytes]:
"""Execute underlying contract method via eth_sendTransaction.
:param tx_params: transaction parameters
"""
(_to, _value) = self.validate_and_normalize_inputs(_to, _value)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_to, _value).transact(
tx_params.as_dict()
)
[docs] def build_transaction(
self, _to: str, _value: int, tx_params: Optional[TxParams] = None
) -> dict:
"""Construct calldata to be used as input to the method."""
(_to, _value) = self.validate_and_normalize_inputs(_to, _value)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_to, _value).buildTransaction(
tx_params.as_dict()
)
[docs] def estimate_gas(
self, _to: str, _value: int, tx_params: Optional[TxParams] = None
) -> int:
"""Estimate gas consumption of method call."""
(_to, _value) = self.validate_and_normalize_inputs(_to, _value)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_to, _value).estimateGas(
tx_params.as_dict()
)
[docs]class AllowanceMethod(ContractMethod):
"""Various interfaces to the allowance method."""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
contract_function: ContractFunction,
validator: Validator = None,
):
"""Persist instance data."""
super().__init__(web3_or_provider, contract_address, validator)
self._underlying_method = contract_function
[docs] def call(
self, _owner: str, _spender: str, tx_params: Optional[TxParams] = None
) -> int:
"""Execute underlying contract method via eth_call.
:param tx_params: transaction parameters
"""
(_owner, _spender) = self.validate_and_normalize_inputs(
_owner, _spender
)
tx_params = super().normalize_tx_params(tx_params)
returned = self._underlying_method(_owner, _spender).call(
tx_params.as_dict()
)
return int(returned)
[docs] def estimate_gas(
self, _owner: str, _spender: str, tx_params: Optional[TxParams] = None
) -> int:
"""Estimate gas consumption of method call."""
(_owner, _spender) = self.validate_and_normalize_inputs(
_owner, _spender
)
tx_params = super().normalize_tx_params(tx_params)
return self._underlying_method(_owner, _spender).estimateGas(
tx_params.as_dict()
)
# pylint: disable=too-many-public-methods,too-many-instance-attributes
[docs]class ZRXToken:
"""Wrapper class for ZRXToken Solidity contract."""
name: NameMethod
"""Constructor-initialized instance of
:class:`NameMethod`.
"""
approve: ApproveMethod
"""Constructor-initialized instance of
:class:`ApproveMethod`.
"""
total_supply: TotalSupplyMethod
"""Constructor-initialized instance of
:class:`TotalSupplyMethod`.
"""
transfer_from: TransferFromMethod
"""Constructor-initialized instance of
:class:`TransferFromMethod`.
"""
decimals: DecimalsMethod
"""Constructor-initialized instance of
:class:`DecimalsMethod`.
"""
balance_of: BalanceOfMethod
"""Constructor-initialized instance of
:class:`BalanceOfMethod`.
"""
symbol: SymbolMethod
"""Constructor-initialized instance of
:class:`SymbolMethod`.
"""
transfer: TransferMethod
"""Constructor-initialized instance of
:class:`TransferMethod`.
"""
allowance: AllowanceMethod
"""Constructor-initialized instance of
:class:`AllowanceMethod`.
"""
[docs] def __init__(
self,
web3_or_provider: Union[Web3, BaseProvider],
contract_address: str,
validator: ZRXTokenValidator = None,
):
"""Get an instance of wrapper for smart contract.
:param web3_or_provider: Either an instance of `web3.Web3`:code: or
`web3.providers.base.BaseProvider`:code:
:param contract_address: where the contract has been deployed
:param validator: for validation of method inputs.
"""
# pylint: disable=too-many-statements
self.contract_address = contract_address
if not validator:
validator = ZRXTokenValidator(web3_or_provider, contract_address)
web3 = None
if isinstance(web3_or_provider, BaseProvider):
web3 = Web3(web3_or_provider)
elif isinstance(web3_or_provider, Web3):
web3 = web3_or_provider
else:
raise TypeError(
"Expected parameter 'web3_or_provider' to be an instance of either"
+ " Web3 or BaseProvider"
)
# if any middleware was imported, inject it
try:
MIDDLEWARE
except NameError:
pass
else:
try:
for middleware in MIDDLEWARE:
web3.middleware_onion.inject(
middleware["function"], layer=middleware["layer"],
)
except ValueError as value_error:
if value_error.args == (
"You can't add the same un-named instance twice",
):
pass
self._web3_eth = web3.eth
functions = self._web3_eth.contract(
address=to_checksum_address(contract_address), abi=ZRXToken.abi()
).functions
self.name = NameMethod(
web3_or_provider, contract_address, functions.name
)
self.approve = ApproveMethod(
web3_or_provider, contract_address, functions.approve, validator
)
self.total_supply = TotalSupplyMethod(
web3_or_provider, contract_address, functions.totalSupply
)
self.transfer_from = TransferFromMethod(
web3_or_provider,
contract_address,
functions.transferFrom,
validator,
)
self.decimals = DecimalsMethod(
web3_or_provider, contract_address, functions.decimals
)
self.balance_of = BalanceOfMethod(
web3_or_provider, contract_address, functions.balanceOf, validator
)
self.symbol = SymbolMethod(
web3_or_provider, contract_address, functions.symbol
)
self.transfer = TransferMethod(
web3_or_provider, contract_address, functions.transfer, validator
)
self.allowance = AllowanceMethod(
web3_or_provider, contract_address, functions.allowance, validator
)
[docs] def get_transfer_event(
self, tx_hash: Union[HexBytes, bytes]
) -> Tuple[AttributeDict]:
"""Get log entry for Transfer event.
:param tx_hash: hash of transaction emitting Transfer event
"""
tx_receipt = self._web3_eth.getTransactionReceipt(tx_hash)
return (
self._web3_eth.contract(
address=to_checksum_address(self.contract_address),
abi=ZRXToken.abi(),
)
.events.Transfer()
.processReceipt(tx_receipt)
)
[docs] def get_approval_event(
self, tx_hash: Union[HexBytes, bytes]
) -> Tuple[AttributeDict]:
"""Get log entry for Approval event.
:param tx_hash: hash of transaction emitting Approval event
"""
tx_receipt = self._web3_eth.getTransactionReceipt(tx_hash)
return (
self._web3_eth.contract(
address=to_checksum_address(self.contract_address),
abi=ZRXToken.abi(),
)
.events.Approval()
.processReceipt(tx_receipt)
)
[docs] @staticmethod
def abi():
"""Return the ABI to the underlying contract."""
return json.loads(
'[{"constant":true,"inputs":[],"name":"name","outputs":[{"name":"","type":"string"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"_spender","type":"address"},{"name":"_value","type":"uint256"}],"name":"approve","outputs":[{"name":"","type":"bool"}],"payable":false,"type":"function"},{"constant":true,"inputs":[],"name":"totalSupply","outputs":[{"name":"","type":"uint256"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"_from","type":"address"},{"name":"_to","type":"address"},{"name":"_value","type":"uint256"}],"name":"transferFrom","outputs":[{"name":"","type":"bool"}],"payable":false,"type":"function"},{"constant":true,"inputs":[],"name":"decimals","outputs":[{"name":"","type":"uint8"}],"payable":false,"type":"function"},{"constant":true,"inputs":[{"name":"_owner","type":"address"}],"name":"balanceOf","outputs":[{"name":"","type":"uint256"}],"payable":false,"type":"function"},{"constant":true,"inputs":[],"name":"symbol","outputs":[{"name":"","type":"string"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"_to","type":"address"},{"name":"_value","type":"uint256"}],"name":"transfer","outputs":[{"name":"","type":"bool"}],"payable":false,"type":"function"},{"constant":true,"inputs":[{"name":"_owner","type":"address"},{"name":"_spender","type":"address"}],"name":"allowance","outputs":[{"name":"","type":"uint256"}],"payable":false,"type":"function"},{"inputs":[],"payable":false,"type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_from","type":"address"},{"indexed":true,"name":"_to","type":"address"},{"indexed":false,"name":"_value","type":"uint256"}],"name":"Transfer","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_owner","type":"address"},{"indexed":true,"name":"_spender","type":"address"},{"indexed":false,"name":"_value","type":"uint256"}],"name":"Approval","type":"event"}]' # noqa: E501 (line-too-long)
)
# pylint: disable=too-many-lines