tachikoma000 / olympus_playground

Simulation environment for Olympus protocol

Olympus_Playground

Simulation environment for Olympus protocol

olympus_playground's Issues

Add Results Explanation Summaries for Profit Taking, DCA, and Reward Simulation metrics

Issue

Currently the results explanation only summarizes the data that relates to the "Ohm Growth and Simulation Controls." With the addition of the other control sections, each should have results summaries available to the user.

TotalSupply may be stagnant

Reported Bug Investigate
This may be an issue with data delay, or with V2 migration.

---

Define All Graph Metrics

Issue

In the Playgrounds Explorer not all metrics that are available are defined in the definitions section.

Acceptance Criteria

All available metrics are defined in the Metrics Definition section.

Give Explorer metrics user friendly names

Maybe take this list and map to a dictionary of more user friendly names, so that the items users choose aren't so "programmery".

currentAPY vs "Current APY"

Grammar and Wording Feedback from Users

Issue

The following feedback was received and should be addressed.

1. On the sidebar of the staking page the C in control of the phrase "OHM growth simulation Controls" should be lowercase.
2. On staking Learn page delete the comma after staking in the sentence "(3,3) Playground is a simulator for staking, and reward strategies"
3. Under the "Results Explanation" section of the Staking: Playground in the second sentence "profit" should not be capitalized same with "percentage"
4. Under the "Results Explanation" section of the Staking: Playground in the 3rd and 4th sentences "Min and MAX" should be min and max.
   Note: if you are treating "profit adjusted ROI" , "min growth rate" , and "max growth rate" as titles then that's okay but they need to all be in correct title case which they currently are not. to make them all correct title case the A in adjusted would need to be capitalized.
5. Consistency between using total value locked and total value deposited. Is called the latter explanation uses both. I would recommend just sticking to one or the other for easy of understanding.

Acceptance Criteria

All items above are reviewed and changed as suggested unless the change is deemed incorrect or undesirable.

Include Total Ohm Added in Results for DCA Calculations

Issue

Include in the results explanations the total amount of Ohm added via DCA for the time period.

Display Amount of Ohm Sold at Each Interval for the Profit Adjusted ROI Calculation

Issue

Include in the results explanation (or similar) the amount of Ohm withdrawn per interval based on the user's profit taking settings. Each interval and a total sold are both desirable metrics to relay to the user.

Better Explanation/Discovery for Graph Controls

Issue

We've had some feedback requesting already existing features such as hiding specific graph plots. We've determined the issue to be mainly discoverability. Auto-expanding or promoting the chart instructions out of the expander view may help to solve this fuzzy issue.

Ohm Totals Title Should Indicate Which Trend Line it Represents

Output verification for strategizer section

Some users are getting false output for the strategizer section of the app. The math looks correct, so I suspect some error propagation somewhere. Adding the issue here in case I am not able to attack it on time and someone wants to help check it out.

Constrain Available Filter By Dates

It looks like Playgrounds Explorer metrics can only retrieve data as far back as August 17th 2021. This may be a limitation of the data set. If so, we should constrain the start date entry of the date filter to this date or later. While we're at it we should also constrain the end date to be at max the current day's date.

There is a possibility that this is something that can be fixed with regarding the data set, but some constraint will still be valid even if we can grab more data.

More Readable Graph Metrics

The data in the hover pop up for the plotly graphs isn't very user friendly. See if this can be cleaned up.

Incorrect info in metrics definitions

I've since come to understand that this is incorrect. Ohm held by the DAO is not part of circulating supply. See below:

Remove Timestamp as a graphable metric in Explorer

This is not very useful and is probably only here because we interpret the list into names.
selected_metric = st.multiselect("",protocolMetrics_df.columns.tolist(),default=cols)

This could be removed more easily after/during #20

Add the Ability to Input a Concrete Amount of Ohm to Sell In Addition to Percentage

Issue

Allow the user to set either a sell percentage, or a specific number of Ohm to sell per interval.

Better Readability and Contrast for Variable Data in Text

Feedback Received

Consider changing the color of the data that updates with changing input for more intuitive connection between input and output. for example under the "Results Explanation" section of the Staking: Playground all text is white and input data is bold but still white. This subtle change can be hard to perceive (especially for people that are colorblind), thus why I recommend coloring this text.

---

Issue

Better contrast for variable data when it occurs in text would improve UX. It's hard to quickly parse changing data as adjustments are made. Try colors.

I would add to this ticket that the sentences could probably be further condensed to help with readability.
Example:

It would take 251.0 days until you accumulate enough OHMS worth $ 10000.0. Keep in mind that you are also predicting that the price of ohm will be $ 500.0 on this day.

Could instead become:

251.0 days until $10,000.0 with Ohm at a price of $500.00.

Simple Sentence Summary

Issue

Summarize Playground Staking results in a concise sentence below the graph.

"Based on simulation entered, you will have 64.997 ohm after 180 days. This also translates to $71,496 assuming OHM trades at $1,100"

Add Percentage Staked Metric in Explorer

The percentage of circulating Ohm that is staked is a useful and common metric and ew have what we need to add it as a metric I think.

Fine Grain Controls for Number of Days

Issue

In Ohm growth simulation controls, the number of days exists as a slider, and we had a feedback request for an input field. I think either an input field or arrow buttons that allow for fine grain tuning would be acceptable. Investigation needed on if this is possible with Streamlit.

Acceptance Criteria

Allow a user to have more accurate control of the number of days input in addition to the slider control.