Display external incentive APR #886

srph · 2022-10-06T21:06:22Z

This is for the pool gauges in the pool page (/pool/[id]):

For Stride, we'd like to display the sum of external and internal incentives.

This is how it looks like with the mentioned changes:

Relevant changes I've introduced are in packages/web/pages/pool/[id].tsx. In addition, I thought not every pool might like this change, so I've thought of putting this configuration behind a flag.

I'd like to kindly ask for some pointers on how to implement this properly. Apparently, I've hard-coded some values (like dividing the values by 1m); and I'm not very familiar with Keplr's Dec and RatePretty as well.

If there are variables or files I should take note of - that would be helpful.

I'll mark this as a draft PR once I have more idea on how to implement this properly

…dd-incentives

vercel · 2022-10-06T21:06:26Z

@srph is attempting to deploy a commit to the OsmoLabs Team on Vercel.

A member of the Team first needs to authorize it.

vercel · 2022-10-07T13:47:29Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
osmosis-frontend	✅ Ready (Inspect)	Visit Preview	Oct 20, 2022 at 9:34PM (UTC)
osmosis-frontier	✅ Ready (Inspect)	Visit Preview	Oct 20, 2022 at 9:34PM (UTC)

jonator · 2022-10-07T13:51:05Z

I'd def appreciate it if you could implement this, as my plate has been quite full as of recently.

I've started work on calculating external incentive here:

osmosis-frontend/packages/stores/src/queries/pool-incentives/incentivized-pools.ts

Line 258 in 23ecb4e

readonly computeExternalIncentiveGaugeApr = computedFn(

You could continue my work there. I'd like for it to be a callable function that we could then use anywhere.

srph · 2022-10-11T08:27:57Z

Hey @jonator thanks for advice. I have 2 questions:

Are we expecting this to replace the current APRs in the PoolGaugeCards?
Is computeExternalIncentiveGaugeApr complete? If so, are there any specific variables we had in mind that should be passed to it?

srph · 2022-10-11T15:47:41Z

I have another question:

So, we have a variable called allowedGauges which is an array that displays the "external incentives" (in our case STRD) which is this:

Which we'll use to add to the APRs:

What I did was pretty simple - add allowedGauges[0].rewardAmount to each APR gauge (1/7/14).

What about when there are more than allowedGauges?

…end into srph/add-incentives

srph · 2022-10-12T21:54:41Z

@jonator Hey, thanks for the discussion earlier!

I've updated the PR based on the direction I understood we were taking. It's likely I missed something - let me know if there's anything to change or improve.

Here's how the UI looks now for pool 803:

srph · 2022-10-12T21:58:37Z

packages/stores/src/queries/pool-incentives/incentivized-pools.ts

+      }
+
+      const amount = externalGauge.rewardAmount.moveDecimalPointLeft(
+        mintCurrency.coinDecimals


Diving the value by 1_000_000 gives me the value I expect, but I figured hard-coding doesn't make sense. So I took this from computeAPYForDuration. Let me know I should be getting this value elsewhere.

jonator · 2022-10-12T22:49:08Z

for pool 803, I believe the 1 day and 7 day gauges should be 0% since there's no incentives for those gauges.

The only gauge I expect to see an APR for external incentives is the 14 day gauge.

packages/web/config/feature-flag.ts

jonator · 2022-10-12T22:52:30Z

packages/stores/src/queries/pool-incentives/incentivized-pools.ts

@@ -118,6 +118,52 @@ export class ObservableQueryIncentivizedPools extends ObservableChainQuery<Incen
    }
  );

+  readonly computeAPYWithExternalIncentives = computedFn(


As Aidan and I agreed in the meeting, IMO we should calculate APR for a duration for external gauges separately from internal gauges.

Then, we add them in the view layer.

This way, we would be able to separately display the APR for just external gauges of a certain duration.

Then, we add them in the view layer.

@jonator Hmm, I'm not sure I'm able to follow. Can you help me recall this bit?

Are we looking to add another gauge UI below the internal incentives?

Are we looking to do add something similar to superfluidApr? Like 0.2% + 18% + 5%?

Or instead do we simply want to refactor so we're calling this new function in the pool page like so:

queryOsmosis.queryIncentivizedPools.computeAPY(...).add( queryOsmosis.queryIncentivizedPools.computeExternalIncentiveForDuration(...) )

Yeah we can use that code snippet for our current needs, but we'd also have those bullet points available as an option.

Reminder: we're currently redesigning the pool detail page in a major way, so flexibility in our APIs is extra critical.

I know for a fact we will be displaying external incentive APRs in a different way.

srph · 2022-10-13T19:30:21Z

@jonator Thanks for the notes. I've updated the PR again based on what I understood. Let me know if we're headed in the right direction or if there's anything else to improve.

JeremyParish69 · 2022-10-13T21:13:45Z

This is exciting!
Due top the temporal nature of external incentives, I'd hope that the numbers aren't simply just added together, but rather that each gauge gets it's own APR figures. Might be confusing to advertise just a 200% APR when the 190% APR external incentive gauge will end after just one more epoch. A way to show internal and external separately would be better for users.

srph · 2022-10-13T21:35:26Z

@JeremyParish69 Yea, I think that should be the effect when this PR is merged. This is the effect at least for pool 803:

Before	After

Given that it only has one external incentive:

I could update it to do something similar to superfluid pools and show something like 0.2% + 18% if we think that's a better option (haha a bit unsure which is preferable).

jonator

@srph It appears there's build errors in [id].tsx

srph · 2022-10-17T19:11:51Z

@jonator Should be fixed now; I verified it by running yarn build:frontier. Let me know if there's anything I may have missed.

jonator · 2022-10-19T15:11:58Z

What was the rationale for how you calculated the APR? Seems like a clever approach.

srph · 2022-10-19T20:14:29Z

@jonator I don't think I have a solid rationale about it. Last time I tried without notes, (existing APR from computeApy) + (rewardAmount / 1_000_000) gave me the value we expected.

I figured 1_000_000 came from coinDecimals, and closest I found where I could get it was mintCurrency (I took references from computeAPYForSpecificDuration).

Also to be honest, I'm not too familiar with CoinPretty/RatePretty in practice. If there's a better way to do this, let me know!

jonator · 2022-10-19T21:11:07Z

https://github.com/chainapsis/keplr-wallet/blob/b4560027b8a955e092a2ff14e34281ad1812370a/packages/stores/src/query/cosmos/supply/inflation.ts#L176

This is the code Keplr uses to compute stake APR. May be a helpful reference. I know it helped my fix an issue with calculating swap fee APR.

srph · 2022-10-20T18:44:06Z

@jonator I consulted with the folks at Stride and used computeApy as reference. How does this look @jonator?

packages/stores/src/queries/pool-incentives/incentivized-pools.ts

packages/web/pages/pool/[id].tsx

srph · 2022-10-20T19:15:40Z

@jonator Oops, good catch. Should be fixed now.

I left the formula as comment for the time being - I think it makes sense to have it there. Should I remove it as well?

…o srph/add-incentives

jonator

LGTM

srph added 2 commits October 7, 2022 04:18

Update

79019de

Merge branch 'master' of github.com:srph/osmosis-frontend into srph/a…

9f4bc0c

…dd-incentives

srph requested a review from JeremyParish69 as a code owner October 6, 2022 21:06

jonator linked an issue Oct 7, 2022 that may be closed by this pull request

Display external incentive APRs for whitelisted gauges #839

Closed

vercel bot deployed to Preview – osmosis-frontend October 7, 2022 13:51 View deployment

srph added 5 commits October 13, 2022 04:11

Update

360e31e

Merge branch 'srph/add-incentives-2' of github.com:srph/osmosis-front…

db0eadc

…end into srph/add-incentives

Remove comments

f6f11ff

Remove buggy condition

cfe646e

Move condition up

804844b

srph commented Oct 12, 2022

View reviewed changes

jonator requested changes Oct 12, 2022

View reviewed changes

Remove configs

23ba112

vercel bot deployed to Preview – osmosis-frontier October 13, 2022 18:03 View deployment

Refactor external incentive calculation function

1585fb5

srph requested review from jonator and removed request for JeremyParish69 October 13, 2022 21:59

jonator requested changes Oct 17, 2022

View reviewed changes

Fix types

9161754

srph requested a review from jonator October 17, 2022 19:27

vercel bot deployed to Preview – osmosis-frontier October 19, 2022 15:14 View deployment

srph added 2 commits October 21, 2022 02:15

Update calculation

7cc5634

Rename vars

0e258b3

jonator requested changes Oct 20, 2022

View reviewed changes

packages/stores/src/queries/pool-incentives/incentivized-pools.ts Outdated Show resolved Hide resolved

packages/web/pages/pool/[id].tsx Outdated Show resolved Hide resolved

Remove comments

89dabd4

srph requested a review from jonator October 20, 2022 19:15

Merge branch 'master' of github.com:osmosis-labs/osmosis-frontend int…

56b4f6b

…o srph/add-incentives

jonator approved these changes Oct 20, 2022

View reviewed changes

vercel bot deployed to Preview – osmosis-frontier October 20, 2022 21:34 View deployment

jonator changed the title ~~Pool Gauge: Display sum of external & internal incentives~~ Display external incentive APR Oct 21, 2022

jonator merged commit 726fc68 into osmosis-labs:master Oct 21, 2022

srph mentioned this pull request Oct 21, 2022

Add up all external incentive APYs for a specific duration #916

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display external incentive APR #886

Display external incentive APR #886

srph commented Oct 6, 2022

vercel bot commented Oct 6, 2022

vercel bot commented Oct 7, 2022 •

edited

Loading

jonator commented Oct 7, 2022

srph commented Oct 11, 2022

srph commented Oct 11, 2022

srph commented Oct 12, 2022 •

edited

Loading

srph Oct 12, 2022

jonator commented Oct 12, 2022

jonator Oct 12, 2022

jonator Oct 12, 2022

srph Oct 13, 2022 •

edited

Loading

jonator Oct 13, 2022

jonator Oct 13, 2022

srph commented Oct 13, 2022

JeremyParish69 commented Oct 13, 2022

srph commented Oct 13, 2022 •

edited

Loading

jonator left a comment •

edited

Loading

srph commented Oct 17, 2022

jonator commented Oct 19, 2022

srph commented Oct 19, 2022 •

edited

Loading

jonator commented Oct 19, 2022 •

edited

Loading

srph commented Oct 20, 2022 •

edited

Loading

srph commented Oct 20, 2022 •

edited

Loading

jonator left a comment

Display external incentive APR #886

Display external incentive APR #886

Conversation

srph commented Oct 6, 2022

vercel bot commented Oct 6, 2022

vercel bot commented Oct 7, 2022 • edited Loading

jonator commented Oct 7, 2022

srph commented Oct 11, 2022

srph commented Oct 11, 2022

srph commented Oct 12, 2022 • edited Loading

srph Oct 12, 2022

Choose a reason for hiding this comment

jonator commented Oct 12, 2022

jonator Oct 12, 2022

Choose a reason for hiding this comment

jonator Oct 12, 2022

Choose a reason for hiding this comment

srph Oct 13, 2022 • edited Loading

Choose a reason for hiding this comment

jonator Oct 13, 2022

Choose a reason for hiding this comment

jonator Oct 13, 2022

Choose a reason for hiding this comment

srph commented Oct 13, 2022

JeremyParish69 commented Oct 13, 2022

srph commented Oct 13, 2022 • edited Loading

jonator left a comment • edited Loading

Choose a reason for hiding this comment

srph commented Oct 17, 2022

jonator commented Oct 19, 2022

srph commented Oct 19, 2022 • edited Loading

jonator commented Oct 19, 2022 • edited Loading

srph commented Oct 20, 2022 • edited Loading

srph commented Oct 20, 2022 • edited Loading

jonator left a comment

Choose a reason for hiding this comment

vercel bot commented Oct 7, 2022 •

edited

Loading

srph commented Oct 12, 2022 •

edited

Loading

srph Oct 13, 2022 •

edited

Loading

srph commented Oct 13, 2022 •

edited

Loading

jonator left a comment •

edited

Loading

srph commented Oct 19, 2022 •

edited

Loading

jonator commented Oct 19, 2022 •

edited

Loading

srph commented Oct 20, 2022 •

edited

Loading

srph commented Oct 20, 2022 •

edited

Loading