agent0.ethpy.hyperdrive.state
=============================

.. py:module:: agent0.ethpy.hyperdrive.state

.. autoapi-nested-parse::

   
   Hyperdrive state classes and conversion helper functions.
















   ..
       !! processed by numpydoc !!


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/agent0/ethpy/hyperdrive/state/pool_state/index


Classes
-------

.. autoapisummary::

   agent0.ethpy.hyperdrive.state.PoolState


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

.. py:class:: PoolState

   
   A collection of stateful variables for deployed Hyperdrive and Yield contracts.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: block
      :type:  web3.types.BlockData


   .. py:attribute:: pool_config
      :type:  hyperdrivetypes.PoolConfigFP


   .. py:attribute:: pool_info
      :type:  hyperdrivetypes.PoolInfoFP


   .. py:attribute:: checkpoint_time
      :type:  int


   .. py:attribute:: checkpoint
      :type:  hyperdrivetypes.CheckpointFP


   .. py:attribute:: exposure
      :type:  fixedpointmath.FixedPoint


   .. py:attribute:: vault_shares
      :type:  fixedpointmath.FixedPoint


   .. py:attribute:: total_supply_withdrawal_shares
      :type:  fixedpointmath.FixedPoint


   .. py:attribute:: hyperdrive_base_balance
      :type:  fixedpointmath.FixedPoint


   .. py:attribute:: hyperdrive_eth_balance
      :type:  fixedpointmath.FixedPoint


   .. py:attribute:: gov_fees_accrued
      :type:  fixedpointmath.FixedPoint


   .. py:property:: pool_info_to_dict
      :type: dict[str, Any]


      
      Get the pool_info property.
















      ..
          !! processed by numpydoc !!


   .. py:property:: pool_config_to_dict
      :type: dict[str, Any]


      
      Get the pool_config property.
















      ..
          !! processed by numpydoc !!


   .. py:property:: checkpoint_to_dict
      :type: dict[str, Any]


      
      Get the checkpoint property.
















      ..
          !! processed by numpydoc !!