agent0.ethpy.hyperdrive.transactions
====================================

.. py:module:: agent0.ethpy.hyperdrive.transactions

.. autoapi-nested-parse::

   Helper functions for interfacing with hyperdrive.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   agent0.ethpy.hyperdrive.transactions.get_hyperdrive_pool_config
   agent0.ethpy.hyperdrive.transactions.get_hyperdrive_pool_info
   agent0.ethpy.hyperdrive.transactions.get_hyperdrive_checkpoint
   agent0.ethpy.hyperdrive.transactions.get_hyperdrive_checkpoint_exposure


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

.. py:function:: get_hyperdrive_pool_config(hyperdrive_contract: hyperdrivetypes.types.IHyperdriveContract) -> hyperdrivetypes.fixedpoint_types.PoolConfigFP

   
   Get the hyperdrive config from a deployed hyperdrive contract.

   :param hyperdrive_contract: The deployed hyperdrive contract instance.
   :type hyperdrive_contract: Contract

   :returns: The hyperdrive pool config.
   :rtype: dict[str, Any]















   ..
       !! processed by numpydoc !!

.. py:function:: get_hyperdrive_pool_info(hyperdrive_contract: hyperdrivetypes.types.IHyperdriveContract, block_identifier: web3.types.BlockIdentifier) -> hyperdrivetypes.fixedpoint_types.PoolInfoFP

   
   Get the block pool info from the Hyperdrive contract.

   :param hyperdrive_contract: The contract to query the pool info from.
   :type hyperdrive_contract: Contract
   :param block_identifier: The block identifier to query from the chain.
   :type block_identifier: BlockIdentifier

   :returns: A dictionary containing the Hyperdrive pool info returned from the smart contract.
   :rtype: dict[str, Any]















   ..
       !! processed by numpydoc !!

.. py:function:: get_hyperdrive_checkpoint(hyperdrive_contract: hyperdrivetypes.types.IHyperdriveContract, checkpoint_time: web3.types.Timestamp, block_identifier: web3.types.BlockIdentifier) -> hyperdrivetypes.fixedpoint_types.CheckpointFP

   
   Get the checkpoint info for the Hyperdrive contract at a given block.

   :param hyperdrive_contract: The contract to query the pool info from.
   :type hyperdrive_contract: IHyperdriveContract
   :param checkpoint_time: The block timestamp that indexes the checkpoint to get.
   :type checkpoint_time: Timestamp
   :param block_identifier: The block number to query from the chain.
   :type block_identifier: BlockIdentifier

   :returns: The dataclass containing the checkpoint info in fixed point
   :rtype: CheckpointFP















   ..
       !! processed by numpydoc !!

.. py:function:: get_hyperdrive_checkpoint_exposure(hyperdrive_contract: hyperdrivetypes.types.IHyperdriveContract, checkpoint_time: web3.types.Timestamp, block_identifier: web3.types.BlockIdentifier) -> fixedpointmath.FixedPoint

   
   Get the checkpoint exposure for the Hyperdrive contract at a given block.

   :param hyperdrive_contract: The contract to query the pool info from.
   :type hyperdrive_contract: IHyperdriveContract
   :param checkpoint_time: The block timestamp that indexes the checkpoint to get.
                           This must be an exact checkpoint time for the deployed pool.
   :type checkpoint_time: Timestamp
   :param block_identifier: The block number to query from the chain.
   :type block_identifier: BlockIdentifier

   :returns: The dataclass containing the checkpoint info in fixed point.
   :rtype: CheckpointFP















   ..
       !! processed by numpydoc !!