agent0.chainsync.dashboard.build_leaderboard
============================================

.. py:module:: agent0.chainsync.dashboard.build_leaderboard

.. autoapi-nested-parse::

   Builds the leaderboard for the dashboard.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   agent0.chainsync.dashboard.build_leaderboard.build_total_leaderboard
   agent0.chainsync.dashboard.build_leaderboard.build_per_pool_leaderboard


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

.. py:function:: build_total_leaderboard(position_snapshot: pandas.DataFrame, user_map: pandas.DataFrame) -> pandas.DataFrame

   
   Takes the position snapshot and aggregates pnl across all pools and positions,
   then ranks to show the leaderboard.

   :param position_snapshot: The dataframe resulting from get_position_snapshot that contains the latest positions.
   :type position_snapshot: pd.DataFrame
   :param user_map: A dataframe with 4 columns (address, abbr_address, username, format_name).
                    This is the output of :meth:`chainsync.dashboard.build_user_mapping`.
   :type user_map: pd.DataFrame

   :returns: The user-combined and individual wallet leaderboard dataframes.
   :rtype: tuple[pd.DataFrame, pd.DataFrame]















   ..
       !! processed by numpydoc !!

.. py:function:: build_per_pool_leaderboard(position_snapshot: pandas.DataFrame, user_map: pandas.DataFrame, hyperdrive_addr_map: pandas.DataFrame) -> pandas.DataFrame

   
   Takes the position snapshot and aggregates pnl across positions in individual pools,
   then ranks to show the leaderboard.

   :param position_snapshot: The dataframe resulting from get_position_snapshot that contains the latest positions.
   :type position_snapshot: pd.DataFrame
   :param user_map: A dataframe containing the wallet address to name mapping.
   :type user_map: pd.DataFrame
   :param hyperdrive_addr_map: A dataframe containing the hyperdrive address to name mapping.
   :type hyperdrive_addr_map: pd.DataFrame

   :returns: The user-combined and individual wallet leaderboard dataframes.
   :rtype: tuple[pd.DataFrame, pd.DataFrame]















   ..
       !! processed by numpydoc !!