codecov[bot]
commented
2 months ago Codecov Report
Attention: Patch coverage is 87.60234% with 106 lines in your changes are missing coverage. Please review.
Project coverage is 83.54%. Comparing base (
9950db3) to head (dc79d09).:exclamation: Current head dc79d09 differs from pull request most recent head fbf0dda
Please upload reports for the commit fbf0dda to get more accurate results.
Additional details and impacted files
```diff @@ Coverage Diff @@ ## main #1467 +/- ## ========================================== + Coverage 82.28% 83.54% +1.26% ========================================== Files 90 87 -3 Lines 6019 5623 -396 ========================================== - Hits 4953 4698 -255 + Misses 1066 925 -141 ``` | [Flag](https://app.codecov.io/gh/delvtech/agent0/pull/1467/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=delvtech) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/delvtech/agent0/pull/1467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=delvtech) | `83.54% <87.60%> (+1.26%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=delvtech#carryforward-flags-in-the-pull-request-comment) to find out more.:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
dpaiton
This PR is the second in a collection of refactors to allow agent0 to support multiple pools.
This PR focuses on updates to the database and related systems. In particular, this makes the following major changes to the database.
Database schema updates
hyperdrive_addressfield.HyperdriveAddrToNamemaps the hyperdrive address to a logical name. The name defaults to<vault_share_token_symbol>_<position_duration_in_days>_day.WalletDeltaandHyperdriveTransactionstables have been removed in favor of the new events table added in https://github.com/delvtech/agent0/pull/1464.PositionSnapshottable calculates the absolute positions from the deltas stored in theTradeEventtables. This table also stores any additional information useful for analysis, such as realized and unrealized values of positions, and the pnl.CurrentWallet,Ticker, andWalletPNLtables have been removed in favor of a newPositionSnapshottable.PoolAnalysistable has been removed in favor of putting the fields in thePoolInfotable.UsernameToUsertable has been removed, no need to map multiple wallets to a single user.Analysis from remote chains
The database container is now managed by the
Chainobject as opposed toLocalChain. Likewise, database sessions is now managed by theChainobject as opposed toLocalHyperdrive. These changes allow the remote chain object to have access to the database for gathering events, positions, and pnl from hyperdrive pools.The simulated environment uses the full set of tables in the database, whereas the remote chain environment uses a subset of these tables. Both workflows uses the same underlying schema, but the remote workflow updates these tables lazily, i.e., only query and insert events and snapshots into the db when the user calls the functions that need them. Additionally, the remote workflow only updates the tables with any agents initialized by agent0. In contrast, the simulated environment updates these tables with all agents that have interacted with the simulated pool, and the database is updated on every trade to these pools.
Interactive analysis interface
The interactive interface for getting information from the db has been reworked. Note that some pool analysis functions are only available in
LocalHyperdrivemethod, due to lazy event querying on remote chains.Wallet objects and Positions
agent.get_wallet()has replacedagent.get_positions()(which replacedagent.walletin https://github.com/delvtech/agent0/pull/1464). This function returns aHyperdriveWalletobject that contains the relevant positions (i.e., base, longs, shorts, lp, withdrawal shares) for a specific pool. A future PR will allow this function to take a pool as an argument, or require setting the agent's active pool. This function queries the database for current positions.agent.get_positions()now returns a dataframe consisting of all open positions across all pools held by the agent, with additional pnl, unrealized, and realized value columns. An optional argumentshow_closed_positions, if set to True, will also return all closed positions and the position's realized value.hyperdrive.get_positions()returns a dataframe consisting of all positions across thehyperdrivepool. This function is only available inLocalHyperdrive.agent.get_trade_events()returns a dataframe of events emitted from the agent across all pools that the agent interacted with. An optional argumentall_token_deltas, if set to True, will repeat anyRemoveLiquidityevents with a non-zero withdrawal shares, where the additional row tracks the withdrawal share token delta.hyperdrive.get_trade_events()returns a dataframe of events emitted from the pool across all agents. This function is only available inLocalHyperdrive.Historical positions
We also expose a couple of helper functions for getting positions over time. These are exclusive to
LocalHyperdrive, due to the underlying table (i.e.,PositionSnapshot) only being guaranteed to keep historical data for the simulated environment.hyperdrive.get_historical_positions()returns a dataframe with the history of positions over time. This function is only available inLocalHyperdrive.hyperdrive.get_historical_pnl()returns a dataframe of historical positions, aggregated across all positions to find the total pnl. This function is only available inLocalHyperdrive.Streamlit dashboard
run_dashboardcommand is now a function of theLocalChain.