agent0.test_fixtures
====================

.. py:module:: agent0.test_fixtures

.. autoapi-nested-parse::

   
   Test fixtures for agent0.
















   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/agent0/test_fixtures/chain_fixture/index
   /autoapi/agent0/test_fixtures/hyperdrive_fixture/index
   /autoapi/agent0/test_fixtures/interface_fixture/index


Functions
---------

.. autoapisummary::

   agent0.test_fixtures.chain_fixture
   agent0.test_fixtures.fast_chain_fixture
   agent0.test_fixtures.init_chain
   agent0.test_fixtures.fast_hyperdrive_fixture
   agent0.test_fixtures.hyperdrive_fixture
   agent0.test_fixtures.init_hyperdrive
   agent0.test_fixtures.hyperdrive_read_interface_fixture
   agent0.test_fixtures.hyperdrive_read_write_interface_fixture


Package Contents
----------------

.. py:function:: chain_fixture() -> Iterator[agent0.core.hyperdrive.interactive.LocalChain]

   
   Local chain connected to a local database hosted in docker.
   This fixture launches a chain from scratch in a function scope.

   :Yields: *LocalChain* -- The local chain instance.















   ..
       !! processed by numpydoc !!

.. py:function:: fast_chain_fixture(init_chain: agent0.core.hyperdrive.interactive.LocalChain) -> Iterator[agent0.core.hyperdrive.interactive.LocalChain]

   
   Local chain connected to a local database hosted in docker.
   This fixture uses snapshot on an existing chain in a function scope.

   .. note::
       This chain is booted from an existing snapshot for speed.
       If you save a new snapshot the first will be overwritten.

   :param init_chain: Session scoped chain fixture.
   :type init_chain: LocalChain

   :Yields: *LocalChain* -- Local chain instance.















   ..
       !! processed by numpydoc !!

.. py:function:: init_chain() -> Iterator[agent0.core.hyperdrive.interactive.LocalChain]

   
   Local chain connected to a local database hosted in docker.
   This fixture launches a chain from scratch in a session scope.

   :Yields: *LocalChain* -- local chain instance.















   ..
       !! processed by numpydoc !!

.. py:function:: fast_hyperdrive_fixture(init_hyperdrive: agent0.core.hyperdrive.interactive.LocalHyperdrive) -> Iterator[agent0.core.hyperdrive.interactive.LocalHyperdrive]

   
   Local hyperdrive pool test fixture.
   This fixture uses snapshot on an existing chain in a function scope.

   .. note::
       This pool is booted from an existing snapshot for speed.
       If you save a new snapshot the first will be overwritten.

   :param init_hyperdrive: Session scoped hyperdrive fixture.
   :type init_hyperdrive: LocalHyperdrive

   :Yields: *LocalHyperdrive* -- The deployed hyperdrive object.















   ..
       !! processed by numpydoc !!

.. py:function:: hyperdrive_fixture(chain_fixture: agent0.core.hyperdrive.interactive.LocalChain) -> agent0.core.hyperdrive.interactive.LocalHyperdrive

   
   Local hyperdrive pool test fixture.
   This fixture launches a chain from scratch in a function scope.

   :param chain_fixture: Function scoped chain fixture.
   :type chain_fixture: LocalChain

   :returns: The deployed hyperdrive object.
   :rtype: LocalHyperdrive















   ..
       !! processed by numpydoc !!

.. py:function:: init_hyperdrive() -> Iterator[agent0.core.hyperdrive.interactive.LocalHyperdrive]

   
   Local hyperdrive pool test fixture.
   This fixture launches a hyperdrive pool from scratch in a session scope.

   :Yields: *LocalHyperdrive* -- The deployed hyperdrive object.















   ..
       !! processed by numpydoc !!

.. py:function:: hyperdrive_read_interface_fixture(fast_hyperdrive_fixture: agent0.core.hyperdrive.interactive.LocalHyperdrive) -> agent0.ethpy.hyperdrive.interface.HyperdriveReadInterface

   
   Fixture representing a hyperdrive read interface to a deployed hyperdrive pool.

   :param fast_hyperdrive_fixture: Fixture representing the deployed hyperdrive pool.
   :type fast_hyperdrive_fixture: LocalHyperdrive

   :returns: The interface to access the deployed hyperdrive pool.
   :rtype: HyperdriveReadInterface















   ..
       !! processed by numpydoc !!

.. py:function:: hyperdrive_read_write_interface_fixture(fast_hyperdrive_fixture: agent0.core.hyperdrive.interactive.LocalHyperdrive) -> agent0.ethpy.hyperdrive.interface.HyperdriveReadWriteInterface

   
   Fixture representing a hyperdrive interface to a deployed hyperdrive pool.

   :param fast_hyperdrive_fixture: Fixture representing the deployed hyperdrive pool.
   :type fast_hyperdrive_fixture: LocalHyperdrive

   :returns: The interface to access and write to the deployed hyperdrive pool.
   :rtype: HyperdriveReadWriteInterface















   ..
       !! processed by numpydoc !!