From 14b5b1a24aece689f7c888a45f521ac67765b6bc Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:28:11 +0100 Subject: [PATCH 01/46] update intro --- docs/getting-started/intro.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/getting-started/intro.md b/docs/getting-started/intro.md index 35406b98c..6febd80fa 100644 --- a/docs/getting-started/intro.md +++ b/docs/getting-started/intro.md @@ -4,10 +4,14 @@ 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. +- 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). From 09b28906f9c648be3fd8e172a87ee912424f35ed Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:28:58 +0100 Subject: [PATCH 02/46] update vaults information --- .../products/yvaults/overview.md | 4 +- .../products/yvaults/vault-tokens.md | 59 +++++-------------- .../products/yvaults/vaults-and-strategies.md | 12 ---- docs/getting-started/using-yearn.md | 10 ++-- sidebars/sidebarsGettingStarted.js | 1 - 5 files changed, 23 insertions(+), 63 deletions(-) delete mode 100644 docs/getting-started/products/yvaults/vaults-and-strategies.md diff --git a/docs/getting-started/products/yvaults/overview.md b/docs/getting-started/products/yvaults/overview.md index 5df8f1d6b..edbe13360 100644 --- a/docs/getting-started/products/yvaults/overview.md +++ b/docs/getting-started/products/yvaults/overview.md @@ -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 diff --git a/docs/getting-started/products/yvaults/vault-tokens.md b/docs/getting-started/products/yvaults/vault-tokens.md index 401819bcc..f95a5df01 100644 --- a/docs/getting-started/products/yvaults/vault-tokens.md +++ b/docs/getting-started/products/yvaults/vault-tokens.md @@ -4,57 +4,28 @@ **For example**, if you deposit YFI in a yVault you will receive yvYFI in return. yvYFI would be the yVault Token. -If your yVault generates profit, the share price of your yVault tokens will increase. This happens because there are more underlying tokens in the yVault to redeem upon withdrawal. +If your yVault generates profit, the share price of your yVault tokens will increase. This happens because more underlying tokens are in the yVault to redeem upon withdrawal. ![](https://i.imgur.com/3zkSnoE.png) ![](https://i.imgur.com/yrGEVCr.png) -_The yvYFI token at [Etherscan](https://etherscan.io/token/0xE14d13d8B3b85aF791b2AADD661cDBd5E6097Db1#readContract), showing its name, total assets and price per share._ - Once a user's liquidity is withdrawn from the yVault, their yVault Token will be burned. yVault Tokens are [ERC20](https://docs.ethhub.io/built-on-ethereum/erc-token-standards/erc20/), meaning they can be transferred and traded as any other common Ethereum token. +The vault tokens have evolved between v1, v2, and v3, here are a couple of main differences between them: + +## V1 yVault Tokens + +- Each vault contract can use only 1 yield strategy contract. +- Vault tokens are prefixed with a leading `y`, so a v1 vault for USDC gives the user yUSDC. + ## V2 yVault Tokens -| Vault | Input Token | Output Token | -| :--- | :--- | :--- | -| YFI | [YFI](https://etherscan.io/token/0x0bc529c00c6401aef6d220be8c6ea1667f6ad93e) | [yvYFI](https://etherscan.io/token/0xE14d13d8B3b85aF791b2AADD661cDBd5E6097Db1) | -| 1INCH | [1INCH](https://etherscan.io/token/0x111111111117dc0aa78b770fa6a738034120c302) | [yv1INCH](https://etherscan.io/token/0xB8C3B7A2A618C552C23B1E4701109a9E756Bab67) | -| WETH | [WETH](https://etherscan.io/token/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2) | [yvWETH](https://etherscan.io/token/0xa258C4606Ca8206D8aA700cE2143D7db854D168c) | -| USDC | [USDC](https://etherscan.io/token/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48) | [yvUSDC](https://etherscan.io/token/0x5f18c75abdae578b483e5f43f12a39cf75b973a9) | -| HEGIC | [HEGIC](https://etherscan.io/token/0x584bC13c7D411c00c01A62e8019472dE68768430) | [HEGIC](https://etherscan.io/token/0x584bC13c7D411c00c01A62e8019472dE68768430) | -| DAI | [DAI](https://etherscan.io/token/0x6b175474e89094c44da98b954eedeac495271d0f) | [yvDAI](https://etherscan.io/token/0xdA816459F1AB5631232FE5e97a05BBBb94970c95) | -| WBTC | [WBTC](https://etherscan.io/token/0x2260fac5e5542a773aa44fbcfedf7c193bc2c599) | [WBTC yVault](https://etherscan.io/token/0xcb550a6d4c8e3517a939bc79d0c7093eb7cf56b5) | -| USDT | [USDT](https://etherscan.io/token/0xdac17f958d2ee523a2206206994597c13d831ec7) | [yvUDST](https://etherscan.io/token/0x7Da96a3891Add058AdA2E826306D812C638D87a7) | -| crvIB | [Curve Iron Bank Pool](https://etherscan.io/token/0x5282a4ef67d9c33135340fb3289cc1711c13638c) | [yCurve-IronBank](https://etherscan.io/token/0x27b7b1ad7288079A66d12350c828D3C00A6F07d7) | -| crvSETH | [Curve sETH Pool](https://etherscan.io/token/0xa3d87fffce63b53e0d54faa1cc983b7eb0b74a9c) | [yvCurve-sETH](https://etherscan.io/token/0x986b4AFF588a109c09B50A03f42E4110E29D353F) | -| crvstETH | [Curve stETH Pool](https://etherscan.io/token/0x06325440d014e39736583c165c2963ba99faf14e) | [yvCurve-stETH](https://etherscan.io/token/0xdcd90c7f6324cfa40d7169ef80b12031770b4325) | -| crvSBTC | [Curve sBTC Pool](https://etherscan.io/token/0x075b1bb99792c9e1041ba13afef80c91a1e70fb3) | [yvCurve-sBTC](https://etherscan.io/token/0x8414Db07a7F743dEbaFb402070AB01a4E0d2E45e) | -| crvRENBTC | [Curve renBTC Pool](https://etherscan.io/token/0x49849c98ae39fff122806c06791fa73784fb3675) | [yvCurve-renBTC](https://etherscan.io/token/0x7047F90229a057C13BF847C0744D646CFb6c9E1A) | -| crvOBTC | [Curve oBTC Pool](https://etherscan.io/token/0x2fe94ea3d5d4a175184081439753de15aef9d614) | [yvCurve-oBTC](https://etherscan.io/token/0xe9Dc63083c464d6EDcCFf23444fF3CFc6886f6FB) | -| crvPBTC | [Curve pBTC Pool](https://etherscan.io/token/0xde5331ac4b3630f94853ff322b66407e0d6331e8) | [yvCurve-pBTC](https://etherscan.io/token/0x3c5DF3077BcF800640B5DAE8c91106575a4826E6) | -| crvTBTC | [Curve tBTC Pool](https://etherscan.io/token/0x64eda51d3Ad40D56b9dFc5554E06F94e1Dd786Fd) | [yvCurve-tBTC](https://etherscan.io/token/0x23D3D0f1c697247d5e0a9efB37d8b0ED0C464f7f) | -| crvFRAX | [Curve FRAX Pool](https://etherscan.io/token/0xd632f22692fac7611d2aa1c0d552930d43caed3b) | [yvCurve-FRAX](https://etherscan.io/token/0xB4AdA607B9d6b2c9Ee07A275e9616B84AC560139) | -| crvLUSD | [Curve LUSD Pool](https://etherscan.io/token/0xed279fdd11ca84beef15af5d39bb4d4bee23f0ca) | [yvCurve-LUSD](https://etherscan.io/token/0x5fA5B62c8AF877CB37031e0a3B2f34A78e3C56A6) | -| crvSAAVE | [Curve sAave Pool](https://etherscan.io/token/0x02d341ccb60faaf662bc0554d13778015d1b285c) | [yvCurve-sAave](https://etherscan.io/token/0xb4D1Be44BfF40ad6e506edf43156577a3f8672eC) | -| crvBBTC | [Curve BBTC Pool](https://etherscan.io/token/0x410e3e86ef427e30b9235497143881f717d93c2a) | [yvCurve-BBTC](https://etherscan.io/token/0x8fA3A9ecd9EFb07A8CE90A6eb014CF3c0E3B32Ef) | -| yvBOOST | [Yearn Compounding veCRV](https://etherscan.io/token/0xc5bddf9843308380375a611c18b50fb9341f502a) | [yvBOOST](https://etherscan.io/token/0x9d409a0A012CFbA9B15F6D4B36Ac57A46966Ab9a) | +- Each vault contract can use up to 20 yield strategy contracts. +- Vault tokens are prefixed with `yv`, so so a v2 vault for USDC gives the user yvUSDC. -## V1 yVault Tokens +## V3 yVault Tokens -| Vault | Input Token | Output Token | -| :----------- | :------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- | -| crvLINK | [linkCRV](https://etherscan.io/token/0xcee60cfa923170e4f8204ae08b4fa6a3f5656f3a) | [yvlinkCRV](https://etherscan.io/token/0x96Ea6AF74Af09522fCB4c28C269C26F59a31ced6) | -| crvUSDP | [usdp3CRV](https://etherscan.io/token/0x7Eb40E450b9655f4B3cC4259BCC731c63ff55ae6) | [yvusdp3CRV](https://etherscan.io/token/0x1B5eb1173D2Bf770e50F10410C9a96F7a8eB6e75) | -| crvANKR | [ankrCRV](https://etherscan.io/token/0xaA17A236F2bAdc98DDc0Cf999AbB47D47Fc0A6Cf) | [yvankrCRV](https://etherscan.io/token/0xE625F5923303f1CE7A43ACFEFd11fd12f30DbcA4) | -| yCRV\(yUSD\) | [yDAI+yUSDC+yUSDT+yTUSD](https://etherscan.io/token/0xdF5e0e81Dff6FAF3A7e52BA697820c5e32D806A8) | [yyDAI+yUSDC+yUSDT+yTUSD](https://etherscan.io/token/0x5dbcf33d8c2e976c6b560249878e6f1491bca25c) | -| crvMUSD | [musd3CRV](https://etherscan.io/token/0x1AEf73d49Dedc4b1778d0706583995958Dc862e6) | [yvmusd3CRV](https://etherscan.io/token/0x0FCDAeDFb8A7DfDa2e9838564c5A1665d856AFDF) | -| crvGUSD | [gusd3CRV](https://etherscan.io/token/0xD2967f45c4f384DEEa880F807Be904762a3DeA07) | [yvgusd3CRV](https://etherscan.io/token/0xcC7E70A958917cCe67B4B87a8C30E6297451aE98) | -| crvDUSD | [dusd3CRV](https://etherscan.io/token/0x3a664Ab939FD8482048609f652f9a0B0677337B9) | [yvdusd3CRV](https://etherscan.io/address/0x8e6741b456a074F0Bc45B8b82A755d4aF7E965dF#code) | -| crvUSDN | [usdn3CRV](https://etherscan.io/token/0x4f3E8F405CF5aFC05D68142F3783bDfE13811522) | [yvusdn3CRV](https://etherscan.io/token/0xFe39Ce91437C76178665D64d7a2694B0f6f17fE3) | -| crvUSDT | [ust3CRV](https://etherscan.io/token/0x94e131324b6054c0D789b190b2dAC504e4361b53) | [yvusdt3CRV](https://etherscan.io/token/0xF6C9E9AF314982A4b38366f4AbfAa00595C5A6fC) | -| crvHUSD | [husd3CRV](https://etherscan.io/token/0x5B5CFE992AdAC0C9D48E05854B2d91C73a003858) | [yvhusd3CRV](https://etherscan.io/token/0x39546945695DCb1c037C836925B355262f551f55) | -| crvBUSD | [yDAI+yUSDC+yUSDT+yBUSD \(bCrv\)](https://etherscan.io/token/0x3B3Ac5386837Dc563660FB6a0937DFAa5924333B) | [yyDAI+yUSDC+yUSDT+yBUSD](https://etherscan.io/token/0x2994529C0652D127b7842094103715ec5299bBed) | -| crvSUSD | [crvPlain3andSUSD \(sCrv\)](https://etherscan.io/token/0xC25a3A3b969415c80451098fa907EC722572917F) | [yvcrvPlain3andSUSD](https://etherscan.io/token/0x5533ed0a3b83F70c3c4a1f69Ef5546D3D4713E44) | -| 3Crv | [3Crv](https://etherscan.io/token/0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490) | [y3Crv](https://etherscan.io/token/0x9cA85572E6A3EbF24dEDd195623F188735A5179f) | -| crvEURS | [eursCRV](https://etherscan.io/token/0x194eBd173F6cDacE046C53eACcE9B953F28411d1) | [yveursCRV](https://etherscan.io/token/0x98B058b2CBacF5E99bC7012DF757ea7CFEbd35BC) | -| crvHBTC | [hCRV](https://etherscan.io/token/0xb19059ebb43466C323583928285a49f558E572Fd) | [yvhCRV](https://etherscan.io/token/0x46AFc2dfBd1ea0c0760CAD8262A5838e803A37e5) | +- The strategy contract is [ERC-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) compliant (we call this "Tokenized Strategy"). +- A strategy can act as a vault with only 1 strategy. +- A strategy can act as a vault for many strategies. +- Vault tokens are still prefixed with `yv`, so so a v3 vault for USDC gives the user yvUSDC. \ No newline at end of file diff --git a/docs/getting-started/products/yvaults/vaults-and-strategies.md b/docs/getting-started/products/yvaults/vaults-and-strategies.md deleted file mode 100644 index 628f10408..000000000 --- a/docs/getting-started/products/yvaults/vaults-and-strategies.md +++ /dev/null @@ -1,12 +0,0 @@ -# Vaults and Strategies - -After depositing, your funds first go to the vault contract and then are deployed to one or more strategy contracts. Guardians and strategists monitor deposits to ensure optimal returns and to be available during critical situations. - -**Vault and Strategies Introduction:** [What are Vaults and Strategies?](https://medium.com/iearn/yearn-finance-explained-what-are-vaults-and-strategies-96970560432) - -**Vault and Strategies Contracts:** [Yearn Watch](https://yearn.watch/) - - -**Vault and Strategies Descriptions:** [The Vaults at Yearn](https://vaults.yearn.fi/) - -**Strategy Descriptions Glossary:** [How to Understand Strategies Descriptions](https://docs.yearn.fi/getting-started/guides/how-to-understand-strategies-descriptions) diff --git a/docs/getting-started/using-yearn.md b/docs/getting-started/using-yearn.md index 6b5810169..4103042ec 100644 --- a/docs/getting-started/using-yearn.md +++ b/docs/getting-started/using-yearn.md @@ -1,16 +1,16 @@ # Using Yearn -Thanks to a feature called 'zap', it's extremely easy to deposit into any vault with almost any token. +Thanks to a feature called 'zap', depositing into any vault with almost any token is effortless. Here's how it works: -First, **Connect your wallet** using the button at the top right corner. Multiple types of wallets are supported, but most people use [MetaMask](https://metamask.io/), which can be downloaded for free as a Chrome extension or through the Apple and Android app stores. Make sure that your wallet is connected to the Ethereum network. +First, **Connect your wallet** using the button at the top right corner. Multiple wallets are supported, but most people use [MetaMask](https://metamask.io/), which can be downloaded for free as a Chrome extension or through the Apple and Android app stores. Make sure that your wallet is connected to the Ethereum network. ![image](https://github.com/yearn/yearn-devdocs/assets/7863230/3b537d18-bbfe-449a-8d6d-d6b53c44e056) ## Yearn is multi-chain -Our products are currently on Ethereum, Fantom, Arbitrum, and Optimism with more to come. +Our products are currently on Ethereum, Fantom, Arbitrum, and Optimism, with more to come. Click on this button to select the network you would like to interact with: @@ -19,7 +19,7 @@ Click on this button to select the network you would like to interact with: ## If you **already have the required token** for the vault that you would like to deposit in: 1. Select the vault that you would like to deposit into. -2. Enter the amount of tokens you want to deposit into the vault. If you are depositing ETH, make sure you have enough ETH left over to pay for future transactions that you might need to make. +2. Enter the amount of tokens you want to deposit into the vault. If you are depositing ETH, ensure you have enough ETH left over to pay for future transactions you might need to make. ![image](https://github.com/yearn/yearn-devdocs/assets/7863230/b829c7f3-078c-4674-be24-3763443a4299) @@ -30,7 +30,7 @@ Click on this button to select the network you would like to interact with:

-6. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list. +5. When your transaction succeeds, you will see your deposited balance in the vault's interface, which should appear at the top of the vault list. ![image](https://github.com/yearn/yearn-devdocs/assets/7863230/5b2c2308-0384-4446-ab12-2fc23d8cc829) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index c6729156f..bc0e2046c 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -11,7 +11,6 @@ module.exports = { label: 'yVaults', items: [ 'products/yvaults/overview', - 'products/yvaults/vaults-and-strategies', 'products/yvaults/vault-tokens', 'products/yvaults/vault-factory', 'products/yvaults/v3', From 481ae97e485c328fb18b85ed629119e5eeb11bb8 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:41:47 +0100 Subject: [PATCH 03/46] vaults updates 2 --- docs/getting-started/products/yvaults/v3.md | 1 - docs/getting-started/products/yvaults/vault-factory.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/getting-started/products/yvaults/v3.md b/docs/getting-started/products/yvaults/v3.md index 68d399315..0c8b7d80f 100644 --- a/docs/getting-started/products/yvaults/v3.md +++ b/docs/getting-started/products/yvaults/v3.md @@ -39,7 +39,6 @@ Periphery Modules are a separate layer of optional contracts to use with vaults **For More information visit the [V3 section](https://docs.yearn.fi/developers/v3/overview) of the docs.** - # Read More - https://github.com/yearn/yearn-vaults-v3 - https://github.com/yearn/tokenized-strategy diff --git a/docs/getting-started/products/yvaults/vault-factory.md b/docs/getting-started/products/yvaults/vault-factory.md index 8f5106152..deabc6189 100644 --- a/docs/getting-started/products/yvaults/vault-factory.md +++ b/docs/getting-started/products/yvaults/vault-factory.md @@ -145,7 +145,7 @@ Follow these steps to create a new vault with the UI: -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/)) From e22831df6328dbc316ade4a3c450890b3579a4f5 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:42:05 +0100 Subject: [PATCH 04/46] update ycrv --- docs/getting-started/products/ylockers/ycrv/faq.md | 4 +--- docs/getting-started/products/ylockers/ycrv/overview.md | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/products/ylockers/ycrv/faq.md b/docs/getting-started/products/ylockers/ycrv/faq.md index 00ef9b499..744d0dde8 100644 --- a/docs/getting-started/products/ylockers/ycrv/faq.md +++ b/docs/getting-started/products/ylockers/ycrv/faq.md @@ -1,6 +1,4 @@ -# 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). diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index db836c680..c378d4336 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -18,7 +18,7 @@ _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 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). ### 'Activated'-tokens @@ -66,7 +66,7 @@ yveCRV and yvBOOST are being deprecated, and there is a migration path available - **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 From b6d753722e4dfbc52051da710bd335644e689ffa Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:42:53 +0100 Subject: [PATCH 05/46] move woofy to r&d section --- docs/{getting-started/products => resources/r-and-d}/woofy.md | 0 sidebars/sidebarsGettingStarted.js | 1 - 2 files changed, 1 deletion(-) rename docs/{getting-started/products => resources/r-and-d}/woofy.md (100%) diff --git a/docs/getting-started/products/woofy.md b/docs/resources/r-and-d/woofy.md similarity index 100% rename from docs/getting-started/products/woofy.md rename to docs/resources/r-and-d/woofy.md diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index bc0e2046c..1c00c4a31 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -45,7 +45,6 @@ module.exports = { 'products/ybribe/faq', ], }, - 'products/woofy', ], }, { From 2fb6b201cae1d22e1f158914e8f6352456c4b6ab Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 14:45:43 +0100 Subject: [PATCH 06/46] update broken erc20 link --- docs/getting-started/products/yvaults/vault-tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/products/yvaults/vault-tokens.md b/docs/getting-started/products/yvaults/vault-tokens.md index f95a5df01..2aa93e30f 100644 --- a/docs/getting-started/products/yvaults/vault-tokens.md +++ b/docs/getting-started/products/yvaults/vault-tokens.md @@ -9,7 +9,7 @@ If your yVault generates profit, the share price of your yVault tokens will incr ![](https://i.imgur.com/3zkSnoE.png) ![](https://i.imgur.com/yrGEVCr.png) -Once a user's liquidity is withdrawn from the yVault, their yVault Token will be burned. yVault Tokens are [ERC20](https://docs.ethhub.io/built-on-ethereum/erc-token-standards/erc20/), meaning they can be transferred and traded as any other common Ethereum token. +Once a user's liquidity is withdrawn from the yVault, their yVault Token will be burned. yVault Tokens are [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/), meaning they can be transferred and traded as any other common Ethereum token. The vault tokens have evolved between v1, v2, and v3, here are a couple of main differences between them: From 1d1602b5d63eca35dcb3cf0d37df807191e55c12 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Thu, 7 Dec 2023 15:26:09 +0100 Subject: [PATCH 07/46] update ycrv lp info --- docs/getting-started/products/ylockers/ycrv/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index c378d4336..cb13245ff 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -62,7 +62,7 @@ yveCRV and yvBOOST are being deprecated, and there is a migration path available - **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) From 5f578a3be9b962fd0e0d1106455f6703a4267cf7 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 8 Dec 2023 12:26:57 +0100 Subject: [PATCH 08/46] add veToken holdings --- docs/getting-started/guides/how-boost-works.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/getting-started/guides/how-boost-works.md b/docs/getting-started/guides/how-boost-works.md index 076e2204b..b74f7ff85 100644 --- a/docs/getting-started/guides/how-boost-works.md +++ b/docs/getting-started/guides/how-boost-works.md @@ -108,6 +108,11 @@ Both of these Yearn vaults reward CRV stakers with a share of the CRV locked by Yearn’s work to automate the yield generation and rebalancing of your crypto assets is especially true in the case of your CRV holdings, and Yearn’s yveCRV or yvBOOST offers a powerful, compounding, “set-and-forget” place to stake your CRV! +## Yearn veTokens Holdings + +- veYFI: https://yearn.vision/?orgId=1&refresh=5m&viewPanel=53 +- veCRV: https://yearn.vision/d/Qu4WGIwnz/vecrv?orgId=1 + ## More information - [curve.fi](https://www.curve.fi/) webpage From dae1149a54dc41c5b569ae14db56749e5db0eb58 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 8 Dec 2023 12:28:58 +0100 Subject: [PATCH 09/46] add info about zapping fees --- docs/getting-started/using-yearn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/using-yearn.md b/docs/getting-started/using-yearn.md index 4103042ec..f959ea377 100644 --- a/docs/getting-started/using-yearn.md +++ b/docs/getting-started/using-yearn.md @@ -47,7 +47,7 @@ When you're ready to withdraw: ## If you **don't have the required token** for the vault that you would like to deposit in: -Yearn provides a zapping feature so you can deposit with any token into any vault: +Yearn provides a zapping feature so you can deposit any token into any vault (zapping fees are explicit in the UI): ![image](https://github.com/yearn/yearn-devdocs/assets/7863230/63cb991c-71de-4840-8bf2-38084e7ab907) From 3513c826e99102362ab4bf57582aa138a523d813 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 8 Dec 2023 12:34:33 +0100 Subject: [PATCH 10/46] update custom token guides --- .../how-to-add-a-custom-token-to-metamask.md | 56 +++---------------- 1 file changed, 9 insertions(+), 47 deletions(-) diff --git a/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md b/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md index c058c6d21..eec207507 100644 --- a/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md +++ b/docs/getting-started/guides/how-to-add-a-custom-token-to-metamask.md @@ -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) \ No newline at end of file From a774aa440c49f59fe08ba2f121857a7603979b26 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Sun, 10 Dec 2023 20:21:58 +0100 Subject: [PATCH 11/46] fix ycrv factory pool link --- docs/getting-started/products/ylockers/ycrv/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index cb13245ff..37b4c3fa7 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -18,7 +18,7 @@ _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 https://yearn.fi/ycrv 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 migrates 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 From 36baf6083a77d33addbc6095f48cdefbcf99c824 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 9 Feb 2024 22:05:37 -0300 Subject: [PATCH 12/46] add refactor files --- .../developers/v2}/yearn-api.md | 0 .../developers/v2}/yearn-lens.md | 0 .../products/yvaults/vault-tokens.md | 2 +- sidebars/sidebarsContributing.js | 4 - sidebars/sidebarsDevelopers.js | 78 ++++++----- sidebars/sidebarsGettingStarted.js | 16 ++- .../version-0.4.6/yearn-sdk/yearn-stack.md | 125 ------------------ 7 files changed, 61 insertions(+), 164 deletions(-) rename {versioned_docs/version-0.4.6 => docs/developers/v2}/yearn-api.md (100%) rename {versioned_docs/version-0.4.6/yearn-lens => docs/developers/v2}/yearn-lens.md (100%) delete mode 100644 versioned_docs/version-0.4.6/yearn-sdk/yearn-stack.md diff --git a/versioned_docs/version-0.4.6/yearn-api.md b/docs/developers/v2/yearn-api.md similarity index 100% rename from versioned_docs/version-0.4.6/yearn-api.md rename to docs/developers/v2/yearn-api.md diff --git a/versioned_docs/version-0.4.6/yearn-lens/yearn-lens.md b/docs/developers/v2/yearn-lens.md similarity index 100% rename from versioned_docs/version-0.4.6/yearn-lens/yearn-lens.md rename to docs/developers/v2/yearn-lens.md diff --git a/docs/getting-started/products/yvaults/vault-tokens.md b/docs/getting-started/products/yvaults/vault-tokens.md index 2aa93e30f..8819fdfd8 100644 --- a/docs/getting-started/products/yvaults/vault-tokens.md +++ b/docs/getting-started/products/yvaults/vault-tokens.md @@ -11,7 +11,7 @@ If your yVault generates profit, the share price of your yVault tokens will incr Once a user's liquidity is withdrawn from the yVault, their yVault Token will be burned. yVault Tokens are [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/), meaning they can be transferred and traded as any other common Ethereum token. -The vault tokens have evolved between v1, v2, and v3, here are a couple of main differences between them: +The vault tokens have evolved between v1, v2, and v3, here are a couple of main differences: ## V1 yVault Tokens diff --git a/sidebars/sidebarsContributing.js b/sidebars/sidebarsContributing.js index f9809ef59..fee7273bf 100644 --- a/sidebars/sidebarsContributing.js +++ b/sidebars/sidebarsContributing.js @@ -6,8 +6,6 @@ module.exports = { type: 'category', label: 'Operations', items: [ - 'operations/osc-levels', - 'operations/decision-making', 'operations/budget', ], }, @@ -15,9 +13,7 @@ module.exports = { type: 'category', label: 'Governance', items: [ - 'governance/governance-and-operations', 'governance/proposal-process', - 'governance/proposal-repository', 'governance/yfi', 'governance/veyfi', ], diff --git a/sidebars/sidebarsDevelopers.js b/sidebars/sidebarsDevelopers.js index a4a58242e..913237c93 100644 --- a/sidebars/sidebarsDevelopers.js +++ b/sidebars/sidebarsDevelopers.js @@ -1,45 +1,59 @@ module.exports = { mySidebar: [ - 'v2/getting-started', - 'v2/additional-resources', { type: 'category', - label: 'Procedures', + label: 'yVaults Version 3', items: [ - 'v2/SPECIFICATION', - 'v2/DEPLOYMENT', - 'v2/OPERATIONS', - 'v2/EMERGENCY', - 'v2/naming-convention', - 'v2/ledger-plugin', - ], - }, - { - type: 'link', - label: 'Smart Contracts', - href: '/vaults/smart-contracts/BaseStrategy', - }, - { - type: 'category', - label: 'Yearn Data Services', - items: [ - 'v2/yearn-data', - 'v2/subgraph-info', - 'v2/entities', - 'v2/queries', + 'v3/overview', + 'v3/strategy_writing_guide', + 'v3/protocol_fees', + 'v3/vault_management', ], }, - 'v2/hacking-with-yearn', - 'v2/fork-yearn-ui', - 'v2/yswaps', { type: 'category', - label: 'V3', + label: 'yVaults Version 2', items: [ - 'v3/overview', - 'v3/strategy_writing_guide', - 'v3/protocol_fees', - 'v3/vault_management', + 'v2/getting-started', + 'v2/additional-resources', + { + type: 'category', + label: 'Procedures', + items: [ + 'v2/SPECIFICATION', + 'v2/DEPLOYMENT', + 'v2/OPERATIONS', + 'v2/EMERGENCY', + 'v2/naming-convention', + 'v2/ledger-plugin', + ], + }, + { + type: 'link', + label: 'Smart Contracts', + href: '/vaults/smart-contracts/BaseStrategy', + }, + { + type: 'category', + label: 'Yearn Data Services', + items: [ + 'v2/yearn-data', + { + type: 'category', + label: 'Subgraph', + items: [ + 'v2/subgraph-info', + 'v2/entities', + 'v2/queries', + ], + }, + 'v2/yearn-lens', + 'v2/yearn-api', + ], + }, + 'v2/hacking-with-yearn', + 'v2/fork-yearn-ui', + 'v2/yswaps', ], }, ], diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index 1c00c4a31..2eb68e786 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -12,8 +12,20 @@ module.exports = { items: [ 'products/yvaults/overview', 'products/yvaults/vault-tokens', - 'products/yvaults/vault-factory', - 'products/yvaults/v3', + { + type: 'category', + label: 'yVaults Version 2', + items: [ + 'products/yvaults/vault-factory', + ], + }, + { + type: 'category', + label: 'yVaults Version 3', + items: [ + 'products/yvaults/v3', + ], + }, ], }, { diff --git a/versioned_docs/version-0.4.6/yearn-sdk/yearn-stack.md b/versioned_docs/version-0.4.6/yearn-sdk/yearn-stack.md deleted file mode 100644 index b64fc676a..000000000 --- a/versioned_docs/version-0.4.6/yearn-sdk/yearn-stack.md +++ /dev/null @@ -1,125 +0,0 @@ -# Yearn Stack + FE Features - -Yearn SDK integrates several components, both on-chain and off-chain. - -## Backend stack - -

- Backend Chart -

- -### On Chain - -- 🔍 Yearn Lens - - Oracle - - Helpers - - Adapters - - Vaults V1 - - Vaults V2 - - Iron Bank - -### On IPFS - -

- IPFS Metadata -

- -- Yearn Metadata is a lightweight storage for all the stuff that would have been hardcoded in v2 frontend, including but not limited to: - - custom messages for deposits / withdrawals - - custom copywriting for special assets - - strategy descriptions / diagrams - - disabling asset interactions -- Yearn Frontend - -### Off Chain - -- Yearn Exporter: stores (and displays) stats about yearn assets, exposing: - - historical TVL - - historical APY -- Yearn Subgraph: stores all historical data for users -- Zapper Integration - -## Backend features - -### Resilience powered by on-chain data and IPFS storage - -- Critical data (assets, positions, vault deprecations) will be fetched exclusively from the chain / IPFS - - maximizing uptime - - reducing reliance on other services -- Historical TVL, historical APY and other non critical data will be stored off chain and fetched dinamically. - -#### On-chain assets and positions - -- Lens does what the old off-chain API does, but directly on-chain. This will speed up the fetching time and greatly reduce our reliance on scheduled jobs in servers. - -#### IPFS CI/CD for frontend and metadata - -- Frontend and hardcoded values will be stored in IPFS utilizing a similar system to the one [introduced](https://github.com/Uniswap/interface) by Uniswap. - -### Historical APY and TVL - -- Yearn Exporter provides a simple backend solution for storing real-time stats from yearn products. -- Metrics are stored in a timeseries database and will be exposed by an api, accessible by SDK and third-party. - -### SDK, aggregator of many datasources - -- SDK will provide a simple interface for all integrators, including ourselves. -- Read methods will seamlessly integrate with all datasources, while keeping coherent datastructures. -- Write methods talk directly to assets on chain. Execution of write transactions will trigger refresh events so data freshness of frontend (or other integration platforms) will still be preserved. - -### Historical User Earnings - -- Yearn Subgraph leverages thegraph to store historical user data that can be aggregated to display historical earnings. - -### Metadata - -- New way to store all the information that would generally be hard coded directly in the frontend. -- Data is now encoded in predefined schemas that are checked at every change. - -#### Strategy descriptions - -We can store Strategy information directly on IPFS so they can be then be queried and rendered the frontend. - -```json -{ - "$schema":"strategy", - "name":"Idle Finance Reinvest", - "description":"Supplies {{token}} to [Idle Finance](https://idle.finance) to earn IDLE and COMP. Earned tokens are harvested, sold for more {{token}} which is deposited back into the strategy.", - "protocols":["IdleFinance"] -} -``` - -#### Assets management - -We can store Asset informations so in critical situations we can toggle interactions and add custom messages. - -```json -{ - "$schema": "vault", - "comment": "Curve EURS", - "hideAlways": false, - "depositsDisabled": false, - "withdrawalsDisabled": false, - "order": 18, - "migrationAvailable": false, - "allowZapIn": true, - "allowZapOut": true, - "retired": false, - "displayName": "Curve EURS" -} -``` - - -### Front End stack - -

- Backend Chart -

- - -### Front End Features - - -

- Frontend Chart -

From d435ac9baa945d6f16192cbdefe51ddd090c906f Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 9 Feb 2024 22:08:29 -0300 Subject: [PATCH 13/46] update titles --- docs/getting-started/products/yvaults/v3.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/products/yvaults/v3.md b/docs/getting-started/products/yvaults/v3.md index 0c8b7d80f..c3f57a707 100644 --- a/docs/getting-started/products/yvaults/v3.md +++ b/docs/getting-started/products/yvaults/v3.md @@ -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". From bd6a31a0746422c9edff4f9b7d3c98324d6b67c4 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 9 Feb 2024 22:09:28 -0300 Subject: [PATCH 14/46] update titles --- docs/getting-started/products/yvaults/v3.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/products/yvaults/v3.md b/docs/getting-started/products/yvaults/v3.md index c3f57a707..53e3c21d6 100644 --- a/docs/getting-started/products/yvaults/v3.md +++ b/docs/getting-started/products/yvaults/v3.md @@ -38,9 +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** + - https://github.com/yearn/yearn-vaults-v3 - https://github.com/yearn/tokenized-strategy - https://medium.com/iearn/yearnv3-motivation-and-design-107840cb4844 From 6f5153b5ec533df317ef098896ab776273b8d678 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Fri, 9 Feb 2024 22:12:09 -0300 Subject: [PATCH 15/46] update header --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index ce4a24ca1..2b3af4631 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -49,7 +49,7 @@ module.exports = { label: 'Introduction', }, { - to: 'developers/v2/getting-started', + to: 'developers/v3/overview', label: 'Develop', }, { From 997df3d4ea05fe54f4530a70007e208430f75344 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Sat, 10 Feb 2024 00:24:49 -0300 Subject: [PATCH 16/46] move v3 up --- sidebars/sidebarsGettingStarted.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index 2eb68e786..aaf36b3c8 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -14,16 +14,16 @@ module.exports = { 'products/yvaults/vault-tokens', { type: 'category', - label: 'yVaults Version 2', + label: 'yVaults Version 3', items: [ - 'products/yvaults/vault-factory', + 'products/yvaults/v3', ], }, { type: 'category', - label: 'yVaults Version 3', + label: 'yVaults Version 2', items: [ - 'products/yvaults/v3', + 'products/yvaults/vault-factory', ], }, ], From a3ed51d614477c546e2944d9fac1874825cbb860 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 17:36:34 +0800 Subject: [PATCH 17/46] fix: yearn.vision info --- docs/getting-started/guides/how-boost-works.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/getting-started/guides/how-boost-works.md b/docs/getting-started/guides/how-boost-works.md index b74f7ff85..076e2204b 100644 --- a/docs/getting-started/guides/how-boost-works.md +++ b/docs/getting-started/guides/how-boost-works.md @@ -108,11 +108,6 @@ Both of these Yearn vaults reward CRV stakers with a share of the CRV locked by Yearn’s work to automate the yield generation and rebalancing of your crypto assets is especially true in the case of your CRV holdings, and Yearn’s yveCRV or yvBOOST offers a powerful, compounding, “set-and-forget” place to stake your CRV! -## Yearn veTokens Holdings - -- veYFI: https://yearn.vision/?orgId=1&refresh=5m&viewPanel=53 -- veCRV: https://yearn.vision/d/Qu4WGIwnz/vecrv?orgId=1 - ## More information - [curve.fi](https://www.curve.fi/) webpage From eb2e06dd13f515847067cd011ce3f6ca3e23f802 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 17:50:52 +0800 Subject: [PATCH 18/46] fix: wording ycrv overview --- docs/getting-started/products/ylockers/ycrv/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index 37b4c3fa7..1eb0533a2 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -18,7 +18,7 @@ _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 https://yearn.fi/ycrv 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: https://curve.fi/#/ethereum/pools/factory-v2-280/deposit +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 From 85eac2af7e72874c57905f4d96326fafc7737964 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 17:52:48 +0800 Subject: [PATCH 19/46] lowercase --- docs/getting-started/products/yvaults/v3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/products/yvaults/v3.md b/docs/getting-started/products/yvaults/v3.md index 53e3c21d6..dac2cab49 100644 --- a/docs/getting-started/products/yvaults/v3.md +++ b/docs/getting-started/products/yvaults/v3.md @@ -40,7 +40,7 @@ Periphery Modules are a separate layer of optional contracts to use with vaults # Read More -**For More information visit the V3 developer section: https://docs.yearn.fi/developers/v3/overview** +**For more information visit the V3 developer section: https://docs.yearn.fi/developers/v3/overview** - https://github.com/yearn/yearn-vaults-v3 - https://github.com/yearn/tokenized-strategy From 7b53fd0cd007d8eb73424540b302eccf34b48b9e Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 19:04:29 +0800 Subject: [PATCH 20/46] delete extra word --- docs/getting-started/products/yvaults/vault-tokens.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/products/yvaults/vault-tokens.md b/docs/getting-started/products/yvaults/vault-tokens.md index 8819fdfd8..b57430d6f 100644 --- a/docs/getting-started/products/yvaults/vault-tokens.md +++ b/docs/getting-started/products/yvaults/vault-tokens.md @@ -21,11 +21,11 @@ The vault tokens have evolved between v1, v2, and v3, here are a couple of main ## V2 yVault Tokens - Each vault contract can use up to 20 yield strategy contracts. -- Vault tokens are prefixed with `yv`, so so a v2 vault for USDC gives the user yvUSDC. +- Vault tokens are prefixed with `yv`, so a v2 vault for USDC gives the user yvUSDC. ## V3 yVault Tokens -- The strategy contract is [ERC-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) compliant (we call this "Tokenized Strategy"). +- The strategy contract is [ERC-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) compliant (we call it a "Tokenized Strategy"). - A strategy can act as a vault with only 1 strategy. - A strategy can act as a vault for many strategies. -- Vault tokens are still prefixed with `yv`, so so a v3 vault for USDC gives the user yvUSDC. \ No newline at end of file +- Vault tokens are still prefixed with `yv`, so a v3 vault for USDC gives the user yvUSDC. \ No newline at end of file From 50f906c95933b94007cfdbb97750bf837b6e57c4 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 19:07:13 +0800 Subject: [PATCH 21/46] add polygon network --- docs/getting-started/using-yearn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/using-yearn.md b/docs/getting-started/using-yearn.md index f959ea377..de079d3d3 100644 --- a/docs/getting-started/using-yearn.md +++ b/docs/getting-started/using-yearn.md @@ -10,7 +10,7 @@ First, **Connect your wallet** using the button at the top right corner. Multipl ## Yearn is multi-chain -Our products are currently on Ethereum, Fantom, Arbitrum, and Optimism, with more to come. +Our products are currently on Ethereum, Fantom, Arbitrum, Optimism, and Polygon with more to come. Click on this button to select the network you would like to interact with: From 611fd61df64c638848a9a8b4a255b656c3222d62 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 21:47:36 +0800 Subject: [PATCH 22/46] fix: ycrv sidebar --- sidebars/sidebarsGettingStarted.js | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index aaf36b3c8..f6d6a76c2 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -40,12 +40,23 @@ module.exports = { label: 'yLockers', items: [ 'products/ylockers/overview', - 'products/ylockers/ycrv/overview', - 'products/ylockers/ycrv/faq', - 'products/ylockers/ycrv/guide', - 'products/ylockers/yprisma/overview', - 'products/ylockers/yprisma/farming', - + { + type: 'category', + label: 'yCRV', + items: [ + 'products/ylockers/ycrv/overview', + 'products/ylockers/ycrv/faq', + 'products/ylockers/ycrv/guide' + ], + }, + { + type: 'category', + label: 'yPRISMA', + items: [ + 'products/ylockers/yprisma/overview', + 'products/ylockers/yprisma/farming' + ], + }, ], }, { From d1e3d8b887f21d5626068a4fe7ef29fdb1e65785 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 21:51:43 +0800 Subject: [PATCH 23/46] update ylockers headers --- docs/getting-started/products/ylockers/ycrv/overview.md | 2 +- docs/getting-started/products/ylockers/yprisma/overview.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index 1eb0533a2..4d32362f7 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -1,4 +1,4 @@ -# yCRV +# Overview ![](https://i.imgur.com/ni42qE6.png) diff --git a/docs/getting-started/products/ylockers/yprisma/overview.md b/docs/getting-started/products/ylockers/yprisma/overview.md index b7b65a927..667cee93d 100644 --- a/docs/getting-started/products/ylockers/yprisma/overview.md +++ b/docs/getting-started/products/ylockers/yprisma/overview.md @@ -1,4 +1,4 @@ -# yPRISMA +# Overview Claim and deposit at [yprisma.yearn.fi](https://yprisma.yearn.fi) From 06517af44738c377f7167da30cb4deb3d9c5f358 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 22:26:05 +0800 Subject: [PATCH 24/46] refactor r & d to deprecated --- .../{r-and-d => deprecated}/delegated-funding-dao-vaults.md | 2 +- docs/resources/{r-and-d => deprecated}/stablecredit.md | 0 docs/resources/{r-and-d => deprecated}/vecrv-boosts.md | 6 +++++- docs/resources/{r-and-d => deprecated}/woofy.md | 0 docs/resources/{r-and-d => deprecated}/yearn.md | 0 docs/resources/{ => deprecated}/ygift.md | 4 ++++ docs/resources/{r-and-d => deprecated}/ytrade.md | 2 +- sidebars/sidebarsResources.js | 5 ++--- 8 files changed, 13 insertions(+), 6 deletions(-) rename docs/resources/{r-and-d => deprecated}/delegated-funding-dao-vaults.md (95%) rename docs/resources/{r-and-d => deprecated}/stablecredit.md (100%) rename docs/resources/{r-and-d => deprecated}/vecrv-boosts.md (98%) rename docs/resources/{r-and-d => deprecated}/woofy.md (100%) rename docs/resources/{r-and-d => deprecated}/yearn.md (100%) rename docs/resources/{ => deprecated}/ygift.md (98%) rename docs/resources/{r-and-d => deprecated}/ytrade.md (96%) diff --git a/docs/resources/r-and-d/delegated-funding-dao-vaults.md b/docs/resources/deprecated/delegated-funding-dao-vaults.md similarity index 95% rename from docs/resources/r-and-d/delegated-funding-dao-vaults.md rename to docs/resources/deprecated/delegated-funding-dao-vaults.md index 522cbe935..3b5555c71 100644 --- a/docs/resources/r-and-d/delegated-funding-dao-vaults.md +++ b/docs/resources/deprecated/delegated-funding-dao-vaults.md @@ -1,5 +1,5 @@ --- -description: In development +status: On Hold (No Active Development or R&D) --- # Delegated Funding DAO Vaults diff --git a/docs/resources/r-and-d/stablecredit.md b/docs/resources/deprecated/stablecredit.md similarity index 100% rename from docs/resources/r-and-d/stablecredit.md rename to docs/resources/deprecated/stablecredit.md diff --git a/docs/resources/r-and-d/vecrv-boosts.md b/docs/resources/deprecated/vecrv-boosts.md similarity index 98% rename from docs/resources/r-and-d/vecrv-boosts.md rename to docs/resources/deprecated/vecrv-boosts.md index 1ff1481b5..b149a25c6 100644 --- a/docs/resources/r-and-d/vecrv-boosts.md +++ b/docs/resources/deprecated/vecrv-boosts.md @@ -1,4 +1,8 @@ -# veCRV Boosts (deprecated) +--- +Status: Deprecated +--- + +# veCRV Boosts > **This page is outdated since yveCRV was deprecated in favour of yCRV. Check the new yCRV [page](https://docs.yearn.fi/getting-started/products/ycrv/overview).** diff --git a/docs/resources/r-and-d/woofy.md b/docs/resources/deprecated/woofy.md similarity index 100% rename from docs/resources/r-and-d/woofy.md rename to docs/resources/deprecated/woofy.md diff --git a/docs/resources/r-and-d/yearn.md b/docs/resources/deprecated/yearn.md similarity index 100% rename from docs/resources/r-and-d/yearn.md rename to docs/resources/deprecated/yearn.md diff --git a/docs/resources/ygift.md b/docs/resources/deprecated/ygift.md similarity index 98% rename from docs/resources/ygift.md rename to docs/resources/deprecated/ygift.md index b7c7b4aaa..fb8bd7b39 100644 --- a/docs/resources/ygift.md +++ b/docs/resources/deprecated/ygift.md @@ -1,3 +1,7 @@ +--- +Status: Deprecated +--- + # yGift Brighten someone's day by sending a virtual gift. yGift is an NFT (Non-Fungible Token) that can be used to reward someone for their work, or to simply share some love. diff --git a/docs/resources/r-and-d/ytrade.md b/docs/resources/deprecated/ytrade.md similarity index 96% rename from docs/resources/r-and-d/ytrade.md rename to docs/resources/deprecated/ytrade.md index 95833c383..864a3d951 100644 --- a/docs/resources/r-and-d/ytrade.md +++ b/docs/resources/deprecated/ytrade.md @@ -1,5 +1,5 @@ --- -description: Not recommended for retail use +Status: Not recommended for retail use --- # yTrade diff --git a/sidebars/sidebarsResources.js b/sidebars/sidebarsResources.js index a0cbca1d2..375ca35e3 100644 --- a/sidebars/sidebarsResources.js +++ b/sidebars/sidebarsResources.js @@ -9,10 +9,9 @@ module.exports = { }, { type: 'category', - label: 'R & D', - items: [{ type: 'autogenerated', dirName: 'r-and-d' }], + label: 'Deprecated Projects', + items: [{ type: 'autogenerated', dirName: 'deprecated' }], }, - 'ygift', { type: 'link', href: 'https://github.com/yearn/yearn-pm/tree/master/financials/reports', From 82f8fcebae17e2ef12fcef201a2576aa24ce1938 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 22:28:09 +0800 Subject: [PATCH 25/46] update yEarn --- docs/resources/deprecated/yearn.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/resources/deprecated/yearn.md b/docs/resources/deprecated/yearn.md index b36cde102..74743f3d5 100644 --- a/docs/resources/deprecated/yearn.md +++ b/docs/resources/deprecated/yearn.md @@ -1,8 +1,8 @@ --- -description: Deprecated +Status: Deprecated --- -# yEarn (deprecated) +# yEarn Earn is a lending aggregator that strives to attain the highest yield for supported coins \(DAI, USDC, USDT, TUSD, sUSD, or wBTC\) at all times. It does this by programmatically shifting these coins between several lending protocols \([AAVE](https://aave.com), [dYdX](https://dydx.exchange/), and [Compound](https://compound.finance)\) operating on the Ethereum blockchain. From 9f24adfea1157c7fab8aa1440f88cd0f669b3a25 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 23:07:19 +0800 Subject: [PATCH 26/46] update woofy page --- docs/resources/deprecated/woofy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/resources/deprecated/woofy.md b/docs/resources/deprecated/woofy.md index a9d4fb3e3..ed76791dc 100644 --- a/docs/resources/deprecated/woofy.md +++ b/docs/resources/deprecated/woofy.md @@ -1,3 +1,7 @@ +--- +Status: Deprecated +--- + # Woofy The WOOFY token is the blue dog companion token of YFI. Utilizing special Woof technology, it allows two-way conversion between the two tokens, allowing holders to be exposed to YFI in a fluffier package. From 76da01694e9b18605a85ad4824c5cd21427e4393 Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 23:08:25 +0800 Subject: [PATCH 27/46] remove: llama pay info --- docs/contributing/operations/budget.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/contributing/operations/budget.md b/docs/contributing/operations/budget.md index 8397fff41..58501ca0d 100644 --- a/docs/contributing/operations/budget.md +++ b/docs/contributing/operations/budget.md @@ -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) \ No newline at end of file From d256c52a580a2a7b980298ef40f3f73c2100f31c Mon Sep 17 00:00:00 2001 From: 0xBasically <0xBasic@yearn.finance> Date: Fri, 16 Feb 2024 23:13:06 +0800 Subject: [PATCH 28/46] refactor v3 sidebar --- sidebars/sidebarsDevelopers.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars/sidebarsDevelopers.js b/sidebars/sidebarsDevelopers.js index 913237c93..d47401e94 100644 --- a/sidebars/sidebarsDevelopers.js +++ b/sidebars/sidebarsDevelopers.js @@ -5,9 +5,9 @@ module.exports = { label: 'yVaults Version 3', items: [ 'v3/overview', - 'v3/strategy_writing_guide', 'v3/protocol_fees', 'v3/vault_management', + 'v3/strategy_writing_guide', ], }, { From 46c3b0e740f1d59554e094b6fea86f59fbe084c3 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:13:13 -0300 Subject: [PATCH 29/46] fix dead link --- docs/getting-started/products/ylockers/ycrv/overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index 4d32362f7..2c39c8d94 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -25,7 +25,7 @@ Both operations mint yCRV to the user at a 1:1 rate. Users migrating from yvBOOS 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. @@ -46,7 +46,7 @@ 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. @@ -54,7 +54,7 @@ Yearn will mark 1 veCRV worth of voting power for every 1 yCRV in this position ## 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) From 850c424f0ecf31e847fd67fb385a3b8ffe7a5268 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:16:32 -0300 Subject: [PATCH 30/46] fix dead link --- docs/getting-started/products/ylockers/ycrv/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/products/ylockers/ycrv/faq.md b/docs/getting-started/products/ylockers/ycrv/faq.md index 744d0dde8..eff84b06e 100644 --- a/docs/getting-started/products/ylockers/ycrv/faq.md +++ b/docs/getting-started/products/ylockers/ycrv/faq.md @@ -1,7 +1,7 @@ # 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. @@ -16,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. \ No newline at end of file +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. From 5e662ab0cbf1197ba093d0e7b27924b6ff718808 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:19:10 -0300 Subject: [PATCH 31/46] Update sidebarsContributing.js --- sidebars/sidebarsContributing.js | 1 - 1 file changed, 1 deletion(-) diff --git a/sidebars/sidebarsContributing.js b/sidebars/sidebarsContributing.js index fee7273bf..ff924a1b2 100644 --- a/sidebars/sidebarsContributing.js +++ b/sidebars/sidebarsContributing.js @@ -15,7 +15,6 @@ module.exports = { items: [ 'governance/proposal-process', 'governance/yfi', - 'governance/veyfi', ], }, { From be4d8f26a3c225b36f6857589bf09c16d9a128c9 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:19:44 -0300 Subject: [PATCH 32/46] Update sidebarsGettingStarted.js --- sidebars/sidebarsGettingStarted.js | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index f6d6a76c2..23c24ec69 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -28,6 +28,13 @@ module.exports = { }, ], }, + { + type: 'category', + label: 'veYFI', + items: [ + 'governance/veyfi',, + ], + }, { type: 'category', label: 'yETH', From b2775206b3e065613a2ee6ba9ea6f49c5d46dcd8 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:21:08 -0300 Subject: [PATCH 33/46] Update veyfi.md --- docs/contributing/governance/veyfi.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/governance/veyfi.md b/docs/contributing/governance/veyfi.md index afb9e1065..4b3fe77b4 100644 --- a/docs/contributing/governance/veyfi.md +++ b/docs/contributing/governance/veyfi.md @@ -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. @@ -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. From 6433375c30aa5a5dc312ace79d4d5165019319a8 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:21:20 -0300 Subject: [PATCH 34/46] Update veyfi.md --- docs/contributing/governance/veyfi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/governance/veyfi.md b/docs/contributing/governance/veyfi.md index 4b3fe77b4..aad9bf15c 100644 --- a/docs/contributing/governance/veyfi.md +++ b/docs/contributing/governance/veyfi.md @@ -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. From 982bca1d365a8f9007ac72c055c3d9793b5740f6 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:23:31 -0300 Subject: [PATCH 35/46] Update sidebarsGettingStarted.js --- sidebars/sidebarsGettingStarted.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index 23c24ec69..b31364386 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -32,7 +32,7 @@ module.exports = { type: 'category', label: 'veYFI', items: [ - 'governance/veyfi',, + '../contributing/governance/veyfi',, ], }, { From e076aa393c662f9b559e86b238cddf47c0961dea Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:34:34 -0300 Subject: [PATCH 36/46] Create veyfi.md --- docs/getting-started/products/veyfi.md | 120 +++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 docs/getting-started/products/veyfi.md diff --git a/docs/getting-started/products/veyfi.md b/docs/getting-started/products/veyfi.md new file mode 100644 index 000000000..aad9bf15c --- /dev/null +++ b/docs/getting-started/products/veyfi.md @@ -0,0 +1,120 @@ +# 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. + +Contract Address: [`0x90c1f9220d90d3966fbee24045edd73e1d588ad5`](https://etherscan.io/address/0x90c1f9220d90d3966fbee24045edd73e1d588ad5) + +## Specification + +Governance Forum Thread: https://gov.yearn.fi/t/yip-65-evolving-yfi-tokenomics + +## veYFI Overview + +- Receives bought-back YFI as reward. +- Locking is similar to the ve-style program of Curve. +- YFI can be locked into veYFI, which is non-transferable. +- Lock duration can be decided on deposit: from 1 week to 4 years. + - You can actually lock up to 10 years, but anything above 4 years doesn’t give you more veYFI. This way you don't have to relock every week. If you set it to longer than 4 years, you can always reset it to 4 years so it starts decaying. +- A user must have a veYFI lock earn boosted rewards. No lock leads to no boosted rewards. A Maximum lock, continuously renewed, maximizes rewards. + - Just like with Curve, even without a veYFI lock, you can still deposit into a vault and stake the vault token into a gauge which will give you the base boost. With the minimum boost, you get to keep 10% of the dYFI you farm. The other 90% goes to veYFI lockers. +- It’s possible to exit the lock early, in exchange for paying a penalty that gets allocated to the other veYFI holders. +- The penalty is up to 75% locked amount and decays over time: + - The total penalty is the minimum percentage between `75% locked amount` and `(time remaining / 4 years)` + - So if your lock is over 3 years you will pay 75%. + - If your lock is 2 years you will pay 2/4 = 50% + - Penalty Formula: `min(75%, lock_duration_left / 4 years * 100%)` +- Now that veYFI has been implemented, only veYFI is accepted voting power in Yearn Governance. + +### dYFI as Gauges Reward + +- [dYFI](#dyfi) is an ERC-20 token. +- Gauges pay dYFI that you can either sell for ETH or convert to YFI (by paying ETH, this ETH gets routed to buybacks immediately). +- Gives its bearer the right to redeem an equivalent amount of YFI in exchange for ETH. +- dYFI is burned upon redemption. +- The circulating supply of dYFI must not exceed the amount of YFI available to be redeemed as part of the tokenomics program. +- The amount of ETH required for redemption is at a discount to the current spot price of YFI/ETH. +- ETH received from dYFI redemption is redirected to automated YFI buybacks handled by an immutable smart contract. + +### Vault Gauges + Voting + +- Vault gauges allow vault depositors to stake their vault tokens and earn YFI rewards according to their veYFI weight. +- Weights decay as the remaining lock duration decreases and can be extended up to the max lock duration. +- Increased locking duration is rewarded with increased weight, so locking for 4 years gives 100% weight, locking for 2 years 50% weight, etc. +- YFI is allocated to gauges based on bi-monthly governance votes. Each gauge can get a different amount of bought-back YFI to emit. +- Based on their veYFI lock, users can boost their gauge rewards by up to 10x proportional to the number of vault tokens deposited, when they claim YFI rewards from gauges. The greater the amount of veYFI, the more vault deposits can be boosted for the user. +- The boost mechanism will calculate your earning weight by taking the smaller amount of two values, provided in the formula below: + - Gauge boost formula: `min(AmountDeposited, (AmountDeposited /10) + (TotalDepositedInTheGauge * VeYFIBalance / VeYFITotalSupply * 0.9))` +- A claim with boost under 100% will send the leftover tokens to veYFI holders. + +### Vault Gauges Table + +| Symbol | Name | Address | +| ------ | ---- | ------- | +| `yG-yvCurve-YFIETH` | yGauge Curve YFI-ETH Pool yVault | [`0x7Fd8Af959B54A677a1D8F92265Bd0714274C56a3`](https://etherscan.io/address/0x7Fd8Af959B54A677a1D8F92265Bd0714274C56a3) | +| `yG-yvCurve-dYFIETH-f-f` | yGauge Curve dYFIETH-f Factory yVault | [`0x28da6dE3e804bDdF0aD237CFA6048f2930D0b4Dc`](https://etherscan.io/address/0x28da6dE3e804bDdF0aD237CFA6048f2930D0b4Dc) | +| `yG-lp-yCRVv2` | yGauge LP Yearn CRV Vault v2 | [`0x107717C98C8125A94D3d2Cc82b86a1b705f3A27C`](https://etherscan.io/address/0x107717C98C8125A94D3d2Cc82b86a1b705f3A27C) | +| `yG-yvCurve-yETH-f` | yGauge Curve yETH Factory yVault | [`0x81d93531720d86f0491DeE7D03f30b3b5aC24e59`](https://etherscan.io/address/0x81d93531720d86f0491DeE7D03f30b3b5aC24e59) | +| `yG-lp-yPRISMA` | yGauge LP Yearn PRISMA Vault | [`0x6130E6cD924a40b24703407F246966D7435D4998`](https://etherscan.io/address/0x6130E6cD924a40b24703407F246966D7435D4998) | + +### veYFI Reward Pool + +- Users who lock veYFI can claim accumulated fees from the veYFI reward pool. The reward pool gets fees two ways: YFI from the veYFI early exit fee and the non-distributed gauge rewards due to a lack of full boost. +- You can claim from the veYFI reward pool two or three weeks (to be defined) from the Thursday after you lock. + +## Benefits + +- **Incorporates YFI buybacks.** The mandate of [YIP-56: Buyback and Build](https://gov.yearn.fi/t/yip-56-buyback-and-build/8929) is unchanged, the new design builds on top of and integrates the bought-back YFI. +- **Incentivizes a long-term view on Yearn.** Token holders are motivated to support the protocol over the long-term rather than to speculate on the short-term. +- **Makes vaults more competitive.** Additional YFI earned from vault gauges are effectively added yield for depositors in proportion to how dedicated they are in their support. +- **Motivates 3rd party protocols and DAOs to become YFI holders.** Yearn products are used as yield components of a broader DeFi stack, and integrated into wallets and protocols. With this design, they have incentives to direct rewards to vaults and products they use. +- **A seamless experience for integrators.** Participation is optional. This maintains the simplicity integrators have come to appreciate and makes it easy to reason about vault behavior. Only those who are motivated to do so can participate. + +## Risks + +- **Risk of governance attacks**, where one or several actors accumulate sizable positions of YFI and can control rewards and decisions of the protocol. +- **Risk of insufficient rewards to make locking attractive**, where vaults may not generate enough tokens for the Treasury to buy back enough YFI to motivate YFI holders to lock into veYFI. This has somewhat of a balancing effect: as demand for locking decreases so does the share of the rewards for those who lock. If it’s determined that the equilibrium does not lead to enough YFI being locked, additional YFI could be minted and rewarded to veYFI holders. +- **Risk of YFI liquidity drying up.** Currently YFI is traded on multiple centralized and decentralized exchanges. As demand for using YFI elsewhere grows, there may be a lack of YFI/ETH LP supply in liquidity pools and lack of interest in general YFI market-making, leading to YFI becoming more illiquid. In such an event, additional incentives may be required to ensure healthy liquidity for trading in and out of YFI. The Treasury may also explore owning some of this liquidity outright. + +## dYFI + +dYFI (previously specified as oYFI) is a token introduced as part of Yearn's veYFI tokenomics program. It is an ERC-20 token that allows its holder to buy back YFI at a discount. + +| Description | Address | +|--------------------|-----------------------------------------------------------------| +| dYFI Address | [`0x41252e8691e964f7de35156b68493bab6797a275`](https://etherscan.io/address/0x41252e8691e964f7de35156b68493bab6797a275) | +| dYFI Redemption | [`0x7dC3A74F0684fc026f9163C6D5c3C99fda2cf60a`](https://etherscan.io/address/0x7dC3A74F0684fc026f9163C6D5c3C99fda2cf60a) | +| YFI Reward Pool | [`0xb287a1964AEE422911c7b8409f5E5A273c1412fA`](https://etherscan.io/address/0xb287a1964AEE422911c7b8409f5E5A273c1412fA) | +| dYFI Reward Pool | [`0x2391Fc8f5E417526338F5aa3968b1851C16D894E`](https://etherscan.io/address/0x2391Fc8f5E417526338F5aa3968b1851C16D894E) | + +### Specification + +- Governance Forum Thread: https://gov.yearn.fi/t/yip-73-activate-veyfi-rewards-with-oyfi-gauges + +### dYFI Overview + +- Implements the ERC-20 standard. +- Gives its bearer the right to redeem an equivalent YFI in exchange for ETH. +- dYFI is burned upon redemption. +- The circulating supply of dYFI must not exceed the amount of YFI available to be redeemed as part of the tokenomics program. +- The amount of ETH required for redemption is at a discount to the current spot price of YFI/ETH. +- Discount calculation is an approximation of the following formula: + - discount = `c / (1 + a * e^k(s * x − 1))`, where: + - **c** = `1` + - **a** = `9.9999` + - **k** = `4.6969` + - **s** = `configurable scaling factor` + - **x** = `veYFI_supply / YFI_supply` + + ![image](/img/charts/dyfi-redemption-chart.png) + +- ETH received from dYFI redemption is redirected to automated YFI buybacks handled by an immutable smart contract, like the one already in production for DAI. + +### Benefits + +- **Rewards active protocol participants.** dYFI is rewarded to users who stake their vault tokens in gauges, thereby incentivizing active participation in the protocol. +- **Promotes YFI buybacks.** The ETH received from dYFI redemption is used for automated YFI buybacks. + +### Risks + +- **Risk of insufficient rewards to make locking attractive**, where vaults may not generate enough tokens for the Treasury to buy back enough YFI to motivate YFI holders to lock into veYFI. This has somewhat of a balancing effect: as demand for locking decreases so does the share of the rewards for those who lock. If it’s determined that the equilibrium does not lead to enough YFI being locked, additional YFI could be minted and rewarded to veYFI holders. +- **Risk of YFI liquidity drying up.** Currently YFI is traded on multiple centralized and decentralized exchanges. As demand for using YFI elsewhere grows, there may be a lack of YFI/ETH LP supply in liquidity pools and lack of interest in general YFI market-making, leading to YFI becoming more illiquid. In such an event, additional incentives may be required to ensure healthy liquidity exists for trading in and out of YFI. The Treasury may also explore owning some of this liquidity outright. From 053eaa8c53c3483cf60a87c73c0859a6cf4718f3 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:35:11 -0300 Subject: [PATCH 37/46] Update sidebarsGettingStarted.js --- sidebars/sidebarsGettingStarted.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars/sidebarsGettingStarted.js b/sidebars/sidebarsGettingStarted.js index b31364386..1f3707d04 100644 --- a/sidebars/sidebarsGettingStarted.js +++ b/sidebars/sidebarsGettingStarted.js @@ -32,7 +32,7 @@ module.exports = { type: 'category', label: 'veYFI', items: [ - '../contributing/governance/veyfi',, + 'products/veyfi', ], }, { From b9b3218f80be47816e3f32450fb1f647bf610d29 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:37:28 -0300 Subject: [PATCH 38/46] Delete docs/contributing/governance/veyfi.md --- docs/contributing/governance/veyfi.md | 120 -------------------------- 1 file changed, 120 deletions(-) delete mode 100644 docs/contributing/governance/veyfi.md diff --git a/docs/contributing/governance/veyfi.md b/docs/contributing/governance/veyfi.md deleted file mode 100644 index aad9bf15c..000000000 --- a/docs/contributing/governance/veyfi.md +++ /dev/null @@ -1,120 +0,0 @@ -# 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. - -Contract Address: [`0x90c1f9220d90d3966fbee24045edd73e1d588ad5`](https://etherscan.io/address/0x90c1f9220d90d3966fbee24045edd73e1d588ad5) - -## Specification - -Governance Forum Thread: https://gov.yearn.fi/t/yip-65-evolving-yfi-tokenomics - -## veYFI Overview - -- Receives bought-back YFI as reward. -- Locking is similar to the ve-style program of Curve. -- YFI can be locked into veYFI, which is non-transferable. -- Lock duration can be decided on deposit: from 1 week to 4 years. - - You can actually lock up to 10 years, but anything above 4 years doesn’t give you more veYFI. This way you don't have to relock every week. If you set it to longer than 4 years, you can always reset it to 4 years so it starts decaying. -- A user must have a veYFI lock earn boosted rewards. No lock leads to no boosted rewards. A Maximum lock, continuously renewed, maximizes rewards. - - Just like with Curve, even without a veYFI lock, you can still deposit into a vault and stake the vault token into a gauge which will give you the base boost. With the minimum boost, you get to keep 10% of the dYFI you farm. The other 90% goes to veYFI lockers. -- It’s possible to exit the lock early, in exchange for paying a penalty that gets allocated to the other veYFI holders. -- The penalty is up to 75% locked amount and decays over time: - - The total penalty is the minimum percentage between `75% locked amount` and `(time remaining / 4 years)` - - So if your lock is over 3 years you will pay 75%. - - If your lock is 2 years you will pay 2/4 = 50% - - Penalty Formula: `min(75%, lock_duration_left / 4 years * 100%)` -- Now that veYFI has been implemented, only veYFI is accepted voting power in Yearn Governance. - -### dYFI as Gauges Reward - -- [dYFI](#dyfi) is an ERC-20 token. -- Gauges pay dYFI that you can either sell for ETH or convert to YFI (by paying ETH, this ETH gets routed to buybacks immediately). -- Gives its bearer the right to redeem an equivalent amount of YFI in exchange for ETH. -- dYFI is burned upon redemption. -- The circulating supply of dYFI must not exceed the amount of YFI available to be redeemed as part of the tokenomics program. -- The amount of ETH required for redemption is at a discount to the current spot price of YFI/ETH. -- ETH received from dYFI redemption is redirected to automated YFI buybacks handled by an immutable smart contract. - -### Vault Gauges + Voting - -- Vault gauges allow vault depositors to stake their vault tokens and earn YFI rewards according to their veYFI weight. -- Weights decay as the remaining lock duration decreases and can be extended up to the max lock duration. -- Increased locking duration is rewarded with increased weight, so locking for 4 years gives 100% weight, locking for 2 years 50% weight, etc. -- YFI is allocated to gauges based on bi-monthly governance votes. Each gauge can get a different amount of bought-back YFI to emit. -- Based on their veYFI lock, users can boost their gauge rewards by up to 10x proportional to the number of vault tokens deposited, when they claim YFI rewards from gauges. The greater the amount of veYFI, the more vault deposits can be boosted for the user. -- The boost mechanism will calculate your earning weight by taking the smaller amount of two values, provided in the formula below: - - Gauge boost formula: `min(AmountDeposited, (AmountDeposited /10) + (TotalDepositedInTheGauge * VeYFIBalance / VeYFITotalSupply * 0.9))` -- A claim with boost under 100% will send the leftover tokens to veYFI holders. - -### Vault Gauges Table - -| Symbol | Name | Address | -| ------ | ---- | ------- | -| `yG-yvCurve-YFIETH` | yGauge Curve YFI-ETH Pool yVault | [`0x7Fd8Af959B54A677a1D8F92265Bd0714274C56a3`](https://etherscan.io/address/0x7Fd8Af959B54A677a1D8F92265Bd0714274C56a3) | -| `yG-yvCurve-dYFIETH-f-f` | yGauge Curve dYFIETH-f Factory yVault | [`0x28da6dE3e804bDdF0aD237CFA6048f2930D0b4Dc`](https://etherscan.io/address/0x28da6dE3e804bDdF0aD237CFA6048f2930D0b4Dc) | -| `yG-lp-yCRVv2` | yGauge LP Yearn CRV Vault v2 | [`0x107717C98C8125A94D3d2Cc82b86a1b705f3A27C`](https://etherscan.io/address/0x107717C98C8125A94D3d2Cc82b86a1b705f3A27C) | -| `yG-yvCurve-yETH-f` | yGauge Curve yETH Factory yVault | [`0x81d93531720d86f0491DeE7D03f30b3b5aC24e59`](https://etherscan.io/address/0x81d93531720d86f0491DeE7D03f30b3b5aC24e59) | -| `yG-lp-yPRISMA` | yGauge LP Yearn PRISMA Vault | [`0x6130E6cD924a40b24703407F246966D7435D4998`](https://etherscan.io/address/0x6130E6cD924a40b24703407F246966D7435D4998) | - -### veYFI Reward Pool - -- Users who lock veYFI can claim accumulated fees from the veYFI reward pool. The reward pool gets fees two ways: YFI from the veYFI early exit fee and the non-distributed gauge rewards due to a lack of full boost. -- You can claim from the veYFI reward pool two or three weeks (to be defined) from the Thursday after you lock. - -## Benefits - -- **Incorporates YFI buybacks.** The mandate of [YIP-56: Buyback and Build](https://gov.yearn.fi/t/yip-56-buyback-and-build/8929) is unchanged, the new design builds on top of and integrates the bought-back YFI. -- **Incentivizes a long-term view on Yearn.** Token holders are motivated to support the protocol over the long-term rather than to speculate on the short-term. -- **Makes vaults more competitive.** Additional YFI earned from vault gauges are effectively added yield for depositors in proportion to how dedicated they are in their support. -- **Motivates 3rd party protocols and DAOs to become YFI holders.** Yearn products are used as yield components of a broader DeFi stack, and integrated into wallets and protocols. With this design, they have incentives to direct rewards to vaults and products they use. -- **A seamless experience for integrators.** Participation is optional. This maintains the simplicity integrators have come to appreciate and makes it easy to reason about vault behavior. Only those who are motivated to do so can participate. - -## Risks - -- **Risk of governance attacks**, where one or several actors accumulate sizable positions of YFI and can control rewards and decisions of the protocol. -- **Risk of insufficient rewards to make locking attractive**, where vaults may not generate enough tokens for the Treasury to buy back enough YFI to motivate YFI holders to lock into veYFI. This has somewhat of a balancing effect: as demand for locking decreases so does the share of the rewards for those who lock. If it’s determined that the equilibrium does not lead to enough YFI being locked, additional YFI could be minted and rewarded to veYFI holders. -- **Risk of YFI liquidity drying up.** Currently YFI is traded on multiple centralized and decentralized exchanges. As demand for using YFI elsewhere grows, there may be a lack of YFI/ETH LP supply in liquidity pools and lack of interest in general YFI market-making, leading to YFI becoming more illiquid. In such an event, additional incentives may be required to ensure healthy liquidity for trading in and out of YFI. The Treasury may also explore owning some of this liquidity outright. - -## dYFI - -dYFI (previously specified as oYFI) is a token introduced as part of Yearn's veYFI tokenomics program. It is an ERC-20 token that allows its holder to buy back YFI at a discount. - -| Description | Address | -|--------------------|-----------------------------------------------------------------| -| dYFI Address | [`0x41252e8691e964f7de35156b68493bab6797a275`](https://etherscan.io/address/0x41252e8691e964f7de35156b68493bab6797a275) | -| dYFI Redemption | [`0x7dC3A74F0684fc026f9163C6D5c3C99fda2cf60a`](https://etherscan.io/address/0x7dC3A74F0684fc026f9163C6D5c3C99fda2cf60a) | -| YFI Reward Pool | [`0xb287a1964AEE422911c7b8409f5E5A273c1412fA`](https://etherscan.io/address/0xb287a1964AEE422911c7b8409f5E5A273c1412fA) | -| dYFI Reward Pool | [`0x2391Fc8f5E417526338F5aa3968b1851C16D894E`](https://etherscan.io/address/0x2391Fc8f5E417526338F5aa3968b1851C16D894E) | - -### Specification - -- Governance Forum Thread: https://gov.yearn.fi/t/yip-73-activate-veyfi-rewards-with-oyfi-gauges - -### dYFI Overview - -- Implements the ERC-20 standard. -- Gives its bearer the right to redeem an equivalent YFI in exchange for ETH. -- dYFI is burned upon redemption. -- The circulating supply of dYFI must not exceed the amount of YFI available to be redeemed as part of the tokenomics program. -- The amount of ETH required for redemption is at a discount to the current spot price of YFI/ETH. -- Discount calculation is an approximation of the following formula: - - discount = `c / (1 + a * e^k(s * x − 1))`, where: - - **c** = `1` - - **a** = `9.9999` - - **k** = `4.6969` - - **s** = `configurable scaling factor` - - **x** = `veYFI_supply / YFI_supply` - - ![image](/img/charts/dyfi-redemption-chart.png) - -- ETH received from dYFI redemption is redirected to automated YFI buybacks handled by an immutable smart contract, like the one already in production for DAI. - -### Benefits - -- **Rewards active protocol participants.** dYFI is rewarded to users who stake their vault tokens in gauges, thereby incentivizing active participation in the protocol. -- **Promotes YFI buybacks.** The ETH received from dYFI redemption is used for automated YFI buybacks. - -### Risks - -- **Risk of insufficient rewards to make locking attractive**, where vaults may not generate enough tokens for the Treasury to buy back enough YFI to motivate YFI holders to lock into veYFI. This has somewhat of a balancing effect: as demand for locking decreases so does the share of the rewards for those who lock. If it’s determined that the equilibrium does not lead to enough YFI being locked, additional YFI could be minted and rewarded to veYFI holders. -- **Risk of YFI liquidity drying up.** Currently YFI is traded on multiple centralized and decentralized exchanges. As demand for using YFI elsewhere grows, there may be a lack of YFI/ETH LP supply in liquidity pools and lack of interest in general YFI market-making, leading to YFI becoming more illiquid. In such an event, additional incentives may be required to ensure healthy liquidity exists for trading in and out of YFI. The Treasury may also explore owning some of this liquidity outright. From 669b69272c6bd113e6c9b1a526dc1fbd90a287e2 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 14:46:50 -0300 Subject: [PATCH 39/46] update homepage --- src/homepageFeatures.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/homepageFeatures.js b/src/homepageFeatures.js index 99ab8c258..0160b6900 100644 --- a/src/homepageFeatures.js +++ b/src/homepageFeatures.js @@ -9,11 +9,11 @@ export default [ }, { title: 'Vaults & Strategies', - description: 'An overview on how Yearn Vaults and its strategies work.', + description: 'An overview on how Yearn V3 Vaults and strategies work.', to: './developers/v3/overview', }, { - title: 'Yearn Risk Scores', + title: 'Risk Scores', description: 'Learn about the Yearn risk framework for assessing DeFi yield strategies.', to: './resources/risks/risk-score', }, @@ -23,19 +23,19 @@ export default [ title: 'Build', rows: [ { - title: 'New Strategies', - description: 'Get started building with vaults and strategies.', + title: 'Strategies', + description: 'Get started building V3 strategies.', to: './developers/v3/strategy_writing_guide', }, { - title: 'Yearn Data', + title: 'Data Services', description: 'Learn about the Yearn data services like yDaemon and the subgraphs', to: './developers/v2/yearn-data', }, { title: 'veYFI', description: 'Participate in Yearn governance and learn how boosted yield works.', - to: './contributing/governance/veyfi', + to: './getting-started/products/veyfi', }, ], } From d7e6250b779edefdaea007e8de3ae1d6ce7f49a7 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 15:03:32 -0300 Subject: [PATCH 40/46] update footer --- docusaurus.config.js | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 2b3af4631..834c8a80f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -88,10 +88,6 @@ module.exports = { { title: 'Developers', items: [ - { - label: 'Open Issues', - href: 'https://contribute.yearn.rocks/', - }, { label: '#strategies - Discord', href: 'https://discord.gg/b8ENPNqG5c', @@ -102,8 +98,8 @@ module.exports = { title: 'GitHub', items: [ { - label: 'yearn-vaults', - href: 'https://github.com/yearn/yearn-vaults', + label: 'tokenized-strategy', + href: 'https://github.com/yearn/tokenized-strategys', }, { label: 'foundry-tokenized--strategy-mix', @@ -113,14 +109,6 @@ module.exports = { label: 'apeworx-tokenized-strategy-mix', href: 'https://github.com/yearn/tokenized-strategy-ape-mix', }, - { - label: 'yearn-watch', - href: 'https://github.com/yearn/yearn-watch', - }, - { - label: 'yearn-finance-v3', - href: 'https://github.com/yearn/yearn-finance-v3', - }, { label: 'yearn-security', href: 'https://github.com/yearn/yearn-security', @@ -135,20 +123,36 @@ module.exports = { title: 'Ecosystem', items: [ { - label: 'Vaults', + label: 'V3 Vaults', + href: 'https://yearn.fi/v3', + }, + { + label: 'V2 Vaults', href: 'https://yearn.fi/vaults', }, + { + label: 'Juiced Vaults', + href: 'https://juiced.yearn.fi/', + }, + { + label: 'veYFI', + href: 'https://veyfi.yearn.fi/', + }, { label: 'yETH', href: 'https://yeth.yearn.fi/', }, { - label: 'YFI Stats', - href: 'https://www.yfistats.com/', + label: 'yCRV', + href: 'https://ycrv.yearn.fi/', + }, + { + label: 'yPrisma', + href: 'https://yprisma.yearn.fi/', }, { - label: 'Bowswap', - href: 'https://bowswap.finance/', + label: 'yBribe', + href: 'https://ybribe.yearn.fi/', }, ], }, From e96d4d6765e82a6801c3ddbba2ff4769e2250571 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 15:08:49 -0300 Subject: [PATCH 41/46] Update docusaurus.config.js --- docusaurus.config.js | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 834c8a80f..d4dd8af48 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -86,29 +86,32 @@ module.exports = { style: 'light', links: [ { - title: 'Developers', + title: 'GitHub', items: [ { - label: '#strategies - Discord', - href: 'https://discord.gg/b8ENPNqG5c', + label: 'V3 Vaults', + href: 'https://github.com/yearn/yearn-vaults-v3', }, - ], - }, - { - title: 'GitHub', - items: [ { - label: 'tokenized-strategy', + label: 'V3 Strategy Mix', href: 'https://github.com/yearn/tokenized-strategys', }, { - label: 'foundry-tokenized--strategy-mix', + label: 'V3 Strategy Mix: Foundry', href: 'https://github.com/yearn/tokenized-strategy-foundry-mix', }, { - label: 'apeworx-tokenized-strategy-mix', + label: 'V3 Strategy Mix: Ape', href: 'https://github.com/yearn/tokenized-strategy-ape-mix', }, + { + label: 'V2 Vaults', + href: 'https://github.com/yearn/yearn-vaults', + }, + { + label: 'V2 Strategy Mix', + href: 'https://github.com/yearn/brownie-strategy-mix', + }, { label: 'yearn-security', href: 'https://github.com/yearn/yearn-security', From 76ec4a2661fc38b356d983d09bb8e3042572606f Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Mon, 19 Feb 2024 15:09:50 -0300 Subject: [PATCH 42/46] Update docusaurus.config.js --- docusaurus.config.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index d4dd8af48..1f97b5853 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -93,8 +93,8 @@ module.exports = { href: 'https://github.com/yearn/yearn-vaults-v3', }, { - label: 'V3 Strategy Mix', - href: 'https://github.com/yearn/tokenized-strategys', + label: 'V3 Tokenized Strategy', + href: 'https://github.com/yearn/tokenized-strategy', }, { label: 'V3 Strategy Mix: Foundry', From 2baf5acff0cb66aab4508e68c65f63443bad5f72 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Tue, 20 Feb 2024 11:23:41 -0300 Subject: [PATCH 43/46] update snapshot link --- docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 1f97b5853..679de0217 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -184,7 +184,7 @@ module.exports = { }, { label: 'Snapshot voting', - href: 'https://snapshot.org/#/ybaby.eth', + href: 'https://snapshot.org/#/veyfi.eth', }, ], }, From fb1283fcf8915324b9d90bf7147f0c0d01b153de Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Tue, 20 Feb 2024 11:54:06 -0300 Subject: [PATCH 44/46] Update homepageFeatures.js --- src/homepageFeatures.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/homepageFeatures.js b/src/homepageFeatures.js index 0160b6900..ac94bde29 100644 --- a/src/homepageFeatures.js +++ b/src/homepageFeatures.js @@ -9,7 +9,7 @@ export default [ }, { title: 'Vaults & Strategies', - description: 'An overview on how Yearn V3 Vaults and strategies work.', + description: 'An overview on how Yearn vaults and strategies work.', to: './developers/v3/overview', }, { @@ -22,16 +22,16 @@ export default [ { title: 'Build', rows: [ + { + title: 'Vaults', + description: 'Get started building V3 vaults.', + to: './developers/v3/vault_management', + }, { title: 'Strategies', description: 'Get started building V3 strategies.', to: './developers/v3/strategy_writing_guide', }, - { - title: 'Data Services', - description: 'Learn about the Yearn data services like yDaemon and the subgraphs', - to: './developers/v2/yearn-data', - }, { title: 'veYFI', description: 'Participate in Yearn governance and learn how boosted yield works.', From 06be169b10d2a8fecf254050a89cdc1140e6aad3 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Tue, 20 Feb 2024 11:57:57 -0300 Subject: [PATCH 45/46] update intro vaults link --- docs/getting-started/intro.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/intro.md b/docs/getting-started/intro.md index 6febd80fa..996a25d7f 100644 --- a/docs/getting-started/intro.md +++ b/docs/getting-started/intro.md @@ -10,7 +10,8 @@ The protocol is maintained by various independent developers and is governed by 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. -- https://yearn.fi/vaults +- Yearn Vaults V3: https://yearn.fi/v3 +- Yearn Vaults V2: https://yearn.fi/vaults ## Governance From 8946a02c9918b7fcf5ec734ba8c0649a7f1bcff2 Mon Sep 17 00:00:00 2001 From: Marco Guaspari Worms Date: Tue, 20 Feb 2024 12:04:17 -0300 Subject: [PATCH 46/46] Update yearn-data.md remove dead links form data page --- docs/developers/v2/yearn-data.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/developers/v2/yearn-data.md b/docs/developers/v2/yearn-data.md index 0291e900b..533318e30 100644 --- a/docs/developers/v2/yearn-data.md +++ b/docs/developers/v2/yearn-data.md @@ -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.