ExploitContract.py

# Code generated by moonworm : https://github.com/bugout-dev/moonworm
# Moonworm version : 0.2.2

import argparse
import json
import os
from pathlib import Path
from typing import Any, Dict, List, Optional, Union

from brownie import Contract, network, project
from brownie.network.contract import ContractContainer
from eth_typing.evm import ChecksumAddress


PROJECT_DIRECTORY = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))
BUILD_DIRECTORY = os.path.join(PROJECT_DIRECTORY, "build", "contracts")


def boolean_argument_type(raw_value: str) -> bool:
    TRUE_VALUES = ["1", "t", "y", "true", "yes"]
    FALSE_VALUES = ["0", "f", "n", "false", "no"]

    if raw_value.lower() in TRUE_VALUES:
        return True
    elif raw_value.lower() in FALSE_VALUES:
        return False

    raise ValueError(
        f"Invalid boolean argument: {raw_value}. Value must be one of: {','.join(TRUE_VALUES + FALSE_VALUES)}"
    )


def bytes_argument_type(raw_value: str) -> str:
    return raw_value


def get_abi_json(abi_name: str) -> List[Dict[str, Any]]:
    abi_full_path = os.path.join(BUILD_DIRECTORY, f"{abi_name}.json")
    if not os.path.isfile(abi_full_path):
        raise IOError(
            f"File does not exist: {abi_full_path}. Maybe you have to compile the smart contracts?"
        )

    with open(abi_full_path, "r") as ifp:
        build = json.load(ifp)

    abi_json = build.get("abi")
    if abi_json is None:
        raise ValueError(f"Could not find ABI definition in: {abi_full_path}")

    return abi_json


def contract_from_build(abi_name: str) -> ContractContainer:
    # This is workaround because brownie currently doesn't support loading the same project multiple
    # times. This causes problems when using multiple contracts from the same project in the same
    # python project.
    PROJECT = project.main.Project("moonworm", Path(PROJECT_DIRECTORY))

    abi_full_path = os.path.join(BUILD_DIRECTORY, f"{abi_name}.json")
    if not os.path.isfile(abi_full_path):
        raise IOError(
            f"File does not exist: {abi_full_path}. Maybe you have to compile the smart contracts?"
        )

    with open(abi_full_path, "r") as ifp:
        build = json.load(ifp)

    return ContractContainer(PROJECT, build)


class ExploitContract:
    def __init__(self, contract_address: Optional[ChecksumAddress]):
        self.contract_name = "ExploitContract"
        self.address = contract_address
        self.contract = None
        self.abi = get_abi_json("ExploitContract")
        if self.address is not None:
            self.contract: Optional[Contract] = Contract.from_abi(
                self.contract_name, self.address, self.abi
            )

    def deploy(self, transaction_config):
        contract_class = contract_from_build(self.contract_name)
        deployed_contract = contract_class.deploy(transaction_config)
        self.address = deployed_contract.address
        self.contract = deployed_contract
        return deployed_contract.tx

    def assert_contract_is_instantiated(self) -> None:
        if self.contract is None:
            raise Exception("contract has not been instantiated")

    def verify_contract(self):
        self.assert_contract_is_instantiated()
        contract_class = contract_from_build(self.contract_name)
        contract_class.publish_source(self.contract)

    def did_exploit(self, block_number: Optional[Union[str, int]] = "latest") -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.didExploit.call(block_identifier=block_number)

    def exploit(
        self, exploitable_contract_address: ChecksumAddress, transaction_config
    ) -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.exploit(exploitable_contract_address, transaction_config)

    def notify(self, transaction_config) -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.notify(transaction_config)

    def set_should_call_exploitable_function(
        self, _should_call: bool, transaction_config
    ) -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.setShouldCallExploitableFunction(
            _should_call, transaction_config
        )

    def set_should_exploit(self, _should_exploit: bool, transaction_config) -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.setShouldExploit(_should_exploit, transaction_config)

    def should_call_exploitable_function(
        self, block_number: Optional[Union[str, int]] = "latest"
    ) -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.shouldCallExploitableFunction.call(
            block_identifier=block_number
        )

    def should_exploit(self, block_number: Optional[Union[str, int]] = "latest") -> Any:
        self.assert_contract_is_instantiated()
        return self.contract.shouldExploit.call(block_identifier=block_number)


def get_transaction_config(args: argparse.Namespace) -> Dict[str, Any]:
    signer = network.accounts.load(args.sender, args.password)
    transaction_config: Dict[str, Any] = {"from": signer}
    if args.gas_price is not None:
        transaction_config["gas_price"] = args.gas_price
    if args.max_fee_per_gas is not None:
        transaction_config["max_fee"] = args.max_fee_per_gas
    if args.max_priority_fee_per_gas is not None:
        transaction_config["priority_fee"] = args.max_priority_fee_per_gas
    if args.confirmations is not None:
        transaction_config["required_confs"] = args.confirmations
    if args.nonce is not None:
        transaction_config["nonce"] = args.nonce
    return transaction_config


def add_default_arguments(parser: argparse.ArgumentParser, transact: bool) -> None:
    parser.add_argument(
        "--network", required=True, help="Name of brownie network to connect to"
    )
    parser.add_argument(
        "--address", required=False, help="Address of deployed contract to connect to"
    )
    if not transact:
        parser.add_argument(
            "--block-number",
            required=False,
            type=int,
            help="Call at the given block number, defaults to latest",
        )
        return
    parser.add_argument(
        "--sender", required=True, help="Path to keystore file for transaction sender"
    )
    parser.add_argument(
        "--password",
        required=False,
        help="Password to keystore file (if you do not provide it, you will be prompted for it)",
    )
    parser.add_argument(
        "--gas-price", default=None, help="Gas price at which to submit transaction"
    )
    parser.add_argument(
        "--max-fee-per-gas",
        default=None,
        help="Max fee per gas for EIP1559 transactions",
    )
    parser.add_argument(
        "--max-priority-fee-per-gas",
        default=None,
        help="Max priority fee per gas for EIP1559 transactions",
    )
    parser.add_argument(
        "--confirmations",
        type=int,
        default=None,
        help="Number of confirmations to await before considering a transaction completed",
    )
    parser.add_argument(
        "--nonce", type=int, default=None, help="Nonce for the transaction (optional)"
    )
    parser.add_argument(
        "--value", default=None, help="Value of the transaction in wei(optional)"
    )
    parser.add_argument("--verbose", action="store_true", help="Print verbose output")


def handle_deploy(args: argparse.Namespace) -> None:
    network.connect(args.network)
    transaction_config = get_transaction_config(args)
    contract = ExploitContract(None)
    result = contract.deploy(transaction_config=transaction_config)
    print(result)
    if args.verbose:
        print(result.info())


def handle_verify_contract(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    result = contract.verify_contract()
    print(result)


def handle_did_exploit(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    result = contract.did_exploit(block_number=args.block_number)
    print(result)


def handle_exploit(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    transaction_config = get_transaction_config(args)
    result = contract.exploit(
        exploitable_contract_address=args.exploitable_contract_address,
        transaction_config=transaction_config,
    )
    print(result)
    if args.verbose:
        print(result.info())


def handle_notify(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    transaction_config = get_transaction_config(args)
    result = contract.notify(transaction_config=transaction_config)
    print(result)
    if args.verbose:
        print(result.info())


def handle_set_should_call_exploitable_function(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    transaction_config = get_transaction_config(args)
    result = contract.set_should_call_exploitable_function(
        _should_call=args.should_call_arg, transaction_config=transaction_config
    )
    print(result)
    if args.verbose:
        print(result.info())


def handle_set_should_exploit(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    transaction_config = get_transaction_config(args)
    result = contract.set_should_exploit(
        _should_exploit=args.should_exploit_arg, transaction_config=transaction_config
    )
    print(result)
    if args.verbose:
        print(result.info())


def handle_should_call_exploitable_function(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    result = contract.should_call_exploitable_function(block_number=args.block_number)
    print(result)


def handle_should_exploit(args: argparse.Namespace) -> None:
    network.connect(args.network)
    contract = ExploitContract(args.address)
    result = contract.should_exploit(block_number=args.block_number)
    print(result)


def generate_cli() -> argparse.ArgumentParser:
    parser = argparse.ArgumentParser(description="CLI for ExploitContract")
    parser.set_defaults(func=lambda _: parser.print_help())
    subcommands = parser.add_subparsers()

    deploy_parser = subcommands.add_parser("deploy")
    add_default_arguments(deploy_parser, True)
    deploy_parser.set_defaults(func=handle_deploy)

    verify_contract_parser = subcommands.add_parser("verify-contract")
    add_default_arguments(verify_contract_parser, False)
    verify_contract_parser.set_defaults(func=handle_verify_contract)

    did_exploit_parser = subcommands.add_parser("did-exploit")
    add_default_arguments(did_exploit_parser, False)
    did_exploit_parser.set_defaults(func=handle_did_exploit)

    exploit_parser = subcommands.add_parser("exploit")
    add_default_arguments(exploit_parser, True)
    exploit_parser.add_argument(
        "--exploitable-contract-address", required=True, help="Type: address"
    )
    exploit_parser.set_defaults(func=handle_exploit)

    notify_parser = subcommands.add_parser("notify")
    add_default_arguments(notify_parser, True)
    notify_parser.set_defaults(func=handle_notify)

    set_should_call_exploitable_function_parser = subcommands.add_parser(
        "set-should-call-exploitable-function"
    )
    add_default_arguments(set_should_call_exploitable_function_parser, True)
    set_should_call_exploitable_function_parser.add_argument(
        "--should-call-arg",
        required=True,
        help="Type: bool",
        type=boolean_argument_type,
    )
    set_should_call_exploitable_function_parser.set_defaults(
        func=handle_set_should_call_exploitable_function
    )

    set_should_exploit_parser = subcommands.add_parser("set-should-exploit")
    add_default_arguments(set_should_exploit_parser, True)
    set_should_exploit_parser.add_argument(
        "--should-exploit-arg",
        required=True,
        help="Type: bool",
        type=boolean_argument_type,
    )
    set_should_exploit_parser.set_defaults(func=handle_set_should_exploit)

    should_call_exploitable_function_parser = subcommands.add_parser(
        "should-call-exploitable-function"
    )
    add_default_arguments(should_call_exploitable_function_parser, False)
    should_call_exploitable_function_parser.set_defaults(
        func=handle_should_call_exploitable_function
    )

    should_exploit_parser = subcommands.add_parser("should-exploit")
    add_default_arguments(should_exploit_parser, False)
    should_exploit_parser.set_defaults(func=handle_should_exploit)

    return parser


def main() -> None:
    parser = generate_cli()
    args = parser.parse_args()
    args.func(args)


if __name__ == "__main__":
    main()