diff --git a/docs/contributing/governance/yips/yip-75.md b/docs/contributing/governance/yips/yip-75.md index 7abdce720d..0a899a9cf4 100644 --- a/docs/contributing/governance/yips/yip-75.md +++ b/docs/contributing/governance/yips/yip-75.md @@ -123,9 +123,9 @@ The base V3 contracts were built as an un-opinionated base that allows the vault Some examples of periphery contracts that have already been developed are: -**[Accountant](https://github.com/yearn/vault-periphery/tree/master/contracts/accountants)**: Accountants are stand alone contracts that are attached to a vault and charge the fees for a vault when strategies report profits or losses. An accountant can charge any fees that can be codified as well as give refunds back to the vault. Accountants will also be able to serve as a Junior Tranche to the vault. +**[Accountant](https://github.com/yearn/vault-periphery/tree/master/src/accountants)**: Accountants are stand alone contracts that are attached to a vault and charge the fees for a vault when strategies report profits or losses. An accountant can charge any fees that can be codified as well as give refunds back to the vault. Accountants will also be able to serve as a Junior Tranche to the vault. **4626 Router[\[5\]](#references)**: To make integration with any V3 vault or strategy as easy as possible. The router also utilizes permit and multicall to make user tx’s as simple and cheap as possible. -**[Custom Registries](https://github.com/yearn/vault-periphery/tree/master/contracts/registry)**: Each team, protocol, UI etc. can deploy and manage their own registry to easily track on chain the vaults and strategies they work with. +**[Custom Registries](https://github.com/yearn/vault-periphery/tree/master/src/registry)**: Each team, protocol, UI etc. can deploy and manage their own registry to easily track on chain the vaults and strategies they work with. **[Swappers](https://github.com/yearn/tokenized-strategy-periphery/tree/master/src/swappers)**: Strategists can simply inherit a contract that has their preferred method of token swapping to easily integrate with any dex or swapping method they want. ## Fee Structure diff --git a/docs/developers/deprecated-products/vecrv-boosts.md b/docs/developers/deprecated-products/vecrv-boosts.md index 387924e09c..7dea2e767b 100644 --- a/docs/developers/deprecated-products/vecrv-boosts.md +++ b/docs/developers/deprecated-products/vecrv-boosts.md @@ -16,7 +16,7 @@ Many of Yearn's strategies utilize Curve Finance's liquidity mining program. [Cu ### veCRV Boosts -CRV is distributed continuously to users who stake certain liquidity provider tokens in Curve's [gauge](https://resources.curve.finance/base-features/understanding-gauges). Those CRV rewards can be increased when the user locks up their CRV in the [Locker](https://dao.curve.finance/locker). This locker gives the staker veCRV in return, which bears the right to vote in governance and to claim a portion of the protocol's fees. +CRV is distributed continuously to users who stake certain liquidity provider tokens in Curve's [gauge](https://docs.curve.finance/protocol/gauge/overview). Those CRV rewards can be increased when the user locks up their CRV in the [Locker](https://dao.curve.finance/locker). This locker gives the staker veCRV in return, which bears the right to vote in governance and to claim a portion of the protocol's fees. Locking CRV allows users to boost the CRV rewards they are receiving when providing liquidity in eligible pools. The amount of the boost is determined by how much CRV was locked and their relative stake in the pool. diff --git a/docs/developers/security/index.md b/docs/developers/security/index.md index d42259409a..13e54e8e28 100644 --- a/docs/developers/security/index.md +++ b/docs/developers/security/index.md @@ -10,9 +10,10 @@ Potential vulnerabilities are welcome to be disclosed following the guidelines e The V3 core contracts used in V3 vaults, found at [yearn-vaults-v3](https://github.com/yearn/yearn-vaults-v3) repository have been audited by multiple independent third-party firms: -- [StateMind](https://statemind.io/) has audited v3.0.0, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20240502_Statemind_Yearn_V3) -- [ChainSecurity](https://www.chainsecurity.com/) has audited v3.0.0, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20240504_ChainSecurity_Yearn_V3) -- [yAudit](https://yaudit.dev/) has audited v3.0.1, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20240601_YAcademy_Yearn_V3) +- [ChainSecurity](https://www.chainsecurity.com/) has audited v3.0.0, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20230504_ChainSecurity_Yearn_V3) +- [yAudit](https://yaudit.dev/) has audited v3.0.1, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20230728_YAcademy_Yearn_V3.0.1) +- [StateMind](https://statemind.io/) has audited v3.0.2, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20240301_Statemind_Yearn_V3.0.2) +- [yAudit](https://yaudit.dev/) has audited v3.1.0, public report [available here](https://github.com/yearn/yearn-security/tree/master/audits/20260601_yAudit_Yearn_V3.1.0) The legacy core contracts used in V2 vaults and the Factory Vaults, found at [yearn-vaults](https://github.com/yearn/yearn-vaults/) repository have been audited by multiple independent third-party firms: diff --git a/docs/developers/v3/periphery.md b/docs/developers/v3/periphery.md index 8f48c0ccad..a804d91fe4 100644 --- a/docs/developers/v3/periphery.md +++ b/docs/developers/v3/periphery.md @@ -19,7 +19,7 @@ The contracts in the 'Vault Periphery' are meant to be used alongside a V3 multi ### Release Registry -https://github.com/yearn/vault-periphery/blob/master/contracts/registry/ReleaseRegistry.sol +https://github.com/yearn/vault-periphery/blob/master/src/registry/ReleaseRegistry.sol Yearn controlled registry to track any new versions of V3 released on that specific chain. @@ -27,7 +27,7 @@ Each time a new Version of the [Vault Factory](https://github.com/yearn/yearn-va ### Registry -https://github.com/yearn/vault-periphery/blob/master/contracts/registry/Registry.sol +https://github.com/yearn/vault-periphery/blob/master/src/registry/Registry.sol Stores the endorsed multi strategy and single strategy vaults. Can also deploy new multi strategy vaults based on the most recent Vault Factory added to the Release Registry. @@ -37,7 +37,7 @@ Deploy a custom Registry using the [RegistryFactory](/developers/smart-contracts ### Accountant -https://github.com/yearn/vault-periphery/tree/master/contracts/accountants +https://github.com/yearn/vault-periphery/tree/master/src/accountants By default V3 multi strategy vaults have fees set to 0 and will need an `accountant` set to charge fees. @@ -53,7 +53,7 @@ To deploy a generic account use the [Accountant Factory](/developers/smart-contr ### Debt Allocator -https://github.com/yearn/vault-periphery/tree/master/contracts/debtAllocators +https://github.com/yearn/vault-periphery/tree/master/src/debtAllocators To manager the allocation of debt between multiple strategies in a multi strategy vault some generic Debt Allocators have been developed. These contracts are meant to be given the `DEBT_MANAGER` and `REPORTING_MANAGER` roles for a specific vault and then monitored by a keeper to manage the allocations based on set 'target ratios'. @@ -71,7 +71,7 @@ You can deploy a single generic Debt Allocator using the [Debt Allocator Factory ### Role Manager -https://github.com/yearn/vault-periphery/blob/master/contracts/Managers/RoleManager.sol +https://github.com/yearn/vault-periphery/blob/master/src/managers/RoleManager.sol The Role Manager is used to hold the `role_manager` position in Yearns multi strategy vaults and make deployments simpler. All role configuration and periphery contracts are set up during the vaults deployment. diff --git a/docs/developers/v3/vault_management.md b/docs/developers/v3/vault_management.md index 2779012e93..bba4274d96 100644 --- a/docs/developers/v3/vault_management.md +++ b/docs/developers/v3/vault_management.md @@ -140,7 +140,7 @@ The accountant is called by the vault during every `report` with the strategy th Accountants can hold any logic that vault managers want to dictate fees or simply charge normal performance or management fees. A ready-to-use Accountant can easily be used with any vault for those who wish just to charge standard fees. -See Here: https://github.com/yearn/vault-periphery/blob/master/contracts/accountants/Accountant.sol +See Here: https://github.com/yearn/vault-periphery/blob/master/src/accountants/Accountant.sol #### Deposit/Withdraw Limit Modules diff --git a/docs/getting-started/guides/how-boost-works.md b/docs/getting-started/guides/how-boost-works.md index 383b640640..1c21e4fe57 100644 --- a/docs/getting-started/guides/how-boost-works.md +++ b/docs/getting-started/guides/how-boost-works.md @@ -42,7 +42,7 @@ Beyond staking, another major incentive for CRV is the ability to boost your rew The actual boost multiplier is determined by a formula that depends on the current pool gauge liquidity as a fraction out of the total amount of liquidity provided in Curve pools by Yearn, and the fraction of voting power that the veCRV constitutes out of the total (i.e. its share of the current total of veCRV issued). -See the [Curve Guide](https://resources.curve.finance/reward-gauges/boosting-your-crv-rewards/) for more details on the formula and its calculation. +See the [Curve Guide](https://docs.curve.finance/user/yield/boosting) for more details on the formula and its calculation. ## The yveCRV yVault @@ -115,9 +115,9 @@ Yearn’s work to automate the yield generation and rebalancing of your crypto a ## More information - [curve.finance](https://www.curve.finance/) webpage -- Curve [Guide](https://resources.curve.finance/lending/how-to-supply/#staking-assets) for staking CRV -- Curve [Guide](https://resources.curve.finance/reward-gauges/boosting-your-crv-rewards/) for vote locking -- Curve [FAQ](https://resources.curve.finance/crv-token/faq/) +- Curve [Guide](https://docs.curve.finance/user/yield/lending) for staking CRV +- Curve [Guide](https://docs.curve.finance/user/vecrv/how-to-lock) for vote locking +- Curve [FAQ](https://docs.curve.finance/user/vecrv/faq) - deFinn [Infographic](https://gateway.pinata.cloud/ipfs/QmY8BZjN6oT4rrgveSqHjygcQmWitoMQk5B3moqFA6K8ea) on CRV Voting Boost and formula - Boost [calculator](https://dao.curve.finance/minter/calc) - Yearn CurveDAO proxy strategy [diagram](https://twitter.com/bantg/status/1308680661801340929) diff --git a/docs/getting-started/guides/how-to-understand-strategies-descriptions.md b/docs/getting-started/guides/how-to-understand-strategies-descriptions.md index bc277b3bf4..d99efc8fa9 100644 --- a/docs/getting-started/guides/how-to-understand-strategies-descriptions.md +++ b/docs/getting-started/guides/how-to-understand-strategies-descriptions.md @@ -157,7 +157,7 @@ While reading the strategy descriptions at [yearn.fi/vaults↗](https://yearn.fi ### Curve Boost / Curve Gauge - Locking up [CRV](#curve) on Curve allows you to boost your CRV [rewards](#rewards) for being a liquidity provider. -- Read more at Curve [docs↗](https://resources.curve.finance/reward-gauges/boosting-your-crv-rewards). +- Read more at Curve [docs↗](https://docs.curve.finance/user/yield/boosting). ### Convex diff --git a/docs/getting-started/products/ylockers/overview.md b/docs/getting-started/products/ylockers/overview.md index 4e0d934b8c..e7298fa068 100644 --- a/docs/getting-started/products/ylockers/overview.md +++ b/docs/getting-started/products/ylockers/overview.md @@ -1,6 +1,6 @@ # yLockers Overview -yLockers are a category of assets built by Yearn designed to tokenize locked governance positions in external DeFi protocols based on [Curve's vote escrow (ve) model](https://resources.curve.finance/crv-token/vecrv/). This asset type is often called a "Liquid Locker". +yLockers are a category of assets built by Yearn designed to tokenize locked governance positions in external DeFi protocols based on [Curve's vote escrow (ve) model](https://docs.curve.finance/user/vecrv/what-is-vecrv). This asset type is often called a "Liquid Locker". To achieve this, Yearn has deployed a system of smart contracts that allows users to permissionlessly max-lock their governance tokens to Yearn in exchange for a yLocker token (e.g., yCRV, yPRISMA, etc.) at a rate of 1:1. diff --git a/docs/getting-started/products/ylockers/ycrv/overview.md b/docs/getting-started/products/ylockers/ycrv/overview.md index 44f1fdc04a..9438f18a8f 100644 --- a/docs/getting-started/products/ylockers/ycrv/overview.md +++ b/docs/getting-started/products/ylockers/ycrv/overview.md @@ -5,7 +5,7 @@ ## What is yCRV? -yCRV is Yearn's veCRV yLocker product. It is designed to tokenize the different benefits of a [veCRV position](https://resources.curve.finance/crv-token/vecrv/) in a simple, user-friendly way. Let's review the basics of liquid locker tokens like yCRV: +yCRV is Yearn's veCRV yLocker product. It is designed to tokenize the different benefits of a [veCRV position](https://docs.curve.finance/user/vecrv/what-is-vecrv) in a simple, user-friendly way. Let's review the basics of liquid locker tokens like yCRV: - 1 yCRV represents 1 veCRV max-locked to Yearn - They are not redeemable for the underlying locked CRV diff --git a/docs/getting-started/products/ylockers/yyb/overview.md b/docs/getting-started/products/ylockers/yyb/overview.md index 01f6eb4e6c..c8c1f52fba 100644 --- a/docs/getting-started/products/ylockers/yyb/overview.md +++ b/docs/getting-started/products/ylockers/yyb/overview.md @@ -4,7 +4,7 @@ ## What is yYB? -yYB is Yearn's veYB yLocker product. It is designed to tokenize the different benefits of a [veYB position](https://docs.yieldbasis.com/user/veyb) in a simple, user-friendly way. Let's review the basics of liquid locker tokens like yYB: +yYB is Yearn's veYB yLocker product. It is designed to tokenize the different benefits of a [veYB position](https://docs.yieldbasis.com/user/governance/veyb) in a simple, user-friendly way. Let's review the basics of liquid locker tokens like yYB: * 1 yYB represents 1 veYB permalocked to Yearn * They are not redeemable for the underlying locked YB