Source code for matic.pos.erc_20

from __future__ import annotations

from eth_typing import HexAddress

from matic.constants import MAX_AMOUNT, POSLogEventSignature
from matic.exceptions import NullSpenderAddressException
from matic.json_types import IAllowanceTransactionOption, ITransactionOption
from matic.pos.pos_token import POSToken


class ERC20(POSToken):
    """Arbitrary ERC-20-compliant token."""

    CONTRACT_NAME: str = 'ChildERC20'
    """Name of a contract."""
    BURN_EVENT_SIGNATURE: bytes = POSLogEventSignature.ERC_20_TRANSFER
    """Burn event signature: used for exit methods."""

    def get_balance(
        self, user_address: HexAddress, option: ITransactionOption | None = None
    ) -> int:
        """Get balance of a user for supplied token."""
        method = self.method(
            'balanceOf',
            user_address,
        )
        return self.process_read(method, option)

    def get_allowance(
        self,
        user_address: HexAddress,
        option: IAllowanceTransactionOption | None = None,
    ):
        """Get allowance of user."""
        predicate_address = (
            option['spender_address'] if option else None
        ) or self.predicate_address

        method = self.method(
            'allowance',
            user_address,
            predicate_address,
        )
        return self.process_read(method, option)

    def approve(
        self,
        amount: int,
        private_key: str | None = None,
        option: IAllowanceTransactionOption | None = None,
    ):
        """Approve specified amount to contract."""
        spender_address = option.get('spender_address') if option else None
        if not spender_address and not self.is_parent:
            raise NullSpenderAddressException

        predicate_address = (
            spender_address if spender_address else self.predicate_address
        )

        method = self.method('approve', predicate_address, amount)
        return self.process_write(method, option, private_key)

    def approve_max(
        self, private_key: str, option: IAllowanceTransactionOption | None = None
    ):
        """Approve max possible amount of token to contract."""
        return self.approve(MAX_AMOUNT, private_key, option)

    def deposit(
        self,
        amount: int,
        user_address: HexAddress,
        private_key: str | None = None,
        option: ITransactionOption | None = None,
    ):
        """Deposit given amount of token for user."""
        self.check_for_root()
        amount_in_abi = self.client.parent.encode_parameters([amount], ['uint256'])
        return self.root_chain_manager.deposit(
            user_address,
            self.address,
            amount_in_abi,
            private_key,
            option,
        )

    def _deposit_ether(
        self,
        amount: int,
        user_address: HexAddress,
        private_key: str | None = None,
        option: ITransactionOption | None = None,
    ):
        self.check_for_root()
        method = self.root_chain_manager.method('depositEtherFor', user_address)
        return self.process_write(method, option, private_key)

    def withdraw_start(
        self,
        amount: int,
        private_key: str | None = None,
        option: ITransactionOption | None = None,
    ):
        """Initiate withdraw by burning provided amount."""
        self.check_for_child()
        method = self.method('withdraw', amount)
        return self.process_write(method, option, private_key)

    def transfer(
        self,
        amount: int,
        to: HexAddress,
        private_key: str | None = None,
        option: ITransactionOption | None = None,
    ):
        """Transfer specified amount to another user."""
        return self.transfer_erc_20(to, amount, private_key, option)