Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CFG and DROP APY #281

Closed
armandomistral opened this issue Jul 19, 2021 · 1 comment · Fixed by #295
Closed

Add CFG and DROP APY #281

armandomistral opened this issue Jul 19, 2021 · 1 comment · Fixed by #295
Assignees

Comments

@armandomistral
Copy link

armandomistral commented Jul 19, 2021

#281

Background

We wanna show the CFG yield as well as the actual 30d DROP yields now.

How to derive CFG yields

Prerequisite is a price feed from UniSwap, technical ticket/specs to be drafted.
Based on the price of CFG in USD the yield can be approximated as:
$$
CFG yield = daily rewards rate * days per year * CFG token price
$$
with number of days = 365 and the token price in decimal format, e.g. 10 CFG per day per 10k investment --> 0.001
so e.g. assuming a token price of 0.7
$$
CFG yield = 0.001 * 365 * 0.7 = 0.2555 = 25.55 pc
$$
An example calculation for understanding the economics can be found here

How to show / Updates in IU

Dashboard

image
Figma

Update introduction paragraph

  • Expandable detail: The Tinlake protocol is rewarding every Tinlake investment daily in CFG token, the Centrifuge Chain’s native token. The Investment Reward Rate (APR)” is an annualized representation of these rewards considering the current CFG token market price taken from CoinGecko and current daily Tinlake protocol reward rate (see related governance discussions and decisions here). Note that these are rewards from the protocol for providing liquidity to the ecosystem independent from the pool, it’s issuers, their asset originators, or any Centrifuge entity. There is no guarantee that an investor will receive those rewards nor that the current annualized reward APR will be met. This is not investment advice — please see the Investment Disclaimer for more info.
  • Secondary link: Get started open in new window

(1) CFG Yield

  • The value should be calculated/updated on every page load
  • The calculated value of the CFG yield rate is shown on the Tinlake dashboard in the second summary card on top of the pools (note the changed card design)
  • Label Reward Rate (APR)

(2) DROP yields - 30d

  • In the pool list items, the DROP APR is replaced by the DROP APY (duration of 30 days).
  • The DROP APR is shown as a subline to the DROP APY

(3) TIN yields - 3m

Please don't show yet, but leave behind the feature flag as it currently is

(4) Tooltips

  • Tooltip on CFG yield in header
    • The annualized CFG reward rate for investments, based on the current CFG token market price and the daily reward rate
      Note that these are rewards from the protocol for providing liquidity to the ecosystem independent from the pool, it’s issuers, their asset originators, or any Centrifuge entity. There is no guarantee that an investor will receive those rewards nor that the current annualized reward APR will be met. This is not investment advice - please see the [Investment disclaimer](open investment disclaimer on click) for more info.`
  • Tooltip on 30d DROP Yield column header
    • The 30d DROP yield is the effective annualized return of the pool's DROP token over the last 30 days.
  • Tooltip onx.00 % APR in pool component
    • DROP tokens earn yield on the outstanding assets at the DROP APR. The effective APY may deviate due to compounding effects or unused liquidity in the pool reserve.

View: Pool Overview

(1) In header


Figma: DROP yield in summary of pool overview

  • Show 30d yields
  • show APR below
  • Update Tooltip
    • DROP tokens earn yield on the outstanding assets at the DROP APR. The effective annual yield may deviate due to compounding effects or unused liquidity in the pool reserve. The 30d DROP APY is the effective annualized return of the pool's DROP token over the last 30 days.

(2) In pool balance display

  • Replace APR by yield in DROP component
    • <value with one digit> % APY (30 days):

View: Investment component

  • Add DROP APY (30 days): <value>
  • Add Tooltip over DROP APR and yield:
    - DROP tokens earn yield on the outstanding assets at the DROP APR. The effective APY may deviate due to compounding effects or unused liquidity in the pool reserve. The 30d DROP APY is the effective annualized return of the pool's DROP token over the last 30 days.

Note, we will try to include yield calculations in the documentation. If we manage to do that before implementation, we'll add links to this in the tool tips.

Update investment disclaimer (Overlay)

Nothing contained in this website is to be construed as a solicitation or offer, or recommendation, to buy or sell any interest in any note or other security, or to engage in any other transaction, and the content herein does not constitute, and should not be considered to constitute, an offer of securities. No statement herein made constitutes an offer to sell or a solicitation of an offer to buy a note or other security. All information on this Web page is provided and maintained by the issuers of the respective Tinlake pools. The issuers have full responsibility. Please contact the respective issuer in case of any inquiries. Centrifuge and its affiliates are not liable nor responsible for the information provided hereby.

Before investing in any of the Tinlake pools, please check the issuer's offering materials and subscription documents including the Executive Summary to understand the terms, conditions, and investment risks of each pool. The issuer provides investment risk factors which are important to understand when you consider whether to invest in a pool. You alone assume the sole responsibility of evaluating the merits and risks associated with the use of any information or other content before making any decisions based on such information or other content.

The Tinlake protocol is rewarding every Tinlake investment daily in CFG token, the Centrifuge Chain’s native token. Note that these are rewards from the protocol for providing liquidity to the ecosystem independent from the pool, it’s issuers, their asset originators, or any Centrifuge entity. There is no guarantee that an investor will receive those rewards.

Addendum: DROP APY in upcoming pools and pools live less than 30 days

If a pool has not yet been live for more than 30 days, or is not live yet (i.e. upcoming), the value of DROP APY is not known. Until the DROP APY is known, the system shows the APR as a "good enough estimation", using the label Expected APR: <value of estimated APR> in the context where it applies (i.e. pool item on dashboard, pool overview, pool balance).

Pool list item (dashboard)
  • Label Expected APR

imageFigma

Pool overview

Summary:

  • Label: Expected DROP APR

image
Figma

Pool Balance:

  • Label Expected APR

image
Figma

Investment capacity

  • No APY
  • Expected DROP APR

image
Figma

@denniswell denniswell changed the title Tinlake dashboard: Add CFG yield rate Tinlake dashboard: Add CFG and DROP APY Jul 20, 2021
@denniswell denniswell changed the title Tinlake dashboard: Add CFG and DROP APY Add CFG and DROP APY Jul 20, 2021
@jpangelle jpangelle self-assigned this Jul 26, 2021
@armandomistral
Copy link
Author

armandomistral commented Aug 2, 2021

@jpangelle & @offerijns, I added a section called "Addendum: DROP APY in upcoming pools and pools live less than 30 days" to define how the UI should handle those two cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants