diff --git a/docs/contributing/introduction.md b/docs/contributing/introduction.md new file mode 100644 index 0000000000..89631c9a73 --- /dev/null +++ b/docs/contributing/introduction.md @@ -0,0 +1,9 @@ +# Yearn DAO + +![image](/img/dao-pages/here-we-are-cropped.jpg) + +Yearn is a collective of developers, users, thinkers, and doers all working toward making the best suite of on-chain, decentralized, yield products. There are no bosses or interns, no board of directors or HR department, only those who contribute to, participate in, and explore Yearn. Yearn started as an experiment with a week long release of YFI and continues as an experiment today. + +## 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](/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460). diff --git a/docs/developers/addresses/ycrv-contracts.md b/docs/developers/addresses/ycrv-contracts.md index 8d0b1de755..b70f825a8d 100644 --- a/docs/developers/addresses/ycrv-contracts.md +++ b/docs/developers/addresses/ycrv-contracts.md @@ -22,3 +22,5 @@ A list of deployed yCRV contracts. | lp-yCRV v1 (DEPRECATED) | [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/address/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e#code) | | old CRV/yCRV Curve Pool (DEPRECATED) | [0x453D92C7d4263201C69aACfaf589Ed14202d83a4](https://etherscan.io/address/0x453D92C7d4263201C69aACfaf589Ed14202d83a4#code) | | ZapYCRV.vy | [0x01D7f32B6E463c96c00575fA97B8224326C6A6B9](https://etherscan.io/address/0x01D7f32B6E463c96c00575fA97B8224326C6A6B9#code) | + +[yCRV Docs](/getting-started/products/ylockers/ycrv/overview) diff --git a/docs/developers/addresses/yprisma-contracts.md b/docs/developers/addresses/yprisma-contracts.md index 637787fba8..e574518bf7 100644 --- a/docs/developers/addresses/yprisma-contracts.md +++ b/docs/developers/addresses/yprisma-contracts.md @@ -26,3 +26,5 @@ A list of deployed yPrisma contracts. | *yPRISMA LP Staking (yPRISMA rewards) | [0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246](https://etherscan.io/address/0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246) | | *yCRV Staking (yPRISMA rewards) | [0x84c94d739e075b3C7431bdb1A005F0412DF828a5](https://etherscan.io/address/0x84c94d739e075b3C7431bdb1A005F0412DF828a5) | **expired* + +[yPRISMA Docs](/getting-started/products/ylockers/yprisma/overview) diff --git a/docs/getting-started/intro.md b/docs/getting-started/intro.md index 1c2ccf9bee..22a53a1c77 100644 --- a/docs/getting-started/intro.md +++ b/docs/getting-started/intro.md @@ -1,29 +1,26 @@ -# Introduction +# Yearn Products -Yearn Finance is DeFi’s premier yield aggregator. Giving individuals, DAOs and other protocols a way to deposit digital assets and receive yield. - -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/ +![image](/img/product-pages/blueknight-product-banner.png) ## yVaults -Yearn Vaults (or yVaults) are capital pools that automatically generate yield based on opportunities present in the market. Vaults benefit users by socializing gas costs, automating the yield generation and rebalancing process, and automatically shifting capital as opportunities arise. End users also do not need to have proficient knowledge of the underlying protocols involved or DeFi, thus the Vaults represent a passive-investing strategy. - -- Yearn V3 Vaults website: https://yearn.fi/v3 -- Yearn V2 Vaults website: https://yearn.fi/vaults -- Docs section on yVaults can be found [here](products/yvaults/overview.md) +Yearn Vaults (aka yVaults) 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 do not need to have extensive knowledge of the underlying DeFi protocols and can use the vaults as passive-investing strategies. -## Governance +[Don't know what that means? Check out the yVault Docs](products/yvaults/overview.md) +[Yearn Vaults V3 dApp](https://yearn.fi/v3) +[Yearn Vaults V2 dApp](https://yearn.fi/vaults) -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](/developers/security/multisig) for the list of multisig signers. For more info about the governance process, please consult the [Governance FAQ](/resources/faq#governance) and [YIP-61: Governance 2.0](https://gov.yearn.fi/t/yip-61-governance-2-0/10460). +## yLockers -## Communication Channels +yLockers are yVault products built to get the most out of DeFi protocol governance tokens based on Curve's Vote Escrow mechanics. Lock your tokens and get extra yield, but beware; They are in there to stay and can only be traded on decentralized exchanges. -Governance Forum [https://gov.yearn.fi/](https://gov.yearn.fi/) +[Don't know what that means? Check out the yLockers Docs](products/ylockers/overview.md) +[Yearn yCRV dApp](https://ycrv.yearn.fi/) +[Yearn yPRISMA dApp](https://yprisma.yearn.fi/) -Discord [https://discord.gg/yearn](https://discord.gg/yearn) +## yPools -Telegram [https://t.me/yearnfinance](https://t.me/yearnfinance) +yPools are user-governed liquidity pools of different crypto-assets. They are risk adjusted baskets of community chosen derivatives of the base asset that earn yield from those underlying derivatives. The first yPool is yETH, which is a collection of different liquid staked version of ETH. -Reddit [https://www.reddit.com/r/yearn_finance/](https://www.reddit.com/r/yearn_finance/) +[Don't know what that means? Check out the yETH Docs](products/ypools/yeth/overview.md) +[Yearn yETH dApp](https://yearn.fi/yeth) diff --git a/docs/getting-started/products/addresses.md b/docs/getting-started/products/addresses.md deleted file mode 100644 index a48a9af4a3..0000000000 --- a/docs/getting-started/products/addresses.md +++ /dev/null @@ -1,256 +0,0 @@ -# Tokens & Contracts Addresses - -## Ethereum Tokens - -| Name | Address | -| ---------------------- | ------------------------------------------ | -| YFI | [0x0bc529c00c6401aef6d220be8c6ea1667f6ad93e](https://etherscan.io/token/0x0bc529c00c6401aef6d220be8c6ea1667f6ad93e) | -| Woofy | [0xd0660cd418a64a1d44e9214ad8e459324d8157f1](https://etherscan.io/token/0xd0660cd418a64a1d44e9214ad8e459324d8157f1) | - -## Fantom Tokens - -| Name | Address | -| ---------------------- | ------------------------------------------ | -| YFI | [0x29b0Da86e484E1C0029B56e817912d778aC0EC69](https://ftmscan.com/token/0x29b0Da86e484E1C0029B56e817912d778aC0EC69) | -| Woofy | [0xd0660cd418a64a1d44e9214ad8e459324d8157f1](https://ftmscan.com/token/0xd0660cd418a64a1d44e9214ad8e459324d8157f1) | - -## Polygon Tokens - -| Name | Address | -| ---------------------- | ------------------------------------------ | -| YFI | [0xda537104d6a5edd53c6fbba9a898708e465260b6](https://polygonscan.com/token/0xda537104d6a5edd53c6fbba9a898708e465260b6) | -| Woofy | [0xd0660cd418a64a1d44e9214ad8e459324d8157f1](https://polygonscan.com/token/0xd0660cd418a64a1d44e9214ad8e459324d8157f1) | - -## Ethereum Contracts - -| Identity | ENS | Address | -| ---------------------- | --------------------- | ------------------------------------------ | -| V2 Registry | v2.registry.ychad.eth | [0x50c1a2eA0a861A967D9d0FFE2AE4012c2E053804](https://etherscan.io/address/0x50c1a2eA0a861A967D9d0FFE2AE4012c2E053804) | -| Yearn multisig (daddy) | ychad.eth | [0xFEB4acf3df3cDEA7399794D0869ef76A6EfAff52](https://etherscan.io/address/0xFEB4acf3df3cDEA7399794D0869ef76A6EfAff52) | -| Strategist multisig | brain.ychad.eth | [0x16388463d60FFE0661Cf7F1f31a7D658aC790ff7](https://etherscan.io/address/0x16388463d60FFE0661Cf7F1f31a7D658aC790ff7) | -| Core Dev multisig | dev.ychad.eth | [0x846e211e8ba920B353FB717631C015cf04061Cc9](https://etherscan.io/address/0x846e211e8ba920B353FB717631C015cf04061Cc9) | -| Treasury | treasury.ychad.eth | [0x93A62dA5a14C80f265DAbC077fCEE437B1a0Efde](https://etherscan.io/address/0x93A62dA5a14C80f265DAbC077fCEE437B1a0Efde) | -| Health Check | health.ychad.eth | [0xDDCea799fF1699e98EDF118e0629A974Df7DF012](https://etherscan.io/address/0xDDCea799fF1699e98EDF118e0629A974Df7DF012) | -| V3 Registry | | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://etherscan.io/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af)| -| Role Manager | | [0xb3bd6B2E61753C311EFbCF0111f75D29706D9a41](https://etherscan.io/address/0xb3bd6B2E61753C311EFbCF0111f75D29706D9a41)| -| Debt Allocator Factory | | [0xfCF8c7C43dedd567083B422d6770F23B78D15BDe](https://etherscan.io/address/0xfCF8c7C43dedd567083B422d6770F23B78D15BDe)| -| Accountant | | [0x5A74Cb32D36f2f517DB6f7b0A0591e09b22cDE69](https://etherscan.io/address/0x5A74Cb32D36f2f517DB6f7b0A0591e09b22cDE69)| - -## Polygon Contracts - -| Identity | Address | -| ---------------------- | ------------------------------------------ | -| pChad Multisig | [0xC4ad0000E223E398DC329235e6C497Db5470B626](https://polygonscan.com/address/0xC4ad0000E223E398DC329235e6C497Db5470B626) | -| Strategist Multisig | [0x16388000546eDed4D476bd2A4A374B5a16125Bc1](https://polygonscan.com/address/0x16388000546eDed4D476bd2A4A374B5a16125Bc1) | -| V3 Registry | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://polygonscan.com/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af) | - -## Fantom Contracts - -| Identity | Address | -| ---------------------- | ------------------------------------------ | -| Registry | [0x727fe1759430df13655ddb0731dE0D0FDE929b04](https://ftmscan.com/address/0x727fe1759430df13655ddb0731dE0D0FDE929b04) | -| Strategist multisig | [0x72a34AbafAB09b15E7191822A679f28E067C4a16](https://ftmscan.com/address/0x72a34AbafAB09b15E7191822A679f28E067C4a16) | -| Governance multisig | [0xC0E2830724C946a6748dDFE09753613cd38f6767](https://ftmscan.com/address/0xC0E2830724C946a6748dDFE09753613cd38f6767) | -| Treasury | [0x89716ad7edc3be3b35695789c475f3e7a3deb12a](https://ftmscan.com/address/0x89716ad7edc3be3b35695789c475f3e7a3deb12a) | -| Health Check | [0xf13Cd6887C62B5beC145e30c38c4938c5E627fe0](https://ftmscan.com/address/0xf13Cd6887C62B5beC145e30c38c4938c5E627fe0) | - -## Arbitrum Contracts - -| Identity | Address | -| ---------------------- | ------------------------------------------ | -| Registry | [0x3199437193625DCcD6F9C9e98BDf93582200Eb1f](https://arbiscan.io/address/0x3199437193625DCcD6F9C9e98BDf93582200Eb1f) | -| Strategist multisig | [0x6346282DB8323A54E840c6C772B4399C9c655C0d](https://arbiscan.io/address/0x6346282DB8323A54E840c6C772B4399C9c655C0d) | -| Governance multisig | [0xb6bc033D34733329971B938fEf32faD7e98E56aD](https://arbiscan.io/address/0xb6bc033D34733329971B938fEf32faD7e98E56aD) | -| Treasury | [0x1DEb47dCC9a35AD454Bf7f0fCDb03c09792C08c1](https://arbiscan.io/address/0x1DEb47dCC9a35AD454Bf7f0fCDb03c09792C08c1) | -| Health Check | [0x32059ccE723b4DD15dD5cb2a5187f814e6c470bC](https://arbiscan.io/address/0x32059ccE723b4DD15dD5cb2a5187f814e6c470bC) | -| V3 Registry | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://polygonscan.com/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af) | - -## Optimism Contracts - -> Registry is made up of 2 contracts: "Release Registry" and "Vault Registry" - -| Identity | Address | -| ---------------------- | ------------------------------------------ | -| Release Registry | [0x81291ceb9bB265185A9D07b91B5b50Df94f005BF](https://optimistic.etherscan.io/address/0x81291ceb9bB265185A9D07b91B5b50Df94f005BF) | -| Vault Registry | [0x79286Dd38C9017E5423073bAc11F53357Fc5C128](https://optimistic.etherscan.io/address/0x79286Dd38C9017E5423073bAc11F53357Fc5C128) | -| Strategist multisig | [0xea3a15df68fCdBE44Fdb0DB675B2b3A14a148b26](https://optimistic.etherscan.io/address/0xea3a15df68fCdBE44Fdb0DB675B2b3A14a148b26) | -| Governance multisig | [0xF5d9D6133b698cE29567a90Ab35CfB874204B3A7](https://optimistic.etherscan.io/address/0xF5d9D6133b698cE29567a90Ab35CfB874204B3A7) | -| Treasury | [0x84654e35E504452769757AAe5a8C7C6599cBf954](https://optimistic.etherscan.io/address/0x84654e35E504452769757AAe5a8C7C6599cBf954) | -| Health Check | [0x3d8F58774611676fd196D26149C71a9142C45296](https://optimistic.etherscan.io/address/0x3d8F58774611676fd196D26149C71a9142C45296) | - -## V3 Contracts (stable across chains) - -| Identity | Address | -| ---------------------- | ------------------------------------------ | -| V3 Registry | [0xff31A1B020c868F6eA3f61Eb953344920EeCA3af](https://etherscan.io/address/0xff31A1B020c868F6eA3f61Eb953344920EeCA3af) | -| Release Registry | [0x990089173D5d5287c344092Be0bB37950A67d17B](https://etherscan.io/address/0x990089173D5d5287c344092Be0bB37950A67d17B) | -| Report Trigger | [0xD98C652f02E7B987e0C258a43BCa9999DF5078cF](https://etherscan.io/address/0xD98C652f02E7B987e0C258a43BCa9999DF5078cF) | -| APR Oracle | [0x27aD2fFc74F74Ed27e1C0A19F1858dD0963277aE](https://etherscan.io/address/0x27aD2fFc74F74Ed27e1C0A19F1858dD0963277aE) | -| 4626 Router | [0x1112dbCF805682e828606f74AB717abf4b4FD8DE](https://etherscan.io/address/0x1112dbCF805682e828606f74AB717abf4b4FD8DE) | -| Protocol Address Provider| [0x1e9778aAD41Aa3E0884C276fB4C2D03C4036Aa0B](https://etherscan.io/address/0x1e9778aAD41Aa3E0884C276fB4C2D03C4036Aa0B) | - -# Deployed Lens Contracts - -## Ethereum Lens Contracts - -### Oracle - -[0x83d95e0D5f402511dB06817Aff3f9eA88224B030](https://etherscan.io/address/0x83d95e0D5f402511dB06817Aff3f9eA88224B030) - Oracle - -### Management List - -[0xf64e58Ee8C7BadC741A7ea98FB65488084385674](https://etherscan.io/address/0xf64e58Ee8C7BadC741A7ea98FB65488084385674) - ManagementList - -### Registry Adapters - -[0x240315db938d44bb124ae619f5Fd0269A02d1271](https://etherscan.io/address/0x240315db938d44bb124ae619f5Fd0269A02d1271) - V2 -[0xFF0bd2d0C7E9424ccB149ED3757155eEf41a793D](https://etherscan.io/address/0xFF0bd2d0C7E9424ccB149ED3757155eEf41a793D)) - Iron Bank - -### TVL Adapters - -[0x14d6E0908baE40A2487352B2a9Cb1A6232DA8785](https://etherscan.io/address/0x14d6E0908baE40A2487352B2a9Cb1A6232DA8785) - V2 -[0xF4fB8903A41fC78686b26DE55502cdE42a4c6c78](https://etherscan.io/address/0xF4fB8903A41fC78686b26DE55502cdE42a4c6c78) - V1 -[0xec7Ac8AC897f5082B2c3d4e8D2173F992A097F24](https://etherscan.io/address/0xec7Ac8AC897f5082B2c3d4e8D2173F992A097F24) - Iron Bank -[0x1007eD6fdFAC72bbea9c719cf1Fa9C355D248691](https://etherscan.io/address/0x1007eD6fdFAC72bbea9c719cf1Fa9C355D248691) - Earn -[0x560144C25E53149aC410E5D33BDB131e49A850e5](https://etherscan.io/address/0x560144C25E53149aC410E5D33BDB131e49A850e5) - veCRV - -### Helpers - -[0x5AACD0D03096039aC4381CD814637e9FB7C34a6f](https://etherscan.io/address/0x5AACD0D03096039aC4381CD814637e9FB7C34a6f) - Helper -[0xC3A0bEF4A47bA579Cbba510aE2c59d9b9bf9467C](https://etherscan.io/address/0xC3A0bEF4A47bA579Cbba510aE2c59d9b9bf9467C) - UniqueAddressesHelper -[0xae813841436fe29b95a14ac701afb1502c4cb789](https://etherscan.io/address/0xae813841436fe29b95a14ac701afb1502c4cb789) - Strategies helper -[0x4218E20DB87023049Fc582Aaa4bD47a3611A20Ab](https://etherscan.io/address/0x4218E20DB87023049Fc582Aaa4bD47a3611A20Ab) - AllowancesHelper -[0x957e3ae7983155a9f9e08da555b8084448be26e4](https://etherscan.io/address/0x957e3ae7983155a9f9e08da555b8084448be26e4) - AddressMergeHelper -[0x5d63a8584d91ebc5033d022afd6c5a7c7fddc99b](https://etherscan.io/address/0x5d63a8584d91ebc5033d022afd6c5a7c7fddc99b) - PricesHelper -[0x855ffe28019106d089bC018Df18838f8d241c402](https://etherscan.io/address/0x855ffe28019106d089bC018Df18838f8d241c402) - BalancesHelper - -### Generators - -[0xce29d34C8e88A2E1eDde10AD4eEE4f3e379fc041](https://etherscan.io/address/0xce29d34C8e88A2E1eDde10AD4eEE4f3e379fc041) - AddressesGeneratorV1Vaults -[0x437758D475F70249e03EDa6bE23684aD1FC375F0](https://etherscan.io/address/0x437758D475F70249e03EDa6bE23684aD1FC375F0) - AddressesGeneratorV2Vaults -[0xF536399c04683D7ab0BCb1308C245b4bbb539344](https://etherscan.io/address/0xF536399c04683D7ab0BCb1308C245b4bbb539344) - AddressesGeneratorEarn -[0xa0B57619A980DFEfD50f24F310EE1b55A40A9D46](https://etherscan.io/address/0xa0B57619A980DFEfD50f24F310EE1b55A40A9D46) - AddressesGeneratorIronBank - -### Delegation mapping - -[0xC01a529c01f9399c928a4aFc50E25f12D1e5b142](https://etherscan.io/address/0xC01a529c01f9399c928a4aFc50E25f12D1e5b142) - DelegatedBalanceMapping - -### Calculations - -[0xE9cfF16bdac9729F18CBAC451EcCA6c50b372207](https://etherscan.io/address/0xE9cfF16bdac9729F18CBAC451EcCA6c50b372207) - CalculationsCurve -[0x55e9B18fefFF7E00548d54480373Fc8843De8eA4](https://etherscan.io/address/0x55e9B18fefFF7E00548d54480373Fc8843De8eA4) - CalculationsIronBank -[0x88dE7d7F7b9597C86b8cD195374FbF602934F334](https://etherscan.io/address/0x88dE7d7F7b9597C86b8cD195374FbF602934F334) - CalculationsSushiswap -[0x38477F2159638956d33E18951d98238a53b9aa3C](https://etherscan.io/address/0x38477F2159638956d33E18951d98238a53b9aa3C) - CalculationsYearnVaults - -### Registries - -[0x62a4e0E7574E5407656A65CC8DbDf70f3C6EB04B](https://etherscan.io/address/0x62a4e0E7574E5407656A65CC8DbDf70f3C6EB04B) - Earn (new) -[0x50c1a2eA0a861A967D9d0FFE2AE4012c2E053804](https://etherscan.io/address/0x50c1a2eA0a861A967D9d0FFE2AE4012c2E053804) - V2 (existing) -[0x3eE41C098f9666ed2eA246f4D2558010e59d63A0](https://etherscan.io/address/0x3eE41C098f9666ed2eA246f4D2558010e59d63A0) - V1 (existing) -[0xAB1c342C7bf5Ec5F02ADEA1c2270670bCa144CbB](https://etherscan.io/address/0xAB1c342C7bf5Ec5F02ADEA1c2270670bCa144CbB) - IB (existing) - -## Fantom Lens Contracts - -[0xac5A9E4135A3A26497F3890bFb602b06Ee592B61](https://ftmscan.com/address/0xac5A9E4135A3A26497F3890bFb602b06Ee592B61) - AddressesProvider - -### Oracle - -[0x57AA88A0810dfe3f9b71a9b179Dd8bF5F956C46A](https://ftmscan.com/address/0x57AA88A0810dfe3f9b71a9b179Dd8bF5F956C46A) - Oracle - -### Management List - -[0x5EA7E501c9A23F4A76Dc7D33a11D995B13a1dD25](https://ftmscan.com/address/0x5EA7E501c9A23F4A76Dc7D33a11D995B13a1dD25) - ManagementList - -### Registry Adapters - -[0xF628Fb7436fFC382e2af8E63DD7ccbaa142E3cd1](https://ftmscan.com/address/0xF628Fb7436fFC382e2af8E63DD7ccbaa142E3cd1) - RegisteryAdapterV2Vault -[0x1164587b49ff7aCE303962cC7A7E0841C1b34986](https://ftmscan.com/address/0x1164587b49ff7aCE303962cC7A7E0841C1b34986) - RegistryAdapterIronBank - -### Helpers - -[0xE55Dd55b3355c261A048B3f310706C7478657d74](https://ftmscan.com/address/0xE55Dd55b3355c261A048B3f310706C7478657d74) - Helper -[0x14785E5E3650F0603eE17401c9890De380713914](https://ftmscan.com/address/0x14785E5E3650F0603eE17401c9890De380713914) - HelperAllowances -[0x6B8DE08D2520C955554E837aE72022Cd46Ba7F0e](https://ftmscan.com/address/0x6B8DE08D2520C955554E837aE72022Cd46Ba7F0e) - HelperBalances -[0x001d0a58B336F60ee050cB11EE455Fd7eB984518](https://ftmscan.com/address/0x001d0a58B336F60ee050cB11EE455Fd7eB984518) - HelperAddressesMerger -[0x97D0bE2a72fc4Db90eD9Dbc2Ea7F03B4968f6938](https://ftmscan.com/address/0x97D0bE2a72fc4Db90eD9Dbc2Ea7F03B4968f6938) - HelperStrategies - -### Calculations - -[0x0b53e9df372e72d8fdCDBEDfbb56059957a37128](https://ftmscan.com/address/0x0b53e9df372e72d8fdCDBEDfbb56059957a37128) - CalculationsCurve -[0x44536dE2220987d098d1d29D3AAfc7f7348E9ee4](https://ftmscan.com/address/0x44536dE2220987d098d1d29D3AAfc7f7348E9ee4) - CalculationsSpooky -[0x560144C25E53149aC410E5D33BDB131e49A850e5](https://ftmscan.com/address/0x560144C25E53149aC410E5D33BDB131e49A850e5) - CalculationsSushiswap -[0xebAA0B431618bCd9eA67D39C232625c20880d9bA](https://ftmscan.com/address/0xebAA0B431618bCd9eA67D39C232625c20880d9bA) - CalculationsBand - -### Registries - -[0x727fe1759430df13655ddb0731dE0D0FDE929b04](https://ftmscan.com/address/0x727fe1759430df13655ddb0731dE0D0FDE929b04) - Registry -[0x7f462B92F92114A2D57A03e5Ae2DB5DA28b77d73](https://ftmscan.com/address/0x7f462B92F92114A2D57A03e5Ae2DB5DA28b77d73) - Mechanics Registry -[0x8CC45f739104b3Bdb98BFfFaF2423cC0f817ccc1](https://ftmscan.com/address/0x8CC45f739104b3Bdb98BFfFaF2423cC0f817ccc1) - VaultsRegistryHelper - -## Arbitrum Lens Contracts - -[0xcAd10033C86B0C1ED6bfcCAa2FF6779938558E9f](https://arbiscan.io/address/0xcAd10033C86B0C1ED6bfcCAa2FF6779938558E9f) - Addresses Provider - -### Oracle - -[0x043518AB266485dC085a1DB095B8d9C2Fc78E9b9](https://arbiscan.io/address/0x043518AB266485dC085a1DB095B8d9C2Fc78E9b9) - Oracle -[0xdF43263DFec19117f2Fe79d1D9842a10c7495CcD](https://arbiscan.io/address/0xdF43263DFec19117f2Fe79d1D9842a10c7495CcD) - Base Fee Oracle Contract - -### Management List - -[0x8A5f0876b217ee61d101E022Bb00d032e6D353bc](https://arbiscan.io/address/0x8A5f0876b217ee61d101E022Bb00d032e6D353bc) - ManagementList - -### Registry Adapters - -[0x57AA88A0810dfe3f9b71a9b179Dd8bF5F956C46A](https://arbiscan.io/address/0x57AA88A0810dfe3f9b71a9b179Dd8bF5F956C46A) - RegistryAdapterV2Vault -[0x7AAd416eB4e16a27b85e7076dD56742A44E9d25B](https://arbiscan.io/address/0x7AAd416eB4e16a27b85e7076dD56742A44E9d25B) - RegistryAdapterIronBank - -### Helpers - -[0xE55Dd55b3355c261A048B3f310706C7478657d74](https://arbiscan.io/address/0xE55Dd55b3355c261A048B3f310706C7478657d74) - Helper -[0xf5875d60241C8F6448649206A6f485b812ACF44D](https://arbiscan.io/address/0xf5875d60241C8F6448649206A6f485b812ACF44D) - AllowancesHelper -[0x94734Ba0f9f8c2464d963a402743Fd79B402Efd7](https://arbiscan.io/address/0x94734Ba0f9f8c2464d963a402743Fd79B402Efd7) - BalancesHelper -[0x2A139A2812f1424F0C88e3d73854b16fb04E9449](https://arbiscan.io/address/0x2A139A2812f1424F0C88e3d73854b16fb04E9449) - AddressMergeHelper -[0x66a1A27f4b22DcAa24e427DCFFbf0cdDd9D35e0f](https://arbiscan.io/address/0x66a1A27f4b22DcAa24e427DCFFbf0cdDd9D35e0f) - StrategiesHelper - -### Generators - -[0x3A8efa2D87d60c0289f19B44A0928F4269c0f094](https://arbiscan.io/address/0x3A8efa2D87d60c0289f19B44A0928F4269c0f094) - AddressesGeneratorV2Vaults - -### Calculations - -[0x5EA7E501c9A23F4A76Dc7D33a11D995B13a1dD25](https://arbiscan.io/address/0x5EA7E501c9A23F4A76Dc7D33a11D995B13a1dD25) - CalculationsSushiswap - -## Optimism Lens Contracts - -[0x8273217252254Ad7353f227aaEcd2b1C4A326Fa2](https://optimistic.etherscan.io/address/0x8273217252254Ad7353f227aaEcd2b1C4A326Fa2) - Addresses Provider - -### Oracle - -[0xB082d9f4734c535D9d80536F7E87a6f4F471bF65](https://optimistic.etherscan.io/address/0xB082d9f4734c535D9d80536F7E87a6f4F471bF65) - Oracle - -### Management List - -[0x7E9756E1427B3c38F001F9D272D8d62BEF63D619](https://optimistic.etherscan.io/address/0x7E9756E1427B3c38F001F9D272D8d62BEF63D619) - Management List - -### Registry Adapters - -[0xBcfCA75fF12E2C1bB404c2C216DBF901BE047690](https://optimistic.etherscan.io/address/0xBcfCA75fF12E2C1bB404c2C216DBF901BE047690) - RegistryAdapterV2Vault - -### Helpers - -[0x776C1E69B858f1B9622085052Fb7B64a196Ac602](https://optimistic.etherscan.io/address/0x776C1E69B858f1B9622085052Fb7B64a196Ac602) - Helper -[0x94141D7BFf3D04D61CE65B917BDd37b655e08f18](https://optimistic.etherscan.io/address/0x94141D7BFf3D04D61CE65B917BDd37b655e08f18) - AllowancesHelper -[0x167aA4Ba31B8285707d1489ad705cb24CF4E5186](https://optimistic.etherscan.io/address/0x167aA4Ba31B8285707d1489ad705cb24CF4E5186) - BalancesHelper -[0xD3A93C794ee2798D8f7906493Cd3c2A835aa0074](https://optimistic.etherscan.io/address/0xD3A93C794ee2798D8f7906493Cd3c2A835aa0074) - StrategiesHelper -[0x156bAB355E81b498072C9Ce3cF655e9844A12529](https://optimistic.etherscan.io/address/0x156bAB355E81b498072C9Ce3cF655e9844A12529) - AddressMergeHelper - -### Generators - -[0xD63aB09ac2048a7eCac92f0fFad5F104edD0E032](https://optimistic.etherscan.io/address/0xD63aB09ac2048a7eCac92f0fFad5F104edD0E032) - Vault v2 Addresses Generator - -### Calculations - -[0x5FD3815DcB668200A662114fbC9aF13AC0A55b4D](https://optimistic.etherscan.io/address/0x5FD3815DcB668200A662114fbC9aF13AC0A55b4D) - Chainlink Calculations -[0x0Ffe8434eAe67C9838b12C3cd11ac4005DAa7227](https://optimistic.etherscan.io/address/0x0Ffe8434eAe67C9838b12C3cd11ac4005DAa7227) - Curve Calculations -[0x0000000022D53366457F9d5E68Ec105046FC4383](https://optimistic.etherscan.io/address/0x0000000022D53366457F9d5E68Ec105046FC4383) - Curve Registry Address Provider diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index 06e94d9a7e..fe6de549d4 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -33,31 +33,9 @@ ___ ## Links -- [yCRV UI](https://ycrv.yearn.fi) -- [UI Source Code](https://github.com/MarcoWorms/ylockers-ui-ycrv) -- [Yearn Boosted Staker Source Code](https://github.com/yearn/yearn-boosted-staker) -- [crvhub.com - Liquid Lockers Tracker](https://crvhub.com/wrappers) -- [yLockers Discord Channel](https://discord.com/channels/734804446353031319/1186417376275730552) - -## yCRV Deployment Addresses - -### Current Addresses - -| Contract Name | Contract Address | -|---------------|-----------------| -| yCRV Boosted Staker | [0xE9A115b77A1057C918F997c32663FdcE24FB873f](https://etherscan.io/address/0xE9A115b77A1057C918F997c32663FdcE24FB873f#code) | -| Rewards Distributor | [0xB226c52EB411326CdB54824a88aBaFDAAfF16D3d](https://etherscan.io/address/0xB226c52EB411326CdB54824a88aBaFDAAfF16D3d#code) | -| Boosted Staker Utilities | [0x265c8D21A322B04804524b857089De2fEF619569](https://etherscan.io/address/0x265c8D21A322B04804524b857089De2fEF619569#code) | -| yvyCRV (Auto-Compounter Vault) | [0x27B5739e22ad9033bcBf192059122d163b60349D](https://etherscan.io/address/0x27B5739e22ad9033bcBf192059122d163b60349D#code) | -| yvcrvUSD (crvUSD Vault) | [0xBF319dDC2Edc1Eb6FDf9910E39b37Be221C8805F](https://etherscan.io/address/0xBF319dDC2Edc1Eb6FDf9910E39b37Be221C8805F#code) | -| lp-yCRV v2 (vault) | [0x6E9455D109202b426169F0d8f01A3332DAE160f3](https://etherscan.io/address/0x6E9455D109202b426169F0d8f01A3332DAE160f3#code) | -| CRV Token | [0xD533a949740bb3306d119CC777fa900bA034cd52](https://etherscan.io/address/0xD533a949740bb3306d119CC777fa900bA034cd52#code) | -| yCRV Token | [0xFCc5c47bE19d06BF83eB04298b026F81069ff65b](https://etherscan.io/address/0xFCc5c47bE19d06BF83eB04298b026F81069ff65b#code) | - -### Expired/Deprecated Addresses - -| Contract Name | Contract Address | -|---------------|-----------------| -| lp-yCRV v1 (DEPRECATED) | [0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e](https://etherscan.io/address/0xc97232527B62eFb0D8ed38CF3EA103A6CcA4037e#code) | -| old CRV/yCRV Curve Pool (DEPRECATED) | [0x453D92C7d4263201C69aACfaf589Ed14202d83a4](https://etherscan.io/address/0x453D92C7d4263201C69aACfaf589Ed14202d83a4#code) | -| ZapYCRV.vy | [0x01D7f32B6E463c96c00575fA97B8224326C6A6B9](https://etherscan.io/address/0x01D7f32B6E463c96c00575fA97B8224326C6A6B9#code) | +[Contract Addresses](/developers/addresses/ycrv-contracts) +[yCRV UI](https://ycrv.yearn.fi) +[UI Source Code](https://github.com/yearn/ylockers-ui-ycrv) +[Yearn Boosted Staker Source Code](https://github.com/yearn/yearn-boosted-staker) +[crvhub.com - Liquid Lockers Tracker](https://crvhub.com/wrappers) +[yLockers Discord Channel](https://discord.com/channels/734804446353031319/1186417376275730552) diff --git a/docs/getting-started/products/ylockers/yprisma/overview.md b/docs/getting-started/products/ylockers/yprisma/overview.md index 61dcf7b5c8..17982e17a8 100644 --- a/docs/getting-started/products/ylockers/yprisma/overview.md +++ b/docs/getting-started/products/ylockers/yprisma/overview.md @@ -22,41 +22,15 @@ Yearn has 2 ways to earn yield on your yPRISMA; depositing to the `YearnBoostedS ## Links -- [yPRISMA UI](https://yprisma.yearn.fi/) -- [UI Source Code](https://github.com/MarcoWorms/ylockers-ui) -- [Yearn Boosted Staker Source Code](https://github.com/yearn/yearn-boosted-staker) -- [PRISMA.lol - Liquid Lockers Tracker](https://www.prisma.lol/) -- [yLockers Discord Channel](https://discord.com/channels/734804446353031319/1186417376275730552) - -## Addresses - -### Core Protocol - -| Name | Address | -|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| -| YearnBoostedStaker | [0xF4C6e0E006F164535508787873d86b84fe901975](https://etherscan.io/address/0xF4C6e0E006F164535508787873d86b84fe901975) | -| Rewards Distributor | [0xc480b481dD194EAc469EC9c4484D23d54B868EDD](https://etherscan.io/address/0xc480b481dD194EAc469EC9c4484D23d54B868EDD) | -| yPRISMA Fee Receiver | [0x76DF88Aa8711822472Cb40Ed8c972A461A20ecdc](https://etherscan.io/address/0x76DF88Aa8711822472Cb40Ed8c972A461A20ecdc) | -| Boosted Staker Utilities | [0xf04037D102b64E365eF6Eb81937bDf59B31fE5B8](https://etherscan.io/address/0xf04037D102b64E365eF6Eb81937bDf59B31fE5B8) | -| PRISMA | [0xdA47862a83dac0c112BA89c6abC2159b95afd71C](https://etherscan.io/address/0xdA47862a83dac0c112BA89c6abC2159b95afd71C) | -| yPRISMA | [0xe3668873d944e4a949da05fc8bde419eff543882](https://etherscan.io/address/0xe3668873d944e4a949da05fc8bde419eff543882) | -| yvyPRISMA Vault/Token | [0x10537D7bD661C9c34F547b38EC662D6FD482Ae95](https://etherscan.io/address/0x10537D7bD661C9c34F547b38EC662D6FD482Ae95) | -| yvmkUSD-A Vault/Token | [0x04AeBe2e4301CdF5E9c57B01eBdfe4Ac4B48DD13](https://etherscan.io/address/0x04AeBe2e4301CdF5E9c57B01eBdfe4Ac4B48DD13) | - -### Expired Farms and Contracts - -| Name | Address | -|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| -| *legacy yPRISMA | [0xfd37356c1a62288b32Fa58188c77Ab0D694a0f4E](https://etherscan.io/address/0xfd37356c1a62288b32Fa58188c77Ab0D694a0f4E) | -| *yPRISMA Staking (yvmkUSD-A rewards) | [0xE3EE395C9067dD15C492Ca950B101a7d6c85b5Fc](https://etherscan.io/address/0xE3EE395C9067dD15C492Ca950B101a7d6c85b5Fc) | -| *yPRISMA Staking (wstETH rewards) | [0x774a55C3Eeb79929fD445Ae97191228Ab39c4d0f](https://etherscan.io/address/0x774a55C3Eeb79929fD445Ae97191228Ab39c4d0f) | -| *yPRISMA Staking (dYFI rewards) | [0x93283184650f4d3B4253ABd00978176732118428](https://etherscan.io/address/0x93283184650f4d3B4253ABd00978176732118428) | -| *yPRISMA LP Staking (yPRISMA rewards) | [0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246](https://etherscan.io/address/0x6806D62AAdF2Ee97cd4BCE46BF5fCD89766EF246) | -| *yCRV Staking (yPRISMA rewards) | [0x84c94d739e075b3C7431bdb1A005F0412DF828a5](https://etherscan.io/address/0x84c94d739e075b3C7431bdb1A005F0412DF828a5) | -**expired* +[Contract Addresses](/developers/addresses/yprisma-contracts) +[yPRISMA UI](https://yprisma.yearn.fi/) +[UI Source Code](https://github.com/yearn/ylockers-ui) +[Yearn Boosted Staker Source Code](https://github.com/yearn/yearn-boosted-staker) +[PRISMA.lol - Liquid Lockers Tracker](https://www.prisma.lol/) +[yLockers Discord Channel](https://discord.com/channels/734804446353031319/1186417376275730552) ## Read More -- [Upcoming yPRISMA YBS Staking Launch: All You Need to Know](https://blog.yearn.fi/ybs-yprisma-launch) -- [yPRISMA Roadmap](https://medium.com/iearn/yprisma-roadmap-8fb3e2376594) -- [Introduction to Yearn PRISMA Incentives Farming and FAQ](https://docs.yearn.finance/getting-started/products/ylockers/yprisma/farming) +[Upcoming yPRISMA YBS Staking Launch: All You Need to Know](https://blog.yearn.fi/ybs-yprisma-launch) +[yPRISMA Roadmap](https://medium.com/iearn/yprisma-roadmap-8fb3e2376594) +[Introduction to Yearn PRISMA Incentives Farming and FAQ](/getting-started/products/ylockers/yprisma/yprisma-faq) diff --git a/docs/getting-started/products/yeth/overview.md b/docs/getting-started/products/ypools/yeth/overview.md similarity index 87% rename from docs/getting-started/products/yeth/overview.md rename to docs/getting-started/products/ypools/yeth/overview.md index f581650804..d276361339 100644 --- a/docs/getting-started/products/yeth/overview.md +++ b/docs/getting-started/products/ypools/yeth/overview.md @@ -1,6 +1,4 @@ -# Overview - -## yETH +# yETH yETH is a user-governed liquidity pool token consisting of various Ethereum Liquid Staking Derivatives (LSTs). @@ -145,35 +143,3 @@ Trusted addresses with emergency privileges: ## Protocol Specs - The yETH specification can be found in the source repo: https://github.com/yearn/yETH/blob/main/SPECIFICATION.md - -## Frequently Asked Questions - -### How does yETH earn APY? - -yETH earns APY through various sources: - -- Swap fee income from the Automated Market Maker (AMM) -- Incentives fee income, which are incentives for staker participation in governance -- Liquid Staking Derivative (LSD) income from staked ETH yield -- Buying LSTs at a discount -- Whitelisting fees - -However, there are also deductions such as Beacon Chain slashings and a 10% Yearn performance fee on profits. - -Please note that yield is paid out one week after it is generated. The yield generated in week N is streamed out in week N+1. - -### What other benefits does yETH give holders? - -yETH provides diversification by holding a basket of LSDs, which helps to spread the risk. - -### How is yield passed onto stakers? - -LSD Protocols generate yield and update their on-chain rates. This results in yETH being minted and sent to st-yETH. - -### Can I withdraw multiple LSDs? - -Yes, you can withdraw multiple LSDs or just one LSD. However, your withdrawal cannot cause an LSD to leave its safety bands around its target weight. For example, if a pool has a weight of 20% and a band of 5%, the actual weight is allowed to be between 15% and 25%. This caps losses to at most 25%, assuming that token permanently depegs and goes to 0. In that worst-case scenario, yETH depegs to 0.75 ETH, because you can always do a balanced withdrawal of all the assets, of which only 25% is worthless. Compare this with holding the token by yourself, you’d be -100%. - -### Is there slippage with proportional withdrawal? - -No, there is no slippage with proportional withdrawal. diff --git a/docs/getting-started/products/ypools/yeth/yeth-faq.md b/docs/getting-started/products/ypools/yeth/yeth-faq.md new file mode 100644 index 0000000000..e6f41e965b --- /dev/null +++ b/docs/getting-started/products/ypools/yeth/yeth-faq.md @@ -0,0 +1,31 @@ +# Frequently Asked Questions + +### How does yETH earn APY? + +yETH earns APY through various sources: + +- Swap fee income from the Automated Market Maker (AMM) +- Incentives fee income, which are incentives for staker participation in governance +- Liquid Staking Derivative (LSD) income from staked ETH yield +- Buying LSTs at a discount +- Whitelisting fees + +However, there are also deductions such as Beacon Chain slashings and a 10% Yearn performance fee on profits. + +Please note that yield is paid out one week after it is generated. The yield generated in week N is streamed out in week N+1. + +### What other benefits does yETH give holders? + +yETH provides diversification by holding a basket of LSDs, which helps to spread the risk. + +### How is yield passed onto stakers? + +LSD Protocols generate yield and update their on-chain rates. This results in yETH being minted and sent to st-yETH. + +### Can I withdraw multiple LSDs? + +Yes, you can withdraw multiple LSDs or just one LSD. However, your withdrawal cannot cause an LSD to leave its safety bands around its target weight. For example, if a pool has a weight of 20% and a band of 5%, the actual weight is allowed to be between 15% and 25%. This caps losses to at most 25%, assuming that token permanently depegs and goes to 0. In that worst-case scenario, yETH depegs to 0.75 ETH, because you can always do a balanced withdrawal of all the assets, of which only 25% is worthless. Compare this with holding the token by yourself, you’d be -100%. + +### Is there slippage with proportional withdrawal? + +No, there is no slippage with proportional withdrawal. diff --git a/docs/getting-started/products/yvaults/overview.md b/docs/getting-started/products/yvaults/overview.md index edbe133601..e41f310576 100644 --- a/docs/getting-started/products/yvaults/overview.md +++ b/docs/getting-started/products/yvaults/overview.md @@ -1,7 +1,5 @@ # Overview -  - ## What are yVaults? [yVaults](https://yearn.fi/vaults) are like savings accounts for your crypto assets. They accept your deposit, then route it through strategies which seek out the highest yield available in DeFi. @@ -10,7 +8,7 @@ ## yVault Fee Structure -**Performance Fee**: Deducted from yield earned every time a vault harvests a strategy. +**Performance Fee**: Deducted from yield earned every time a vault harvests a strategy. **Management Fee**: Flat rate taken from vault deposits over a year. The fee is extracted by minting new shares of the vault, thereby diluting vault participants. This is done at the time of harvest, and calculated based on time since the previous harvest. diff --git a/docs/getting-started/yearn-principles.md b/docs/getting-started/yearn-principles.md new file mode 100644 index 0000000000..4535934021 --- /dev/null +++ b/docs/getting-started/yearn-principles.md @@ -0,0 +1,34 @@ +import PrinciplesCard from '@site/src/components/PrinciplesCard'; +import yearnPrinciples from "@site/src/yearnPrinciples"; + +# Yearn Principles + +## Trust + + + +## Autonomy + + + +## Respect + + + +## Creativity + + + +## Meritocracy + + + +## Chaos + + + +## Community + + + +Adapted with ❤️ from https://yearn.love/ diff --git a/docs/getting-started/products/ybribe/faq.md b/docs/resources/deprecated/ybribe/faq.txt similarity index 100% rename from docs/getting-started/products/ybribe/faq.md rename to docs/resources/deprecated/ybribe/faq.txt diff --git a/docs/getting-started/products/ybribe/guide.md b/docs/resources/deprecated/ybribe/guide.txt similarity index 100% rename from docs/getting-started/products/ybribe/guide.md rename to docs/resources/deprecated/ybribe/guide.txt diff --git a/docs/getting-started/products/ybribe/overview.md b/docs/resources/deprecated/ybribe/ybribe.md similarity index 92% rename from docs/getting-started/products/ybribe/overview.md rename to docs/resources/deprecated/ybribe/ybribe.md index 922a673b6b..9e45433411 100644 --- a/docs/getting-started/products/ybribe/overview.md +++ b/docs/resources/deprecated/ybribe/ybribe.md @@ -1,11 +1,8 @@ -# Overview - - -## What is yBribe? +# yBribe [yBribe](https://ybribe.com) is a platform where vote-escrowed Curve (veCRV) holders can receive compensation from buyers interested in increasing CRV emissions to their Curve pool’s gauge. -In DeFi, incentives for voting are commonly referred to as ‘bribes’. yBribe enables veCRV holders — be they protocols, DAOs, or individual users, to extract the value of their voting power. +In DeFi, incentives for voting are commonly referred to as ‘bribes’. yBribe enables veCRV holders — be they protocols, DAOs, or individual users, to extract the value of their voting power. ![](https://i.imgur.com/WedS2iP.png) @@ -13,7 +10,7 @@ In DeFi, incentives for voting are commonly referred to as ‘bribes’. yBribe Curve conducts weekly gauge votes that determine the allocation of CRV rewards to various pools. By buying votes, DAOs, protocols, and users can influence the direction of these rewards while boosting yields in pools beneficial to them. To do this, use the ‘Offer Bribe’ function on yBribe. Once the bribe is posted, voters will see the pending APR for that gauge increase. -veCRV holders can sell their gauge votes to the highest bidder each week by voting on the bribed gauge with the highest APR. +veCRV holders can sell their gauge votes to the highest bidder each week by voting on the bribed gauge with the highest APR. ## Why yBribe diff --git a/docusaurus.config.js b/docusaurus.config.js index f2f43f6eee..01f3a73ef9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -76,7 +76,7 @@ export default { activeBasePath: '/developers', }, { - to: 'contributing/contribute', + to: 'contributing/introduction', label: 'DAO Docs', activeBasePath: '/contributing', }, diff --git a/sidebars/sidebarsContributing.js b/sidebars/sidebarsContributing.js index c0949a85b8..cc968802cf 100644 --- a/sidebars/sidebarsContributing.js +++ b/sidebars/sidebarsContributing.js @@ -1,5 +1,6 @@ module.exports = { mySidebar: [ + 'introduction', 'contribute', 'contributor-tools', { diff --git a/sidebars/sidebarsResources.js b/sidebars/sidebarsResources.js index 123a469bf0..f028106414 100644 --- a/sidebars/sidebarsResources.js +++ b/sidebars/sidebarsResources.js @@ -1,7 +1,7 @@ module.exports = { mySidebar: [ - 'faq', - 'links', + // 'faq', + // 'links', { type: 'category', label: 'Deprecated Projects', @@ -12,11 +12,11 @@ module.exports = { }, items: [{ type: 'autogenerated', dirName: 'deprecated' }], }, - { - type: 'link', - href: 'https://github.com/yearn/budget/issues', - label: 'Budget Requests', - }, - 'defi-glossary', + // { + // type: 'link', + // href: 'https://github.com/yearn/budget/issues', + // label: 'Budget Requests', + // }, + // 'defi-glossary', ], } diff --git a/sidebars/sidebarsUserDocs.js b/sidebars/sidebarsUserDocs.js index 71f51d5a62..1f58508306 100644 --- a/sidebars/sidebarsUserDocs.js +++ b/sidebars/sidebarsUserDocs.js @@ -1,66 +1,131 @@ module.exports = { userDocsSidebar: [ - 'intro', { type: 'category', - label: 'Products', - collapsed: false, + label: 'Yearn Products', + link: { + type: 'doc', + id: 'intro', + }, items: [ { type: 'category', label: 'yVaults', + link: { + type: 'doc', + id: 'products/yvaults/overview', + }, items: [ - 'products/yvaults/overview', - 'products/yvaults/vault-tokens', { type: 'category', - label: 'yVaults Version 3', - items: ['products/yvaults/v3'], + label: 'yVaults v3', + items: [ + 'products/yvaults/v3', + { + type: 'link', + label: 'v3 Vaults dApp', + href: 'https://yearn.fi/v3', + }, + ], }, { type: 'category', - label: 'yVaults Version 2', - items: ['products/yvaults/vault-factory'], + label: 'yVaults v2', + items: [ + 'products/yvaults/vault-factory', + { + type: 'link', + label: 'v2 Vaults dApp', + href: 'https://yearn.fi/vaults', + }, + ], + }, + 'products/yvaults/vault-tokens', + { + type: 'link', + label: 'yVaults Dev Docs →', + href: '/developers/v1/introduction', }, ], }, { type: 'category', label: 'yLockers', + link: { + type: 'doc', + id: 'products/ylockers/overview', + }, items: [ - 'products/ylockers/overview', { type: 'category', label: 'yCRV', + link: { + type: 'doc', + id: 'products/ylockers/ycrv/overview', + }, items: [ - 'products/ylockers/ycrv/overview', 'products/ylockers/ycrv/ycrv-guide', 'products/ylockers/ycrv/ycrv-faq', + { + type: 'link', + label: 'yCRV Contract Addresses →', + href: '/developers/addresses/ycrv-contracts', + }, + { + type: 'link', + label: 'yCRV dApp', + href: 'https://ycrv.yearn.fi/', + }, ], }, { type: 'category', label: 'yPRISMA', + link: { + type: 'doc', + id: 'products/ylockers/yprisma/overview', + }, items: [ - 'products/ylockers/yprisma/overview', 'products/ylockers/yprisma/yprisma-guide', 'products/ylockers/yprisma/yprisma-faq', + { + type: 'link', + label: 'yPRISMA Contract Addresses →', + href: '/developers/addresses/yprisma-contracts', + }, + { + type: 'link', + label: 'yPRISMA dApp', + href: 'https://yprisma.yearn.fi/', + }, ], }, ], }, { type: 'category', - label: 'yETH', - items: ['products/yeth/overview'], - }, - { - type: 'category', - label: 'yBribe', + label: 'yPools', items: [ - 'products/ybribe/overview', - 'products/ybribe/guide', - 'products/ybribe/faq', + { + type: 'category', + label: 'yETH', + link: { + type: 'doc', + id: 'products/ypools/yeth/overview', + }, + items: [ + { + type: 'doc', + id: 'products/ypools/yeth/yeth-faq', + label: 'yETH FAQ', + }, + { + type: 'link', + label: 'yETH dApp', + href: 'https://yeth.yearn.fi/', + }, + ], + }, ], }, { @@ -68,13 +133,39 @@ module.exports = { label: 'veYFI →', href: '/contributing/governance/veyfi-intro', }, + ], + }, + { + type: 'html', + value: '
', + className: 'divider', + }, + { + type: 'category', + label: 'About Yearn', + // link: { + // type: 'doc', + // id: 'intro', + // }, + items: [ + 'yearn-principles', + { + type: 'link', + label: 'The Blue Pill', + href: 'https://yfistory.org/thebluepill', + }, { type: 'link', - label: 'Deprecated Projects →', - href: '/resources/deprecated', + label: 'DAO Docs →', + href: '/contributing/introduction', }, ], }, + { + type: 'html', + value: '
', + className: 'divider', + }, { type: 'category', label: 'Guides', @@ -109,5 +200,10 @@ module.exports = { href: '/developers/smart-contracts/', }, { type: 'link', label: 'Security →', href: '/developers/security' }, + { + type: 'link', + label: 'Deprecated Projects →', + href: '/resources/deprecated', + }, ], } diff --git a/src/components/PrinciplesCard.js b/src/components/PrinciplesCard.js new file mode 100644 index 0000000000..f80a8c5913 --- /dev/null +++ b/src/components/PrinciplesCard.js @@ -0,0 +1,34 @@ +import React from 'react' +import styles from '../css/principles.module.css' + +export default function PrinciplesCard({ cardData }) { + return ( +
+
+

{cardData.title}

+

{cardData.description}

+
+ {cardData.alt} +
+ ) +} + +// export default function PrinciplesCards({ cardsData }) { +// return ( +//
+// {cardsData.map( +// ({ title, titleColor, description, image, alt }, index) => ( +//
+//
+//

{title}

+//

{description}

+//
+//
+// {alt} +//
+//
+// ) +// )} +//
+// ) +// } diff --git a/src/css/custom.css b/src/css/custom.css index 28732d2f10..97bf685dca 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -208,10 +208,6 @@ h6 { padding: 0 var(--ifm-pre-padding); } -.main-wrapper { - margin-bottom: 5rem; -} - img { height: auto; } diff --git a/src/css/principles.module.css b/src/css/principles.module.css new file mode 100644 index 0000000000..7c224eab76 --- /dev/null +++ b/src/css/principles.module.css @@ -0,0 +1,62 @@ +/** + * CSS files with the .module.css suffix will be treated as CSS modules + * and scoped locally. + */ + +.card { + display: flex; + position: relative; + flex-direction: row; + margin-left: auto; + margin-right: auto; + width: 100%; + /* height: 100%; */ + padding: 5px; +} + +.text { + font-family: 'Aeonik', 'Roboto Slab', 'Roboto', serif; + display: flex; + /* min-width: 500px; */ + max-width: 700px; + min-height: 210px; + /* padding: 1.3rem; + margin: 1rem; */ + flex-direction: column; + justify-content: center; + border: 0px solid; + border-radius: 0px; + color: #525252; + flex: 2; +} +.text h2 { + font-family: 'Aeonik', 'Roboto Slab', 'Roboto', serif; + font-weight: 400; + font-size: 1.7rem; +} +html[data-theme='dark'] .text { + color: #cfcfcf; +} + +.image { + display: flex; + max-width: 200px; + height: auto; + object-fit: contain; + flex: 1; +} +@media screen and (max-width: 996px) { + .text { + position: relative; + padding: 0 1rem; + color: #525252; + } + .image { + flex: 0; + position: absolute; + z-index: -1; + opacity: 0.3; + right: 110px; + bottom: 0px; + } +} diff --git a/src/yearnPrinciples.js b/src/yearnPrinciples.js new file mode 100644 index 0000000000..249a8ef5d3 --- /dev/null +++ b/src/yearnPrinciples.js @@ -0,0 +1,60 @@ +const yearnPrinciples = [ + { + title: "You can't build trustless systems without trust.", + titleColor: '#5814fb', + description: + "Yearn runs on trust. Trust fosters strong connections and helps things run smoothly, allowing Yearn to circumvent the burdens of traditional corporate middle management. We move at the speed of trust because we believe it's the most efficient way to get things done - all our other principles are possible because we choose to trust each other.", + image: '/img/principles/trust.png', + alt: 'drawing of purple man', + }, + { + title: "Do'ers, do.", + titleColor: '#fa3aa7', + description: + "Belief is great, but building is better. As a contributor, you are the person who knows what's best to do for Yearn. We don't wait for approvals or authorization, permission is self granted, and action is revered. As a self starter at Yearn you have nothing between you and the glorious horizon. The future belongs to those who do.", + image: '/img/principles/doers.png', + alt: 'drawing of man with axe and tree', + }, + { + title: 'Revere one another.', + titleColor: '#ffdc53', + description: + "Conflict is inevitable, but it doesn't have to be destructive. We operate under the assumption that our fellow contributors are fundamentally good, reasonable, and trustworthy. Stir some hard work, talent and capability into the mix and it's easy to see why even when things go wrong, we always take the Most Respectful Interpretation of each others actions.", + image: '/img/principles/revere.png', + alt: 'drawing of woman holding weight', + }, + { + title: 'Boxes are for squares.', + titleColor: '#63c532', + description: + "Creativity is our competitive edge. When boldness is met with trust and empathy, magic occurs. We understand that the craziest ideas can spawn entirely new industries - Yearn is living proof of it. No thought is too crazy, no plan too weird, no ambition too out there. Yearn exists in a realm beyond nation state borders, but we're proud to let our freak flag fly.", + image: '/img/principles/boxes.png', + alt: 'drawing of woman with flag and comet', + }, + { + title: 'You are what you do.', + titleColor: '#ff90a1', + description: + "Yearn is a place that values ideas over identity. Whether you're a defi og or a newb on the Discord, the best contributions will always be respected. We're all for personality, but never cult of personality. Here, work always trumps credentials - we don't care who you are, only what you do.", + image: '/img/principles/doers.png', + alt: 'drawing of woman holding mirror', + }, + { + title: '<3 Chaos.', + titleColor: '#e00716', + description: + "Decentralization isn't just best for the protocol, it's also best for the people building it. The future doesn't look like a corporate strategy deck or some complex org chart. It looks like nature - messy, chaotic and full of surprises. Yearn find order from chaos, scaling in harmony with other orgs and the wider space.", + image: '/img/principles/chaos.png', + alt: 'drawing of man dancing with fire', + }, + { + title: 'Humans and code.', + titleColor: '#a446ba', + description: + "The protocol isn't our only product. Yearn is a community of independent builders who are free to sprout new organizations and grow the network organically. Each day Yearn supports the flourishing Defi ecosystem by uniting exceptional people around radical projects that make finance more flexible and accessible. This synergistic relationship guides Yearn to build its code and community with integrity.", + image: '/img/principles/code.png', + alt: 'drawing of woman holding hoop', + }, +] + +export default yearnPrinciples diff --git a/static/img/dao-pages/here-we-are-cropped.jpg b/static/img/dao-pages/here-we-are-cropped.jpg new file mode 100644 index 0000000000..a4818690fc Binary files /dev/null and b/static/img/dao-pages/here-we-are-cropped.jpg differ diff --git a/static/img/landing-page/alice-banner-2.png:Zone.Identifier b/static/img/landing-page/alice-banner-2.png:Zone.Identifier deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/static/img/landing-page/pixie-banner-grad-flower.png:Zone.Identifier b/static/img/landing-page/pixie-banner-grad-flower.png:Zone.Identifier deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/static/img/landing-page/witchy-banner-grad2.png:Zone.Identifier b/static/img/landing-page/witchy-banner-grad2.png:Zone.Identifier deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/static/img/principles/boxes.png b/static/img/principles/boxes.png new file mode 100644 index 0000000000..4d9a259b97 Binary files /dev/null and b/static/img/principles/boxes.png differ diff --git a/static/img/principles/chaos.png b/static/img/principles/chaos.png new file mode 100644 index 0000000000..41f64622fd Binary files /dev/null and b/static/img/principles/chaos.png differ diff --git a/static/img/principles/code.png b/static/img/principles/code.png new file mode 100644 index 0000000000..61338af4f0 Binary files /dev/null and b/static/img/principles/code.png differ diff --git a/static/img/principles/doers.png b/static/img/principles/doers.png new file mode 100644 index 0000000000..4f5f7a30fb Binary files /dev/null and b/static/img/principles/doers.png differ diff --git a/static/img/principles/revere.png b/static/img/principles/revere.png new file mode 100644 index 0000000000..2ed79dc6a0 Binary files /dev/null and b/static/img/principles/revere.png differ diff --git a/static/img/principles/trust.png b/static/img/principles/trust.png new file mode 100644 index 0000000000..0181b69804 Binary files /dev/null and b/static/img/principles/trust.png differ diff --git a/static/img/principles/what-you-do.png b/static/img/principles/what-you-do.png new file mode 100644 index 0000000000..2fc6b34619 Binary files /dev/null and b/static/img/principles/what-you-do.png differ diff --git a/static/img/product-pages/blueknight-product-banner.png b/static/img/product-pages/blueknight-product-banner.png new file mode 100644 index 0000000000..3ae10a5916 Binary files /dev/null and b/static/img/product-pages/blueknight-product-banner.png differ