Source code for cfx_account.signers.local

from typing import TYPE_CHECKING, Any, Optional, Union, Type
from typing_extensions import Literal
from eth_utils.address import to_checksum_address
from eth_account.signers.local import LocalAccount as EthLocalAccount
from eth_account.datastructures import (
    SignedMessage,
    SignedTransaction,
)
from eth_account.messages import (
    SignableMessage
)
from cfx_address import (
    eth_eoa_address_to_cfx_hex,
    Base32Address
)
from cfx_address.utils import (
    validate_network_id
)
from cfx_utils.types import (
    TxParam,
    ChecksumAddress,
)
from cfx_account.types import (
    KeyfileDict,
)


if TYPE_CHECKING:
    from cfx_account import Account




class LocalAccount(EthLocalAccount):
    def __init__(self, key: Any, account: Union["Account", Type["Account"]], network_id: Optional[int]=None):
        if network_id is not None:
            validate_network_id(network_id)
        self._network_id = network_id
        
        super().__init__(key, account)

    @property
    def network_id(self) -> Union[int, None]:
        """
        The network id of the account, which determines its address.
        Can be set using a positive int or None

        :return Union[int, None]: the network id of the account, 1029 for mainnet and 1 for testnet
        
        :examples:
        
        >>> from cfx_account import Account
        >>> acct = Account.create()
        >>> assert acct.network_id is None
        >>> acct.address
        '0x1261D876E5C589Bc26248c53C68b71c2d28470e9'  
        >>> acct.network_id = 1
        >>> acct.address
        'cfxtest:aakgd0d061c2xtbgewgfhvynshbrfbdu7e55kdxfxx'
        """        
        return self._network_id
    
    @network_id.setter
    def network_id(self, new_network_id: Union[int, None]) -> None:
        """
        Set the network id of the account, which determines its address

        :param Union[int, None] new_network_id: the new network id
        """        
        if new_network_id is not None:
            validate_network_id(new_network_id)
        self._network_id = new_network_id
        
    # def reset_network_id(self):
    #     self._network_id = None

    @property
    def address(self) -> Union[Base32Address, ChecksumAddress]:
        """
        Returns the address of the account.

        :return Union[Base32Address,ChecksumAddress]: Returns a Base32Address if network id is not None, 
            else ChecksumAddress
        """
        hex_address = self.hex_address
        if not self._network_id:
            return hex_address
        return Base32Address(hex_address, self._network_id)

    @property
    def hex_address(self) -> ChecksumAddress:
        """
        Returns the hex address of the account.

        :return ChecksumAddress: the hex address in checksum format
        """        
        return to_checksum_address(eth_eoa_address_to_cfx_hex(super().address))
    
    @property
    def base32_address(self) -> Base32Address:
        """
        Returns the address of the account in base32 format.
        Raises ValueError if network id is not set.

        :return Base32Address: the address in base32 format
        """
        if not self._network_id:
            raise ValueError("Network id is not set. Please set it using `account.network_id = <network_id>`")
        return Base32Address(self.address, self._network_id)

    @property
    def key(self) -> bytes:
        """
        Get the private key.
        """
        return super().key
    


    def get_base32_address(self, specific_network_id: int) -> Base32Address:
        """
        Returns the Base32Address of the account in specific network
        without changing the account network id

        :param int specific_network_id: the network id of the target network
        :return Base32Address:
        """        
        return Base32Address(self.address, specific_network_id)

    


    def sign_transaction(self, transaction_dict: TxParam) -> SignedTransaction:
        """
        This uses the same structure as in
        :meth:`~cfx_account.account.Account.sign_transaction`, but without a private key argument.
        """
        return super().sign_transaction(transaction_dict)

    


    def sign_message(self, signable_message: SignableMessage) -> SignedMessage:
        """
        This uses the same structure as in
        :meth:`~cfx_account.account.Account.sign_message`, but without a private key argument.
        """
        return super().sign_message(signable_message)

    


    def encrypt(self, password: str, kdf: Optional[Literal['scrypt', 'pbkdf2']]=None, iterations: Optional[int]=None) -> KeyfileDict:
        """
        This uses the same structure as in
        :meth:`~cfx_account.account.Account.encrypt`, but without a private key argument.
        """
        return super().encrypt(password, kdf, iterations)

    
    def __bytes__(self) -> bytes:
        return self.key