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

Docs Refactor #388

Merged
merged 46 commits into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
14b5b1a
update intro
MarcoWorms Dec 7, 2023
09b2890
update vaults information
MarcoWorms Dec 7, 2023
481ae97
vaults updates 2
MarcoWorms Dec 7, 2023
e22831d
update ycrv
MarcoWorms Dec 7, 2023
b6d7537
move woofy to r&d section
MarcoWorms Dec 7, 2023
2fb6b20
update broken erc20 link
MarcoWorms Dec 7, 2023
1d1602b
update ycrv lp info
MarcoWorms Dec 7, 2023
5f578a3
add veToken holdings
MarcoWorms Dec 8, 2023
dae1149
add info about zapping fees
MarcoWorms Dec 8, 2023
3513c82
update custom token guides
MarcoWorms Dec 8, 2023
a774aa4
fix ycrv factory pool link
MarcoWorms Dec 10, 2023
36baf60
add refactor files
MarcoWorms Feb 10, 2024
d435ac9
update titles
MarcoWorms Feb 10, 2024
bd6a31a
update titles
MarcoWorms Feb 10, 2024
6f5153b
update header
MarcoWorms Feb 10, 2024
997df3d
move v3 up
MarcoWorms Feb 10, 2024
a3ed51d
fix: yearn.vision info
0xBasically Feb 16, 2024
eb2e06d
fix: wording ycrv overview
0xBasically Feb 16, 2024
85eac2a
lowercase
0xBasically Feb 16, 2024
7b53fd0
delete extra word
0xBasically Feb 16, 2024
50f906c
add polygon network
0xBasically Feb 16, 2024
611fd61
fix: ycrv sidebar
0xBasically Feb 16, 2024
d1e3d8b
update ylockers headers
0xBasically Feb 16, 2024
06517af
refactor r & d to deprecated
0xBasically Feb 16, 2024
82f8fce
update yEarn
0xBasically Feb 16, 2024
9f24adf
update woofy page
0xBasically Feb 16, 2024
76da016
remove: llama pay info
0xBasically Feb 16, 2024
d256c52
refactor v3 sidebar
0xBasically Feb 16, 2024
46c3b0e
fix dead link
MarcoWorms Feb 19, 2024
850c424
fix dead link
MarcoWorms Feb 19, 2024
5e662ab
Update sidebarsContributing.js
MarcoWorms Feb 19, 2024
be4d8f2
Update sidebarsGettingStarted.js
MarcoWorms Feb 19, 2024
b277520
Update veyfi.md
MarcoWorms Feb 19, 2024
6433375
Update veyfi.md
MarcoWorms Feb 19, 2024
982bca1
Update sidebarsGettingStarted.js
MarcoWorms Feb 19, 2024
e076aa3
Create veyfi.md
MarcoWorms Feb 19, 2024
053eaa8
Update sidebarsGettingStarted.js
MarcoWorms Feb 19, 2024
b9b3218
Delete docs/contributing/governance/veyfi.md
MarcoWorms Feb 19, 2024
669b692
update homepage
MarcoWorms Feb 19, 2024
d7e6250
update footer
MarcoWorms Feb 19, 2024
e96d4d6
Update docusaurus.config.js
MarcoWorms Feb 19, 2024
76ec4a2
Update docusaurus.config.js
MarcoWorms Feb 19, 2024
2baf5ac
update snapshot link
MarcoWorms Feb 20, 2024
fb1283f
Update homepageFeatures.js
MarcoWorms Feb 20, 2024
06be169
update intro vaults link
MarcoWorms Feb 20, 2024
8946a02
Update yearn-data.md
MarcoWorms Feb 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/contributing/operations/budget.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@ The team recommendations to make requests are:
- When coordinating efforts with others, apply as a team (not as separate individuals)
- Shorter timeframes of 1 to 3 months may have better rates of approval

All Yearn payments streams can be visualized at our [LlamaPay Streams Dashboard](https://llamapay.io/streams?chainId=1&address=ychad.eth)

### [Send a budget request on GitHub](https://github.com/yearn/budget/issues/new/choose)
8 changes: 0 additions & 8 deletions docs/developers/v2/yearn-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,3 @@ yDaemon is a RESTful API that hydrates subgraph responses with more data, like A
- **Source:** https://github.com/yearn/ydaemon
- **Docs:** https://ydaemon.yearn.farm/
- **Guide:** https://medium.com/iearn/ydaemon-one-api-to-unify-all-yearn-data-4fc74dc9a33b

### yDaemon Data Sources

To build the yDaemon API, data is fetched from several Yearn data sources:
- [Yearn Subgraph](https://thegraph.com/explorer/subgraph?id=5xMSe3wTNLgFQqsAc5SCVVwT4MiRb5AogJCuSN9PjzXF) as the base data source.
- [Yearn Meta](https://github.com/yearn/yearn-meta) for some basic data and information updated by the Yearn team.
- [Yearn API](https://api.yearn.fi/) for the APY computation.
- [Yearn Lens Oracle](https://etherscan.io/address/0xca11bde05977b3631167028862be2a173976ca11) for tokens and vault prices.
Original file line number Diff line number Diff line change
@@ -1,49 +1,11 @@
# How to Add a Custom Token to MetaMask

Here's how you add a custom token to MetaMask.

## Visual Walkthrough

### Method One
1\) Click on the `Fox` icon to bring up the Metamask prompt.

![](https://i.imgur.com/R4K0STZ.png)

2\) Click on the etherscan icon (besides the `Fox` icon) to view token contract details.

3\) Confirm the token and click `Add Token`.

![](https://i.imgur.com/W0MsHOP.png)

### Method Two
1\) Open MetaMask and click `Assets` to see the tokens in your wallet.

![](https://i.imgur.com/N34iMar.png)

2\) Scroll down to the bottom and click `Add Token`.

![](https://i.imgur.com/hRd2MD7.png)

3\) Click `Custom Token`.

![](https://i.imgur.com/rGbV1eT.png)

4\) Paste the contract address for yUSD **0x5dbcF33D8c2E976c6b560249878e6F1491Bca25c** into the `Token Contract Address` field.

![](https://i.imgur.com/6H2JhRN.png)

5\) Click `Edit` to change the Token Symbol.

![](https://i.imgur.com/E12XN8x.png)

6\) Type in **yUSD** and click `Next`.

![](https://i.imgur.com/kNkrqj3.png)

7\) Hooray! Now you can see your balance of yUSD. Click `Add Tokens` to finish up.

![](https://i.imgur.com/gkt6KME.png)

8\) You're done. You'll now see yUSD in your assets list so it's easier to track and use.

![](https://i.imgur.com/ZgtftOw.png)
Follow the external guides provided by MetaMask:

- [Automatic token detection](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH48EA3JNK6V5JXCR6XVWZD)
- [Adding a token using the search bar](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH48R495MR9DQEDHJ89QNDA)
- [Adding a custom token](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH492CHY60HWPC28RW0872H)
- [Removing/hiding tokens](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH499MRDT5QC4R3KNPQNRWB)
- [Finding the token contract address](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWKCA7MJG5HT2MSZZ8DJ0QCF)
- [Adding a token using the block explorer](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01FWH752DWRBMH57M6DZRFSPQD)
- [Adding a token using a coin listing site](https://support.metamask.io/hc/en-us/articles/360015489031-How-to-display-tokens-in-MetaMask#h_01G13EJA2ZSJD1A743FVNCASNS)
5 changes: 5 additions & 0 deletions docs/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@ Yearn Finance is DeFi’s premier yield aggregator. Giving individuals, DAOs and

The protocol is maintained by various independent developers and is governed by YFI holders. You can find brief descriptions of Yearn's core products, the governance process, and links to active communication channels below.

- https://yearn.fi/

## Vaults

Yearn Vaults are capital pools that automatically generate yield based on opportunities present in the market. Vaults benefit users by socializing gas costs, automating the yield generation and rebalancing process, and automatically shifting capital as opportunities arise. End users also do not need to have proficient knowledge of the underlying protocols involved or DeFi, thus the Vaults represent a passive-investing strategy.

- Yearn Vaults V3: https://yearn.fi/v3
- Yearn Vaults V2: https://yearn.fi/vaults

## Governance

The Yearn ecosystem is controlled by YFI token holders who submit and vote on off-chain proposals that govern the ecosystem. Proposals that generate majority support \(>50% of the vote\) are implemented by a 9-member multi-signature wallet. Changes must be signed by 6 out of the 9 wallet signers to be implemented. The members of the multi-signature wallet were voted in by YFI holders and are subject to change from future governance votes. Please refer to the [multisig documentation](https://docs.yearn.fi/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](https://docs.yearn.fi/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# veYFI
# Overview

veYFI incorporates [YIP-56: Buyback and Build](https://gov.yearn.fi/t/yip-56-buyback-and-build/8929) funds into YFI tokenomics. Users can lock YFI tokens and receive veYFI, which allows them to boost vault rewards and vote on where bought-back YFI will be sent.

Expand All @@ -8,7 +8,7 @@ Contract Address: [`0x90c1f9220d90d3966fbee24045edd73e1d588ad5`](https://ethersc

Governance Forum Thread: https://gov.yearn.fi/t/yip-65-evolving-yfi-tokenomics

## Overview
## veYFI Overview

- Receives bought-back YFI as reward.
- Locking is similar to the ve-style program of Curve.
Expand Down Expand Up @@ -90,7 +90,7 @@ dYFI (previously specified as oYFI) is a token introduced as part of Yearn's veY

- Governance Forum Thread: https://gov.yearn.fi/t/yip-73-activate-veyfi-rewards-with-oyfi-gauges

### Overview
### dYFI Overview

- Implements the ERC-20 standard.
- Gives its bearer the right to redeem an equivalent YFI in exchange for ETH.
Expand Down
8 changes: 3 additions & 5 deletions docs/getting-started/products/ylockers/ycrv/faq.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# yCRV FAQ

## Launch and Migration
# Launch and Migration FAQ

### When will yCRV launch?
Contracts are live, you can find relevant addresses [here](https://docs.yearn.fi/getting-started/products/ycrv/overview#addresses).
Contracts are live, you can find relevant addresses [here](https://docs.yearn.fi/getting-started/products/ylockers/ycrv/overview#addresses).

### Should I migrate now from yveCRV and yvBOOST?
Yes! Incentives have moved to the new system. yveCRV and yvBOOST will no longer receive yield.
Expand All @@ -18,4 +16,4 @@ No. After the cut-over date, all incentives will move to the new yCRV system.
Nope! You can migrate anytime in the future. Contracts are trustless and migrations cannot be stopped.

### How are Curve DAO governance votes handled in this system?
The Yearn [governance multisig](https://etherscan.io/address/0xfeb4acf3df3cdea7399794d0869ef76a6efaff52) will retain the sole ability to cast votes in the Curve DAO. They will do so with close consultation with the [Crypto Risk Team](https://twitter.com/cryptorisksteam) and other Curve DAO stakeholders to ensure risk is properly assessed and all votes promote the long-term interests of the Curve DAO. While it is possible that the yCRV system can be upgraded to someday grant these voting rights to yCRV token holders (only if enforcing a sufficiently long lock time), there is no current plan to do so.
The Yearn [governance multisig](https://etherscan.io/address/0xfeb4acf3df3cdea7399794d0869ef76a6efaff52) will retain the sole ability to cast votes in the Curve DAO. They will do so with close consultation with the [Crypto Risk Team](https://twitter.com/cryptorisksteam) and other Curve DAO stakeholders to ensure risk is properly assessed and all votes promote the long-term interests of the Curve DAO. While it is possible that the yCRV system can be upgraded to someday grant these voting rights to yCRV token holders (only if enforcing a sufficiently long lock time), there is no current plan to do so.
14 changes: 7 additions & 7 deletions docs/getting-started/products/ylockers/ycrv/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# yCRV
# Overview

![](https://i.imgur.com/ni42qE6.png)

Expand All @@ -18,14 +18,14 @@ _or_

- Migrate from legacy tokens [yveCRV and yvBOOST](#how-yvecrv-and-veboost-functionality-was-migrated-to-ycrv).

Both operations mint yCRV to the user at a 1:1 rate. Users migrating from yvBOOST can use the zap at [y.finance](https://y.finance) to efficiently unwrap their tokens to yveCRV and migrates to yCRV in a single step. Of course, users can also choose to purchase yCRV from the new Curve factory pool [here](https://curve.fi/factory/192).
Both operations mint yCRV to the user at a 1:1 rate. Users migrating from yvBOOST can use the zap at https://yearn.fi/ycrv to efficiently unwrap their tokens to yveCRV and migrate to yCRV in a single step. Of course, users can also choose to purchase yCRV from the new Curve factory pool: https://curve.fi/#/ethereum/pools/factory-v2-280/deposit

### 'Activated'-tokens

Yearn passes all benefits of its veCRV position on to yCRV users who hold one of its **activated-tokens:**

- [**st-yCRV (Staking Rewards):**](#staked-ycrv) [yVault](https://medium.com/iearn/yearn-finance-explained-what-are-vaults-and-strategies-96970560432) that receives admin fees and bribes from locked CRV.
- [**lp-yCRV (Liquidity Pool Rewards):**](#lpd-ycrvcrv) yVault for CRV/yCRV LP tokens, autocompounds emissions and fees.
- [**lp-yCRV (Liquidity Pool Rewards):**](#lpd-ycrvcrv) yVault for CRV LP tokens, autocompounds emissions and fees.

> Note: a third activated token, vl-yCRV, was planned but not rolled out due to a lack of demand.

Expand All @@ -46,27 +46,27 @@ Under the hood, st-yCRV is a Yearn v2 vault, allowing users to sit back, relax a

![](https://i.imgur.com/3JNhzWR.png)

Liquidity Pool'd yCRV provides liquidity to the new CRV/yCRV pool on Curve, and lp-yCRV holders receive this LP fees and emissions. When you zap to this token, under the hood, you are entering an LP position in the yCRV/CRV pool and depositing the LP tokens into the lp-yCRV yVault.
Liquidity Pool'd yCRV provides liquidity to the new CRV pool on Curve, and lp-yCRV holders receive this LP fees and emissions. When you zap to this token, under the hood, you are entering an LP position in the yCRV/CRV pool and depositing the LP tokens into the lp-yCRV yVault.

This is also a Yearn v2 vault with a strategy that deposits all CRV emissions generated back into the pool to grow the position. Like st-yCRV this is designed to be a set and forget token that auto harvests and auto compound rewards.

Yearn will mark 1 veCRV worth of voting power for every 1 yCRV in this position to vote in favor of yCRV Curve gauge - increasing CRV emissions to users.

## How yveCRV and yvBOOST functionality was migrated to yCRV

yveCRV and yvBOOST are being deprecated, and there is a migration path available to users. The functionality of both was integrated into [st-yCRV](#staked-ycrv) so if you are looking for the same benefits check the [guide](https://docs.yearn.fi/getting-started/products/ycrv/guide) on how to migrate from the legacy tokens using yearn's UI
yveCRV and yvBOOST are being deprecated, and there is a migration path available to users. The functionality of both was integrated into [st-yCRV](#staked-ycrv) so if you are looking for the same benefits check the [guide](https://docs.yearn.fi/getting-started/products/ylockers/ycrv/guide) on how to migrate from the legacy tokens using yearn's UI

![](https://i.imgur.com/Htl3AgP.png)

## Addresses

- **yCRV:** [0xFCc5c47bE19d06BF83eB04298b026F81069ff65b](https://etherscan.io/token/0xFCc5c47bE19d06BF83eB04298b026F81069ff65b)
- **st-yCRV (vault):** [0x27B5739e22ad9033bcBf192059122d163b60349D](https://etherscan.io/token/0x27B5739e22ad9033bcBf192059122d163b60349D)
- **lp-yCRV (DEPRECATED):** [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/token/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e)
- **lp-yCRV (DEPRECATED, The v2 pool is more efficient and has a price oracle):** [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/token/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e)
- **lp-yCRV v2 (vault):** [0x6E9455D109202b426169F0d8f01A3332DAE160f3](https://etherscan.io/token/0x6E9455D109202b426169F0d8f01A3332DAE160f3)
- **CRV/yCRV Curve Pool:** [0x453D92C7d4263201C69aACfaf589Ed14202d83a4](https://etherscan.io/token/0x453D92C7d4263201C69aACfaf589Ed14202d83a4)
- **ZapYCRV.vy :** [0x01D7f32B6E463c96c00575fA97B8224326C6A6B9](https://etherscan.io/token/0x01D7f32B6E463c96c00575fA97B8224326C6A6B9)
- **yCRV Interface:** http://y.finance/
- **yCRV Interface:** https://yearn.fi/ycrv

## Read More

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/products/ylockers/yprisma/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# yPRISMA
# Overview

Claim and deposit at [yprisma.yearn.fi](https://yprisma.yearn.fi)

Expand Down
4 changes: 3 additions & 1 deletion docs/getting-started/products/yvaults/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ The old structure used before the changes brought by [YIP-69](https://gov.yearn.
| Management Fee | 0% |
| Performance Fee | 20% |

On the [yearn.fi](https://yearn.fi/) user interface, yield is displayed as net APY. This means that both fees and compounding returns are taken into consideration in the rates presented. Since harvests don't occur on a set basis, yield is estimated based on historical data. For more information, see [How to Understand yVault ROI](https://docs.yearn.fi/getting-started/guides/how-to-understand-yvault-roi)
On the [yearn.fi](https://yearn.fi/) user interface, yield is displayed as net APY. This means that both fees and compounding returns are taken into consideration in the rates presented. Since harvests don't occur on a set basis, yield is usually estimated based on historical data. For more information, see [How to Understand yVault ROI](https://docs.yearn.fi/getting-started/guides/how-to-understand-yvault-roi)

- For vaults deployed by the vault [factory](https://docs.yearn.fi/getting-started/products/yvaults/vault-factory) the performance fee is 10% instead of 20%.

## v2 yVault Improvements

Expand Down
7 changes: 4 additions & 3 deletions docs/getting-started/products/yvaults/v3.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Vaults Version 3
# Overview

Version 3 yVaults iterates on Version 2 by increasing robustness and developing Yearn’s path towards further decentralization, while keeping the same proven product (yield-bearing tokens) that abstract builders and users from the hard work of yield farming. Version 3 will both be able to have the same functionality as Version 2, but with many more added benefits and improvements to continue to grow the Yearn ecosystem.

V3 also sees the introduction of "Tokenized Strategies". In V3 the strategies are now capable of being standalone 4626 vaults themselves. These single-strategy vaults can be used as stand-alone vaults or as a function of the 4626 standard easily added as a strategy to any of the multi-strategy "Allocator Vaults".
Expand Down Expand Up @@ -37,10 +38,10 @@ Periphery Modules are a separate layer of optional contracts to use with vaults

[Tokenized Strategy Specification](https://github.com/yearn/tokenized-strategy/blob/master/SPECIFICATION.md)

**For More information visit the [V3 section](https://docs.yearn.fi/developers/v3/overview) of the docs.**
# Read More

**For more information visit the V3 developer section: https://docs.yearn.fi/developers/v3/overview**

# Read More
- https://github.com/yearn/yearn-vaults-v3
- https://github.com/yearn/tokenized-strategy
- https://medium.com/iearn/yearnv3-motivation-and-design-107840cb4844
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/products/yvaults/vault-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Follow these steps to create a new vault with the UI:

<img src="https://i.imgur.com/l7Z7oYm.png" />

4. Sign the transaction and the vault will be created
4. Sign the transaction and the vault will be created (the signing interface is specific to your wallet provider, this one is [Frame](https://frame.sh/))

<img src="https://i.imgur.com/uRhX2VB.png" width="280" />

Expand Down
Loading
Loading