agent0.ethpy.hyperdrive.addresses
=================================

.. py:module:: agent0.ethpy.hyperdrive.addresses

.. autoapi-nested-parse::

   Helper class for storing Hyperdrive addresses

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   agent0.ethpy.hyperdrive.addresses.get_hyperdrive_registry_from_artifacts
   agent0.ethpy.hyperdrive.addresses.get_hyperdrive_addresses_from_registry
   agent0.ethpy.hyperdrive.addresses.get_hyperdrive_name


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

.. py:function:: get_hyperdrive_registry_from_artifacts(artifacts_uri: str) -> str

   
   Fetch addresses for deployed contracts in the Hyperdrive system.

   :param artifacts_uri: The URI for the artifacts endpoint.
   :type artifacts_uri: str

   :returns: A dictionary that mirrors the artifacts json structure.
   :rtype: dict[str, ChecksumAddress]















   ..
       !! processed by numpydoc !!

.. py:function:: get_hyperdrive_addresses_from_registry(hyperdrive_registry_addr: str, web3: web3.Web3) -> dict[str, eth_typing.ChecksumAddress]

   
   Fetch addresses for deployed contracts in the Hyperdrive system.

   :param hyperdrive_registry_addr: The address of the Hyperdrive registry contract.
   :type hyperdrive_registry_addr: str
   :param web3: The instantiated Web3 instance that's connect to a chain to use.
   :type web3: Web3

   :returns: A dictionary keyed by the pool name (e.g., `StETHHyperdrive_14day`)
             with a value of the address of the deployed hyperdrive pool.
   :rtype: dict[str, ChecksumAddress]















   ..
       !! processed by numpydoc !!

.. py:function:: get_hyperdrive_name(hyperdrive_address: eth_typing.ChecksumAddress, web3: web3.Web3) -> str

   
   Generates a name for a given hyperdrive address. The address generated is of the form
   <vault_shares_token_symbol>_<position_duration>_day.

   :param hyperdrive_address: The address of a hyperdrive pool.
   :type hyperdrive_address: ChecksumAddress
   :param web3: The instantiated Web3 instance that's connect to a chain to use.
   :type web3: Web3

   :returns: The generated name of the hyperdrive pool.
   :rtype: str















   ..
       !! processed by numpydoc !!