agent0.hyperfuzz.unit_fuzz.helpers.setup_fuzz
=============================================

.. py:module:: agent0.hyperfuzz.unit_fuzz.helpers.setup_fuzz

.. autoapi-nested-parse::

   Setup an interactive environment for fuzz testing.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   agent0.hyperfuzz.unit_fuzz.helpers.setup_fuzz.setup_fuzz


Module Contents
---------------

.. py:function:: setup_fuzz(chain_config: agent0.core.hyperdrive.interactive.LocalChain.Config, log_to_rollbar: bool = True, crash_log_level: int | None = None, fuzz_test_name: str | None = None, curve_fee: fixedpointmath.FixedPoint | None = None, flat_fee: fixedpointmath.FixedPoint | None = None, governance_lp_fee: fixedpointmath.FixedPoint | None = None, governance_zombie_fee: fixedpointmath.FixedPoint | None = None, var_interest: fixedpointmath.FixedPoint | None = None, steth: bool = False) -> tuple[agent0.core.hyperdrive.interactive.LocalChain, int, numpy.random.Generator, agent0.core.hyperdrive.interactive.LocalHyperdrive]

   
   Setup the fuzz experiment.

   :param chain_config: Configuration options for the local chain.
   :type chain_config: LocalChain.Config, optional
   :param log_to_rollbar: If True, log errors rollbar. Defaults to True.
   :type log_to_rollbar: bool, optional
   :param crash_log_level: The log level to log crashes at. Defaults to critical.
   :type crash_log_level: int | None, optional
   :param fuzz_test_name: The prefix to prepend to rollbar exception messages
   :type fuzz_test_name: str | None, optional
   :param curve_fee: The curve fee for the test. Defaults to using the default fee
   :type curve_fee: FixedPoint | None, optional
   :param flat_fee: The flat fee for the test. Defaults to using the default fee
   :type flat_fee: FixedPoint | None, optional
   :param governance_lp_fee: The governance lp fee for the test. Defaults to using the default fee
   :type governance_lp_fee: FixedPoint | None, optional
   :param governance_zombie_fee: The governance zombie fee for the test. Defaults to using the default fee
   :type governance_zombie_fee: FixedPoint | None, optional
   :param var_interest: The variable interest rate. Defaults to using the default variable interest rate
                        defined in interactive hyperdrive.
   :type var_interest: FixedPoint | None, optional
   :param steth: If True, use steth. Defaults to False.
   :type steth: bool, optional

   :returns:

             A tuple containing:
                 chain: LocalChain
                     An instantiated LocalChain.
                 random_seed: int
                     The random seed used to construct the Generator.
                 rng: `Generator <https://numpy.org/doc/stable/reference/random/generator.html>`_
                     The numpy Generator provides access to a wide range of distributions, and stores the random state.
                 interactive_hyperdrive: InteractiveHyperdrive
                     An instantiated InteractiveHyperdrive object.
   :rtype: tuple[str, LocalChain, int, Generator, InteractiveHyperdrive]















   ..
       !! processed by numpydoc !!