test_accounts.py

from os import environ

import pytest
from cchecksum import to_checksum_address
from eip712.messages import EIP712Domain, EIP712Message
from eth_account.messages import encode_defunct
from eth_pydantic_types import HexBytes, abi
from eth_utils import keccak, to_hex
from ethpm_types import ContractType
from pydantic import BaseModel

import ape
from ape.api import ImpersonatedAccount
from ape.contracts import ContractContainer
from ape.exceptions import (
    AccountsError,
    AliasAlreadyInUseError,
    MethodNonPayableError,
    MissingDeploymentBytecodeError,
    ProjectError,
    SignatureError,
)
from ape.types.gas import AutoGasLimit
from ape.types.signatures import recover_signer
from ape.utils.testing import DEFAULT_TEST_MNEMONIC
from ape_accounts.accounts import (
    ApeSigner,
    KeyfileAccount,
    _get_signing_message_with_display,
    generate_account,
    import_account_from_mnemonic,
    import_account_from_private_key,
)
from ape_ethereum.ecosystem import ProxyType
from ape_ethereum.transactions import TransactionType
from ape_test.accounts import TestAccount
from tests.conftest import explorer_test

# NOTE: Even though `__test__` is set to `False` on the class,
# it must be set here as well for it to properly work for some reason.
TestAccount.__test__ = False

MISSING_VALUE_TRANSFER_ERR_MSG = "Must provide 'VALUE' or use 'send_everything=True"

APE_TEST_PATH = "ape_test.accounts.TestAccount"
APE_ACCOUNTS_PATH = "ape_accounts.accounts.KeyfileAccount"

PASSPHRASE = "asdf1234"
INVALID_PASSPHRASE = "incorrect passphrase"
MNEMONIC = "test test test test test test test test test test test junk"
PRIVATE_KEY = "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"


@pytest.fixture(params=(APE_TEST_PATH, APE_ACCOUNTS_PATH))
def core_account(request, owner, keyfile_account):
    if request.param == APE_TEST_PATH:
        yield owner  # from ape_test plugin

    elif request.param == APE_ACCOUNTS_PATH:
        yield keyfile_account  # from ape_accounts plugin


@pytest.fixture
def message():
    return encode_defunct(text="Hello Apes!")


class Baz(BaseModel):
    addr: abi.address


class Foo(EIP712Message):
    eip712_domain = EIP712Domain(name="Foo")

    bar: abi.address
    baz: Baz


def test_sign_message(signer, message):
    signature = signer.sign_message(message)
    assert signer.check_signature(message, signature)


def test_sign_transaction(signer, message, ethereum):
    transaction = ethereum.create_transaction(nonce=0, max_fee=0, max_priority_fee=0)
    signed_transaction = signer.sign_transaction(transaction)
    assert signed_transaction.signature is not None


def test_sign_transaction_using_keyfile_account(keyfile_account, message, ethereum, runner):
    transaction = ethereum.create_transaction(
        nonce=0, max_fee=0, max_priority_fee=0, data="0x21314135413451"
    )

    with runner.isolation(f"y\n{PASSPHRASE}\ny"):
        signed_transaction = keyfile_account.sign_transaction(transaction)

    assert signed_transaction.signature is not None


def test_sign_string(signer):
    message = "Hello Apes!"
    signature = signer.sign_message(message)
    assert signer.check_signature(message, signature)


def test_sign_int(signer):
    message = 4
    signature = signer.sign_message(message)
    assert signer.check_signature(message, signature)


def test_sign_message_unsupported_type_returns_none(signer):
    message = 1234.123
    signature = signer.sign_message(message)
    assert signature is None


def test_recover_signer(signer, message):
    signature = signer.sign_message(message)
    assert recover_signer(message, signature) == signer


def test_sign_eip712_message(signer):
    baz = Baz(addr=signer.address)
    foo = Foo(bar=signer.address, baz=baz)
    signature = signer.sign_message(foo)
    assert signer.check_signature(foo, signature)


def test_sign_message_with_prompts(runner, keyfile_account, message):
    # "y\na\ny": yes sign, password, yes keep unlocked
    start_nonce = keyfile_account.nonce
    with runner.isolation(input=f"y\n{PASSPHRASE}\ny"):
        signature = keyfile_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)

    # # "n": don't sign
    with runner.isolation(input="n\n"):
        signature = keyfile_account.sign_message(message)
        assert signature is None

    # Nonce should not change from signing messages.
    end_nonce = keyfile_account.nonce
    assert start_nonce == end_nonce


def test_sign_eip712_message_shows_custom_types(signer):
    baz = Baz(addr=signer.address)
    foo = Foo(bar=signer.address, baz=baz)
    display_msg, msg = _get_signing_message_with_display(foo)
    expected = """
Signing EIP712 Message
Domain
  Name: Foo
Message
  bar: 0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc
  baz:
    addr: 0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc
""".strip()
    assert display_msg
    assert display_msg.strip() == expected


def test_sign_raw_hash(runner, keyfile_account):
    # NOTE: `message` is a 32 byte raw hash, which is treated specially
    message = b"\xab" * 32

    # "y\na\ny": yes sign raw hash, password, yes keep unlocked
    with runner.isolation(input=f"y\n{PASSPHRASE}\ny"):
        signature = keyfile_account.sign_raw_msghash(message)
        assert keyfile_account.check_signature(message, signature, recover_using_eip191=False)

    # "n\nn": no sign raw hash: don't sign
    with runner.isolation(input="n"):
        signature = keyfile_account.sign_message(message)
        assert signature is None


def test_transfer(sender, receiver, eth_tester_provider, convert):
    initial_receiver_balance = receiver.balance
    initial_sender_balance = sender.balance
    value_str = "24 gwei"
    value_int = convert(value_str, int)

    receipt = sender.transfer(receiver, value_str)

    # Ensure each account balance was affected accordingly
    expected_receiver_balance = initial_receiver_balance + value_int
    expected_sender_loss = receipt.total_fees_paid + value_int
    expected_sender_balance = initial_sender_balance - expected_sender_loss
    assert receiver.balance == expected_receiver_balance
    assert sender.balance == expected_sender_balance, (
        f"difference: {abs(sender.balance - expected_sender_balance)}"
    )


def test_transfer_with_negative_value(sender, receiver):
    with pytest.raises(AccountsError, match="Value cannot be negative."):
        sender.transfer(receiver, value=-1)


def test_transfer_without_value(sender, receiver):
    with pytest.raises(AccountsError, match=MISSING_VALUE_TRANSFER_ERR_MSG):
        sender.transfer(receiver)


def test_transfer_without_value_send_everything_false(sender, receiver):
    with pytest.raises(AccountsError, match=MISSING_VALUE_TRANSFER_ERR_MSG):
        sender.transfer(receiver, send_everything=False)


def test_transfer_without_value_send_everything_true_with_low_gas(sender, receiver):
    initial_receiver_balance = receiver.balance
    initial_sender_balance = sender.balance

    # Clear balance of sender.
    # Use small gas so for sure runs out of money.
    receipt = sender.transfer(receiver, send_everything=True, gas=22000)

    value_given = receipt.value
    total_spent = value_given + receipt.total_fees_paid
    assert sender.balance == initial_sender_balance - total_spent
    assert receiver.balance == initial_receiver_balance + value_given

    expected_err_regex = r"Sender does not have enough to cover transaction value and gas: \d*"
    with pytest.raises(AccountsError, match=expected_err_regex):
        sender.transfer(receiver, send_everything=True)


def test_transfer_without_value_send_everything_true_with_high_gas(sender, receiver):
    initial_receiver_balance = receiver.balance
    initial_sender_balance = sender.balance

    # The gas selected here is very high compared to what actually gets used.
    gas = 25000000

    # Clear balance of sender
    receipt = sender.transfer(receiver, send_everything=True, gas=gas)

    value_given = receipt.value
    total_spent = value_given + receipt.total_fees_paid
    assert sender.balance == initial_sender_balance - total_spent
    assert receiver.balance == initial_receiver_balance + value_given

    # The sender is able to transfer again because they have so much left over
    # from safely using such a high gas before.
    # Use smaller (more expected) amount of gas this time.
    sender.transfer(receiver, send_everything=True, gas=21000)


def test_transfer_with_value_send_everything_true(sender, receiver):
    with pytest.raises(AccountsError, match="Cannot use 'send_everything=True' with 'VALUE'."):
        sender.transfer(receiver, 1, send_everything=True)


def test_transfer_with_prompts(runner, receiver, keyfile_account):
    # "y\na\ny": yes sign, password, yes keep unlocked
    with runner.isolation(f"y\n{PASSPHRASE}\ny"):
        receipt = keyfile_account.transfer(receiver, "1 gwei")
        assert receipt.receiver == receiver

    # "n": don't sign
    with runner.isolation(input="n\n"):
        with pytest.raises(SignatureError):
            keyfile_account.transfer(receiver, "1 gwei")


def test_transfer_using_type_0(sender, receiver, convert):
    initial_balance = receiver.balance
    sender.transfer(receiver, "1 gwei", type=0)
    expected = initial_balance + convert("1 gwei", int)
    assert receiver.balance == expected


def test_transfer_value_of_0(sender, receiver):
    """
    There was a bug where this failed, thinking there was no value.
    """
    initial_balance = receiver.balance
    sender.transfer(receiver, 0)
    assert receiver.balance == initial_balance

    # Also show conversion works.
    sender.transfer(receiver, "0 wei")
    assert receiver.balance == initial_balance


def test_transfer_mixed_up_sender_and_value(sender, receiver):
    """
    Testing the case where the user mixes up the argument order,
    it should show a nicer error than it was previously, as this is
    a common and easy mistake.
    """
    expected = (
        r"Cannot use integer-type for the `receiver` "
        r"argument in the `\.transfer\(\)` method \(this "
        r"protects against accidentally passing the "
        r"`value` as the `receiver`\)."
    )
    with pytest.raises(AccountsError, match=expected):
        sender.transfer(123, receiver)

    # Similarly show using currency-str (may fail for different error).
    expected = r"Invalid `receiver` value: '123 wei'\."
    with pytest.raises(AccountsError, match=expected):
        sender.transfer("123 wei", receiver)


def test_transfer_sign_is_false(sender, receiver):
    with pytest.raises(SignatureError):
        sender.transfer(receiver, "1 gwei", sign=False)


def test_deploy(owner, contract_container, clean_contract_caches):
    contract = owner.deploy(contract_container, 0)
    assert contract.address
    assert contract.txn_hash

    # Deploy again to prove that we get the correct txn_hash below
    owner.deploy(contract_container, 0)

    # Verify can reload same contract from cache
    contract_from_cache = ape.Contract(contract.address)
    assert contract_from_cache.contract_type == contract.contract_type
    assert contract_from_cache.address == contract.address
    assert contract_from_cache.txn_hash == contract.txn_hash


@explorer_test
@pytest.mark.timeout(360)
def test_deploy_and_publish_local_network(owner, minimal_proxy_container):
    with pytest.raises(ProjectError, match="Can only publish deployments on a live network"):
        owner.deploy(minimal_proxy_container, publish=True)


@explorer_test
def test_deploy_and_publish_live_network_no_explorer(
    owner, minimal_proxy_container, dummy_live_network, ape_caplog
):
    dummy_live_network.__dict__["explorer"] = None
    expected_message = "Unable to publish contract - no explorer plugin installed."
    contract = owner.deploy(minimal_proxy_container, publish=True, required_confirmations=0)
    assert contract.address
    assert expected_message in ape_caplog.head


@explorer_test
def test_deploy_and_publish(
    owner, minimal_proxy_container, dummy_live_network_with_explorer, mock_explorer
):
    contract = owner.deploy(minimal_proxy_container, publish=True, required_confirmations=0)
    mock_explorer.publish_contract.assert_called_once_with(contract.address)


@explorer_test
def test_deploy_and_publish_explorer_failure(
    owner,
    minimal_proxy_container,
    dummy_live_network_with_explorer,
    mock_explorer,
    ape_caplog,
):
    mock_explorer.publish_contract.side_effect = RuntimeError("Verification failed.")
    contract = owner.deploy(minimal_proxy_container, publish=True, required_confirmations=0)
    assert contract.address
    assert (
        "Contract was deployed but explorer verification failed: Verification failed."
        in ape_caplog.head
    )


@explorer_test
def test_deploy_and_not_publish(
    owner, minimal_proxy_container, dummy_live_network_with_explorer, mock_explorer
):
    owner.deploy(minimal_proxy_container, publish=True, required_confirmations=0)
    assert not mock_explorer.call_count


def test_deploy_proxy(owner, vyper_contract_instance, project, chain):
    target = vyper_contract_instance.address
    proxy = owner.deploy(project.SimpleProxy, target)

    # Ensure we can call both proxy and target methods on it.
    assert proxy.implementation  # No attr err
    assert proxy.myNumber  # No attr err

    # Ensure was properly cached.
    assert proxy.address in chain.contracts.contract_types
    assert proxy.address in chain.contracts.proxy_infos

    # Show the cached proxy info is correct.
    proxy_info = chain.contracts.proxy_infos[proxy.address]
    assert proxy_info.target == target
    assert proxy_info.type == ProxyType.Delegate
    assert proxy_info.abi.name == "implementation"

    # Show we get the implementation contract type using the proxy address
    re_contract = chain.contracts.instance_at(proxy.address)
    assert re_contract.contract_type == proxy.contract_type

    # Show proxy methods are not available on target alone.
    target = chain.contracts.instance_at(proxy_info.target)
    assert target.myNumber  # No attr err
    with pytest.raises(AttributeError):
        _ = target.implementation


def test_deploy_instance(owner, vyper_contract_instance):
    """
    Tests against a confusing scenario where you would get a SignatureError when
    trying to deploy a ContractInstance because Ape would attempt to create a tx
    by calling the contract's default handler.
    """

    expected = (
        r"contract argument must be a ContractContainer type, "
        r"such as 'project\.MyContract' where 'MyContract' is the "
        r"name of a contract in your project\."
    )
    with pytest.raises(TypeError, match=expected):
        owner.deploy(vyper_contract_instance)


@pytest.mark.parametrize("bytecode", (None, {}, {"bytecode": "0x"}))
def test_deploy_no_deployment_bytecode(owner, bytecode):
    """
    https://github.com/ApeWorX/ape/issues/1904
    """
    expected = (
        r"Cannot deploy: contract 'Apes' has no deployment-bytecode\. "
        r"Are you attempting to deploy an interface\?"
    )
    contract_type = ContractType.model_validate(
        {"abi": [], "contractName": "Apes", "deploymentBytecode": bytecode}
    )
    contract = ContractContainer(contract_type)
    with pytest.raises(MissingDeploymentBytecodeError, match=expected):
        owner.deploy(contract)


def test_deploy_contract_type(owner, project, clean_contract_caches):
    contract_type = project.VyperContract.contract_type
    contract = owner.deploy(contract_type, 0)
    assert contract.address
    assert contract.txn_hash


def test_deploy_sending_funds_to_non_payable_constructor(project, owner):
    with pytest.raises(
        MethodNonPayableError,
        match=r"Sending funds to a non-payable constructor\.",
    ):
        owner.deploy(project.SolidityContract, 1, value="1 ether")


def test_send_transaction_with_bad_nonce(sender, receiver):
    # Bump the nonce so we can set one that is too low.
    sender.transfer(receiver, "1 gwei", type=0)

    with pytest.raises(AccountsError, match="Invalid nonce, will not publish."):
        sender.transfer(receiver, "1 gwei", type=0, nonce=0)


def test_send_transaction_without_enough_funds(sender, receiver, eth_tester_provider, convert):
    expected = (
        rf"Transfer value meets or exceeds account balance for account '{sender.address}' .*"
        rf"on chain '{eth_tester_provider.chain_id}' using provider '{eth_tester_provider.name}'\."
        rf"\nAre you using the correct account / chain \/ provider combination\?"
        rf"\n\(transfer_value=\d+, balance=\d+\)\."
    )
    with pytest.raises(AccountsError, match=expected):
        sender.transfer(receiver, "10000000000000 ETH")


def test_send_transaction_without_enough_funds_impersonated_account(
    receiver, accounts, eth_tester_provider, convert
):
    address = "0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97"  # Not a test account!
    impersonated_account = ImpersonatedAccount(raw_address=address)
    accounts._impersonated_accounts[address] = impersonated_account

    # Basically, it failed anywhere else besides the AccountsError you get from not
    # enough balance.
    with pytest.raises(SignatureError):
        impersonated_account.transfer(receiver, "10000000000000 ETH")


def test_send_transaction_sets_defaults(sender, receiver):
    receipt = sender.transfer(receiver, "1 GWEI", gas_limit=None, required_confirmations=None)
    assert receipt.gas_limit > 0
    assert receipt.required_confirmations == 0


def test_account_index_access(accounts):
    account = accounts[0]
    assert account.index == 0
    last_account = accounts[-1]
    assert last_account.index == len(accounts) - 1


def test_accounts_splice_access(accounts):
    alice, bob = accounts[:2]
    assert alice == accounts[0]
    assert bob == accounts[1]
    cat = accounts[-1]
    assert cat == accounts[len(accounts) - 1]
    expected = (len(accounts) // 2) if len(accounts) % 2 == 0 else (len(accounts) // 2 + 1)
    assert len(accounts[::2]) == expected


def test_accounts_address_access(owner, accounts):
    assert accounts[owner.address] == owner


def test_accounts_address_access_conversion_fail(account_manager):
    with pytest.raises(
        KeyError,
        match=(
            r"No account with ID 'FAILS'\. "
            r"Do you have the necessary conversion plugins installed?"
        ),
    ):
        _ = account_manager["FAILS"]


def test_accounts_address_access_not_found(accounts):
    address = "0x1222262222222922222222222222222222222222"
    with pytest.raises(KeyError, match=rf"No account with address '{address}'\."):
        _ = accounts[address]


def test_test_accounts_address_access_conversion_fail(accounts):
    with pytest.raises(KeyError, match=r"No account with ID 'FAILS'"):
        _ = accounts["FAILS"]


def test_test_accounts_address_access_not_found(accounts):
    address = "0x1222262222222922222222222222222222222222"
    with pytest.raises(KeyError, match=rf"No account with address '{address}'\."):
        _ = accounts[address]


def test_accounts_contains(accounts, owner):
    assert owner.address in accounts


def test_autosign_messages(runner, keyfile_account, message):
    keyfile_account.set_autosign(True, passphrase=PASSPHRASE)
    signature = keyfile_account.sign_message(message)
    assert keyfile_account.check_signature(message, signature)

    # Re-enable prompted signing
    keyfile_account.set_autosign(False)
    with runner.isolation(input=f"y\n{PASSPHRASE}\n"):
        signature = keyfile_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)


def test_autosign_transactions(runner, keyfile_account, receiver):
    keyfile_account.set_autosign(True, passphrase=PASSPHRASE)
    assert keyfile_account.transfer(receiver, "1 gwei")

    # Re-enable prompted signing
    keyfile_account.set_autosign(False)
    with runner.isolation(input=f"y\n{PASSPHRASE}\n"):
        assert keyfile_account.transfer(receiver, "1 gwei")


def test_impersonate_not_implemented(accounts, address):
    expected_err_msg = (
        r"Provider 'test' does not support impersonating accounts:\\n"
        rf"No account with address '{address}'\."
    )
    with pytest.raises(KeyError, match=expected_err_msg):
        _ = accounts[address]


def test_impersonated_account_ignores_signature_check_on_txn(accounts, address):
    account = ImpersonatedAccount(raw_address=address)

    # Impersonate hack, since no providers in core actually support it.
    accounts._impersonated_accounts[address] = account
    other_0 = accounts[8]
    other_1 = accounts[9]
    txn = other_0.transfer(other_1, "1 gwei").transaction

    # Hack in fake sender.
    txn.sender = address
    actual = txn.serialize_transaction()

    # Normally, you'd get a signature error here, but since the account is registered
    # as impersonated, ape lets it slide because it knows it won't match.
    assert isinstance(actual, bytes)


def test_contract_as_sender_non_fork_network(contract_instance):
    expected_err_msg = (
        r"Provider 'test' does not support impersonating accounts:\\n"
        rf"No account with address '{contract_instance}'\."
    )
    with pytest.raises(KeyError, match=expected_err_msg):
        contract_instance.setNumber(5, sender=contract_instance)


def test_unlock_with_passphrase_and_sign_message(runner, keyfile_account, message):
    keyfile_account.unlock(passphrase=PASSPHRASE)

    # y: yes, sign (note: unlocking makes the key available but is not the same as autosign).
    with runner.isolation(input="y\n"):
        signature = keyfile_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)


def test_unlock_from_prompt_and_sign_message(runner, keyfile_account, message):
    # a = password
    with runner.isolation(input=f"{PASSPHRASE}\n"):
        keyfile_account.unlock()

    # yes, sign the message
    with runner.isolation(input="y\n"):
        signature = keyfile_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)


def test_unlock_from_prompt_retries_and_succeeds(runner, keyfile_account):
    with runner.isolation(input=f"{INVALID_PASSPHRASE}\n{INVALID_PASSPHRASE}\n{PASSPHRASE}\n"):
        keyfile_account.unlock()

    assert not keyfile_account.locked


def test_unlock_from_prompt_fails_after_three_attempts(runner, keyfile_account):
    with runner.isolation(
        input=f"{INVALID_PASSPHRASE}\n{INVALID_PASSPHRASE}\n{INVALID_PASSPHRASE}\n"
    ):
        with pytest.raises(AccountsError, match="Failed to unlock after 3 attempts."):
            keyfile_account.unlock()

    assert keyfile_account.locked


def test_unlock_with_passphrase_and_sign_transaction(runner, keyfile_account, receiver):
    keyfile_account.unlock(passphrase=PASSPHRASE)
    # y: yes, sign (note: unlocking makes the key available but is not the same as autosign).
    with runner.isolation(input="y\n"):
        receipt = keyfile_account.transfer(receiver, "1 gwei")
        assert receipt.receiver == receiver


def test_unlock_from_prompt_and_sign_transaction(runner, keyfile_account, receiver):
    # a = password
    with runner.isolation(input=f"{PASSPHRASE}\n"):
        keyfile_account.unlock()

    # yes, sign the transaction
    with runner.isolation(input="y\n"):
        receipt = keyfile_account.transfer(receiver, "1 gwei")
        assert receipt.receiver == receiver


def test_unlock_with_passphrase_from_env_and_sign_message(runner, keyfile_account, message):
    ENV_VARIABLE = f"APE_ACCOUNTS_{keyfile_account.alias}_PASSPHRASE"

    # Set environment variable with passphrase
    environ[ENV_VARIABLE] = PASSPHRASE

    # Unlock using environment variable
    keyfile_account.unlock()

    # Account should be unlocked
    assert not keyfile_account.locked

    # y: yes, sign (note: unlocking makes the key available but is not the same as autosign).
    with runner.isolation(input="y\n"):
        signature = keyfile_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)


def test_unlock_with_wrong_passphrase_from_env(keyfile_account):
    ENV_VARIABLE = f"APE_ACCOUNTS_{keyfile_account.alias}_PASSPHRASE"
    # Set environment variable with passphrase
    environ[ENV_VARIABLE] = INVALID_PASSPHRASE

    # Use pytest.raises to assert that InvalidPasswordError is raised
    with pytest.raises(AccountsError, match="Invalid password"):
        # Unlock using environment variable
        keyfile_account.unlock()

    # Account should be unlocked
    assert keyfile_account.locked


def test_unlock_and_reload(runner, account_manager, keyfile_account, message):
    """
    Tests against a condition where reloading after unlocking
    would not honor unlocked state.
    """
    keyfile_account.unlock(passphrase=PASSPHRASE)
    reloaded_account = account_manager.load(keyfile_account.alias)

    # y: yes, sign (note: unlocking makes the key available but is not the same as autosign).
    with runner.isolation(input="y\n"):
        signature = reloaded_account.sign_message(message)
        assert keyfile_account.check_signature(message, signature)


def test_custom_num_of_test_accounts_config(accounts, project):
    custom_number_of_test_accounts = 25
    test_config = {
        "test": {
            "number_of_accounts": custom_number_of_test_accounts,
        }
    }
    with project.temp_config(**test_config):
        assert len(accounts) == custom_number_of_test_accounts


def test_test_accounts_repr(accounts, config):
    actual = repr(accounts)
    assert config.get_config("test").hd_path in actual

    # Show actual test-account repr (address should be checksummed).
    actual = repr(accounts[0])
    assert accounts[0].address in actual


def test_account_comparison_to_non_account(core_account):
    # Before, would get a ConversionError.
    assert core_account != "foo"


def test_create_account(accounts):
    length_at_start = len(accounts)
    created_account = accounts.generate_test_account()

    assert isinstance(created_account, TestAccount)
    assert created_account.index == length_at_start

    length_at_start = len(accounts)
    second_created_account = accounts.generate_test_account()
    assert len(accounts) == length_at_start + 1

    assert created_account.address != second_created_account.address
    assert second_created_account.index == created_account.index + 1

    # Last index should now refer to the last-created account.
    last_idx_acct = accounts[-1]
    assert last_idx_acct.index == second_created_account.index
    assert last_idx_acct.address == second_created_account.address
    assert last_idx_acct.address != accounts[0].address
    assert last_idx_acct.address != created_account.address


def test_dir(core_account):
    actual = dir(core_account)
    expected = [
        "address",
        "alias",
        "balance",
        "call",
        "delegate",
        "delegate_to",
        "deploy",
        "nonce",
        "prepare_transaction",
        "provider",
        "remove_delegate",
        "set_delegate",
        "sign_authorization",
        "sign_message",
        "sign_transaction",
        "transfer",
    ]
    assert sorted(actual) == sorted(expected)


def test_is_not_contract(owner, keyfile_account):
    assert not owner.is_contract
    assert not keyfile_account.is_contract


def test_using_different_hd_path(accounts, project, eth_tester_provider):
    test_config = {
        "test": {
            "hd_path": "m/44'/60'/0/0",
        }
    }

    old_address = accounts[0].address
    original_settings = eth_tester_provider.settings.model_dump(by_alias=True)
    with project.temp_config(**test_config):
        eth_tester_provider.update_settings(test_config["test"])
        new_address = accounts[0].address

    eth_tester_provider.update_settings(original_settings)
    assert old_address != new_address


def test_mnemonic(accounts):
    actual = accounts.mnemonic
    expected = DEFAULT_TEST_MNEMONIC
    assert actual == expected


def test_mnemonic_setter(accounts):
    original_mnemonic = accounts.mnemonic
    new_mnemonic = "candy maple cake sugar pudding cream honey rich smooth crumble sweet treat"
    original_address = accounts[0].address

    # Change.
    accounts.mnemonic = new_mnemonic
    new_address = accounts[0].address

    # Put back.
    accounts.mnemonic = original_mnemonic

    # Assert.
    assert new_address != original_address


def test_iter_test_accounts(accounts):
    accounts.reset()
    accounts = list(iter(accounts))
    actual = len(accounts)
    expected = len(accounts)
    assert actual == expected


def test_declare(contract_container, sender):
    receipt = sender.declare(contract_container)
    assert not receipt.failed


def test_prepare_transaction(ethereum, sender):
    tx = ethereum.create_transaction()
    prepared_tx = sender.prepare_transaction(tx)
    assert prepared_tx.sender == sender.address
    assert prepared_tx.signature is None


def test_prepare_transaction_sign(sender, ethereum):
    tx = ethereum.create_transaction()
    prepared_tx = sender.prepare_transaction(tx, sign=True)
    assert prepared_tx.sender == sender.address
    assert prepared_tx.signature is not None


@pytest.mark.parametrize("tx_type", (TransactionType.STATIC, TransactionType.DYNAMIC))
def test_prepare_transaction_using_auto_gas(sender, ethereum, tx_type):
    params = (
        ("gas_price",) if tx_type is TransactionType.STATIC else ("max_fee", "max_priority_fee")
    )

    def clear_network_property_cached():
        for field in ("gas_limit", "auto_gas_multiplier"):
            if field in ethereum.local.__dict__:
                del ethereum.local.__dict__[field]

    auto_gas = AutoGasLimit(multiplier=1.0)
    original_limit = ethereum.config.local.gas_limit

    try:
        clear_network_property_cached()
        ethereum.config.local.gas_limit = auto_gas
        assert ethereum.local.gas_limit == auto_gas, "Setup failed - auto gas not set."

        # NOTE: Must create tx _after_ setting network gas value.
        tx = ethereum.create_transaction(type=tx_type)

        # Show tx doesn't have these by default.
        assert tx.nonce is None
        for param in params:
            # Custom fields depending on type.
            assert getattr(tx, param) is None, f"'{param}' unexpectedly set."

        # Gas should NOT yet be estimated, as that happens closer to sending.
        assert tx.gas_limit is None

        # Sets fields.
        tx = sender.prepare_transaction(tx)

        # We expect these fields to have been set.
        assert tx.nonce is not None
        assert tx.gas_limit is not None

        # Show multipliers work. First, reset network to use one (hack).
        gas_smaller = tx.gas_limit

        auto_gas.multiplier = 1.1
        ethereum.config.local.gas_limit = auto_gas
        clear_network_property_cached()
        assert ethereum.local.gas_limit == auto_gas, "Setup failed - auto gas multiplier not set."

        tx2 = ethereum.create_transaction(type=tx_type)
        tx2 = sender.prepare_transaction(tx2)
        gas_bigger = tx2.gas_limit
        assert gas_smaller < gas_bigger

        for param in params:
            assert getattr(tx, param) is not None

    finally:
        ethereum.config.local.gas_limit = original_limit
        clear_network_property_cached()


@pytest.mark.parametrize("tx_type", (TransactionType.STATIC, TransactionType.DYNAMIC))
def test_prepare_transaction_and_call_using_max_gas(tx_type, ethereum, sender, eth_tester_provider):
    tx = ethereum.create_transaction(type=tx_type.value)
    tx = sender.prepare_transaction(tx)
    assert tx.gas_limit == eth_tester_provider.max_gas, "Test setup failed - gas limit unexpected."

    actual = sender.call(tx)
    assert not actual.failed


def test_authorizations_transaction(sender, vyper_contract_instance):
    assert not sender.delegate

    # NOTE: 0x23fd0e40 is method_id for `myNumber()`
    # NOTE: Must call something, since `__default__` raises
    with sender.delegate_to(vyper_contract_instance, data="0x23fd0e40") as delegate:
        assert sender.delegate == vyper_contract_instance
        assert delegate.myNumber() == 0

    sender.remove_delegate()
    assert not sender.delegate


def test_public_key(runner, keyfile_account, owner):
    with runner.isolation(input=f"{PASSPHRASE}\ny\n"):
        pub_key = keyfile_account.public_key
        assert isinstance(keyfile_account.public_key, HexBytes)

        # Prove it is the correct public key by deriving the address.
        derived_address = to_checksum_address(keccak(pub_key)[-20:])
        assert derived_address == keyfile_account.address

    # Also, show the test accounts have access to their public key.
    derived_address = to_checksum_address(keccak(owner.public_key)[-20:])
    assert derived_address == owner.address


def test_load_public_key_from_keyfile(runner, keyfile_account):
    with runner.isolation(input=f"{PASSPHRASE}\ny\n"):
        assert isinstance(keyfile_account.public_key, HexBytes)

        assert (
            to_hex(keyfile_account.public_key)
            == "0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5"  # noqa: E501
        )
        # no need for password when loading from the keyfile
        assert keyfile_account.public_key


def test_generate_account(delete_account_after):
    alias = "gentester"
    with delete_account_after(alias):
        account, mnemonic = generate_account(alias, PASSPHRASE)
        assert len(mnemonic.split(" ")) == 12
        assert isinstance(account, KeyfileAccount)
        assert account.alias == alias
        assert account.locked is True
        account.unlock(PASSPHRASE)
        assert account.locked is False


def test_generate_account_invalid_alias(delete_account_after):
    with pytest.raises(AccountsError, match="Longer aliases cannot be hex strings."):
        generate_account(
            "3fbc0ce3e71421b94f7ff4e753849c540dec9ade57bad60ebbc521adcbcbc024", "asdf1234"
        )

    with pytest.raises(AccountsError, match="Alias must be a str"):
        # Testing an invalid type as arg, so ignoring
        generate_account(b"imma-bytestr", "asdf1234")  # type: ignore

    used_alias = "used"
    with delete_account_after(used_alias):
        generate_account(used_alias, "qwerty1")
        with pytest.raises(AliasAlreadyInUseError):
            generate_account(used_alias, "asdf1234")


def test_generate_account_invalid_passphrase():
    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        generate_account("invalid-passphrase", "")

    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        generate_account("invalid-passphrase", b"bytestring")  # type: ignore


def test_generate_account_insecure_passphrase(delete_account_after):
    short_alias = "shortaccount"
    with delete_account_after(short_alias):
        with pytest.warns(UserWarning, match="short"):
            generate_account(short_alias, "short")

    simple_alias = "simpleaccount"
    with delete_account_after(simple_alias):
        with pytest.warns(UserWarning, match="simple"):
            generate_account(simple_alias, "simple")


def test_import_account_from_mnemonic(delete_account_after):
    alias = "iafmtester"
    with delete_account_after(alias):
        account = import_account_from_mnemonic(alias, PASSPHRASE, MNEMONIC)
        assert isinstance(account, KeyfileAccount)
        assert account.alias == alias
        assert account.address == "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
        assert account.locked is True
        account.unlock(PASSPHRASE)
        assert account.locked is False


def test_import_account_from_mnemonic_invalid_alias(delete_account_after):
    with pytest.raises(AccountsError, match="Longer aliases cannot be hex strings."):
        import_account_from_mnemonic(
            "3fbc0ce3e71421b94f7ff4e753849c540dec9ade57bad60ebbc521adcbcbc024", "asdf1234", MNEMONIC
        )

    with pytest.raises(AccountsError, match="Alias must be a str"):
        # Testing an invalid type as arg, so ignoring
        import_account_from_mnemonic(b"imma-bytestr", "asdf1234", MNEMONIC)  # type: ignore

    used_alias = "iamfused"
    with delete_account_after(used_alias):
        import_account_from_mnemonic(used_alias, "qwerty1", MNEMONIC)
        with pytest.raises(AliasAlreadyInUseError):
            import_account_from_mnemonic(used_alias, "asdf1234", MNEMONIC)


def test_import_account_from_mnemonic_invalid_passphrase():
    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        import_account_from_mnemonic("invalid-passphrase", "", MNEMONIC)

    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        import_account_from_mnemonic("invalid-passphrase", b"bytestring", MNEMONIC)  # type: ignore


def test_import_account_from_mnemonic_insecure_passphrase(delete_account_after):
    short_alias = "iafmshortaccount"
    with delete_account_after(short_alias):
        with pytest.warns(UserWarning, match="short"):
            import_account_from_mnemonic(short_alias, "short", MNEMONIC)

    simple_alias = "iafmsimpleaccount"
    with delete_account_after(simple_alias):
        with pytest.warns(UserWarning, match="simple"):
            import_account_from_mnemonic(simple_alias, "simple", MNEMONIC)


def test_import_account_from_private_key(delete_account_after):
    alias = "iafpktester"
    with delete_account_after(alias):
        account = import_account_from_private_key(alias, PASSPHRASE, PRIVATE_KEY)
        assert isinstance(account, KeyfileAccount)
        assert account.alias == alias
        assert account.address == "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
        assert account.locked is True
        account.unlock(PASSPHRASE)
        assert account.locked is False


def test_import_account_from_private_key_invalid_alias(delete_account_after):
    with pytest.raises(AccountsError, match="Longer aliases cannot be hex strings."):
        import_account_from_private_key(
            "3fbc0ce3e71421b94f7ff4e753849c540dec9ade57bad60ebbc521adcbcbc024",
            "asdf1234",
            PRIVATE_KEY,
        )

    with pytest.raises(AccountsError, match="Alias must be a str"):
        # Testing an invalid type as arg, so ignoring
        import_account_from_private_key(b"imma-bytestr", "asdf1234", PRIVATE_KEY)  # type: ignore

    used_alias = "iafpkused"
    with delete_account_after(used_alias):
        import_account_from_private_key(used_alias, "qwerty1", PRIVATE_KEY)
        with pytest.raises(AliasAlreadyInUseError):
            import_account_from_private_key(used_alias, "asdf1234", PRIVATE_KEY)


def test_import_account_from_private_key_invalid_passphrase():
    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        import_account_from_private_key("invalid-passphrase", "", PRIVATE_KEY)

    with pytest.raises(AccountsError, match="Account file encryption passphrase must be provided."):
        import_account_from_private_key(
            "invalid-passphrase",
            b"bytestring",  # type: ignore
            PRIVATE_KEY,
        )


def test_import_account_from_private_key_insecure_passphrase(delete_account_after):
    short_alias = "iafpkshortaccount"
    with delete_account_after(short_alias):
        with pytest.warns(UserWarning, match="short"):
            import_account_from_private_key(short_alias, "short", PRIVATE_KEY)

    simple_alias = "iafpksimpleaccount"
    with delete_account_after(simple_alias):
        with pytest.warns(UserWarning, match="simple"):
            import_account_from_private_key(simple_alias, "simple", PRIVATE_KEY)


def test_load(account_manager, keyfile_account):
    account = account_manager.load(keyfile_account.alias)
    assert account == keyfile_account


def test_get_deployment_address(owner, project):
    deployment_address_1 = owner.get_deployment_address()
    deployment_address_2 = owner.get_deployment_address(nonce=owner.nonce + 1)
    instance_1 = owner.deploy(project.VyperContract, 490)
    assert instance_1.address == deployment_address_1
    instance_2 = owner.deploy(project.VyperContract, 490)
    assert instance_2.address == deployment_address_2


def test_repr(account_manager):
    """
    NOTE: __repr__ should be simple and fast!
      Previously, we showed the repr of all the accounts.
      That was a bad idea, as that can be very unnecessarily slow.
      Hence, this test exists to ensure care is taken.
    """
    actual = repr(account_manager)
    assert actual == "<AccountManager>"


def test_call(owner, vyper_contract_instance):
    tx = vyper_contract_instance.setNumber.as_transaction(5991)
    receipt = owner.call(tx)
    assert not receipt.failed


def test_call_sign_false(owner, vyper_contract_instance):
    tx = vyper_contract_instance.setNumber.as_transaction(5991)
    with pytest.raises(SignatureError):
        owner.call(tx, sign=False)


def test_resolve_address(owner, keyfile_account, account_manager, vyper_contract_instance):
    # Test test-account alias input.
    actual = account_manager.resolve_address(owner.alias)
    assert actual == owner.address

    # Test keyfile-account alias input.
    actual = account_manager.resolve_address(keyfile_account.alias)
    assert actual == keyfile_account.address

    # Test address input.
    actual = account_manager.resolve_address(owner.address)
    assert actual == owner.address

    # Test account input.
    actual = account_manager.resolve_address(owner)
    assert actual == owner.address

    # Test contract input.
    actual = account_manager.resolve_address(vyper_contract_instance)
    assert actual == vyper_contract_instance.address

    # Test int input.
    actual = account_manager.resolve_address(int(owner.address, 16))
    assert actual == owner.address

    # Test int input.
    actual = account_manager.resolve_address(HexBytes(owner.address))
    assert actual == owner.address


def test_use_ape_signer(accounts, project):
    """
    Showing you can use the inner Ape account (base class) directly as an ape account in txns.
    """
    signer = ApeSigner(private_key=accounts[5].private_key)
    assert isinstance(signer, ApeSigner)
    contract = project.VyperContract.deploy(1012, sender=signer)
    assert contract.is_contract