agent0.core.hyperdrive.policies.deterministic
=============================================

.. py:module:: agent0.core.hyperdrive.policies.deterministic

.. autoapi-nested-parse::

   Deterministically trade things.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   agent0.core.hyperdrive.policies.deterministic.Deterministic


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

.. py:class:: Deterministic(policy_config: Config)

   Bases: :py:obj:`agent0.core.hyperdrive.policies.hyperdrive_policy.HyperdriveBasePolicy`


   
   Deterministic trading for testing and other purposes.
















   ..
       !! processed by numpydoc !!

   .. py:method:: description() -> str
      :classmethod:


      
      Describe the policy in a user friendly manner that allows newcomers to decide whether to use it.

      :returns: The description of the policy, as described above.
      :rtype: str















      ..
          !! processed by numpydoc !!


   .. py:class:: Config

      Bases: :py:obj:`agent0.core.hyperdrive.policies.hyperdrive_policy.HyperdriveBasePolicy.Config`


      
      Custom config arguments for this policy.
















      ..
          !! processed by numpydoc !!

      .. py:attribute:: trade_list
         :type:  list[tuple[str, int]]

         
         A list of tuples formatted as follows:
             - (<trade_type>, <amount>)
         Allowed trade types are "open_long", "close_long", "open_short", "close_short".
















         ..
             !! processed by numpydoc !!



   .. py:attribute:: starting_length


   .. py:method:: action(interface: agent0.ethpy.hyperdrive.HyperdriveReadInterface, wallet: agent0.core.hyperdrive.agent.HyperdriveWallet) -> tuple[list[agent0.core.base.Trade[agent0.core.hyperdrive.agent.HyperdriveMarketAction]], bool]

      
      Specify actions.

      :param interface: Interface for the market on which this agent will be executing trades (MarketActions).
      :type interface: HyperdriveReadInterface
      :param wallet: The agent's wallet.
      :type wallet: HyperdriveWallet

      :returns: A tuple where the first element is a list of actions,
                and the second element defines if the agent is done trading.
      :rtype: tuple[list[MarketAction], bool]















      ..
          !! processed by numpydoc !!