agent0.core.base.agent
======================

.. py:module:: agent0.core.base.agent

.. autoapi-nested-parse::

   
   Base implementation of agents.
















   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/agent0/core/base/agent/eth_wallet/index
   /autoapi/agent0/core/base/agent/eth_wallet_test/index
   /autoapi/agent0/core/base/agent/market_actions/index


Classes
-------

.. autoapisummary::

   agent0.core.base.agent.EthWallet
   agent0.core.base.agent.BaseMarketAction


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

.. py:class:: EthWallet

   
   Stateful variable for storing what is in the agent's wallet.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: address
      :type:  hexbytes.HexBytes

      
      The associated agent's eth address.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: balance
      :type:  agent0.core.base.types.Quantity

      
      The base assets that held by the trader.
















      ..
          !! processed by numpydoc !!


   .. py:method:: copy() -> EthWallet

      
      Return a new copy of self.

      :returns: A deepcopy of the wallet.
      :rtype: EthWallet















      ..
          !! processed by numpydoc !!


   .. py:method:: check_valid_wallet_state(dictionary: dict | None = None) -> None

      
      Test that all wallet state variables are greater than zero.

      :param dictionary: The dictionary to check.
                         If not provided, it will use `self.__dict__`.
      :type dictionary: dict | None, optional















      ..
          !! processed by numpydoc !!


.. py:class:: BaseMarketAction

   Bases: :py:obj:`Generic`\ [\ :py:obj:`T`\ ]


   
   Market action specification
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: action_type
      :type:  T