diff --git a/docs/developers/data-services/metrics/index.md b/docs/developers/data-services/metrics/index.md new file mode 100644 index 000000000..6faa7ff92 --- /dev/null +++ b/docs/developers/data-services/metrics/index.md @@ -0,0 +1,20 @@ +# Yearn Metrics and Methodologies + +Yearn publishes metrics to describe the scale, performance, and economic output of the Yearn Protocol. This section provides canonical definitions, calculation methods, coverage, and known limitations for those metrics. + +Each methodology should identify: + +- The metric's purpose and interpretation. +- The products, vaults, versions, and chains included. +- The calculation and pricing policies. +- The coverage period and update cadence. +- The source data and implementation. +- Known limitations and current errata. + +## Available Metrics + +- [Lifetime Earnings](/developers/data-services/metrics/lifetime-earnings): Cumulative gross profit and loss reported by indexed Yearn vault strategies. + +## Planned Coverage + +This section is intended to become the reference for Yearn metrics, including total value locked, estimated annual percentage yield, historical annual percentage yield, protocol fees, vault volume, and other commonly published measurements. diff --git a/docs/developers/data-services/metrics/lifetime-earnings.md b/docs/developers/data-services/metrics/lifetime-earnings.md new file mode 100644 index 000000000..301ced5c5 --- /dev/null +++ b/docs/developers/data-services/metrics/lifetime-earnings.md @@ -0,0 +1,30 @@ +# Lifetime Earnings + +Yearn Lifetime Earnings (LTE) measures the cumulative gross profit and loss (P&L) reported by indexed Yearn vault strategies, valued in USD at report time and adjusted for documented accounting incidents. **LTE is tracked as a durable measure of the economic output created by Yearn vaults across versions and chains.** It is deliberately gross, auditable, and conservative: it does not deduct fees, and reports without a reliable price do not enter the USD total. + +TVL only shows how much capital Yearn manages today. **Lifetime Earnings shows how much economic value Yearn vaults have created over time.** + +## Methodology + +LTE begins with every indexed `StrategyReported` event in the defined vault universe. + +For each report: + +1. Read the strategy gain and loss in the vault's underlying asset. +1. Calculate reported P&L as `gain - loss`. +1. Apply explicit, publicly documented incident adjustments. Preserve raw values alongside adjusted values. +1. Value the adjusted gain and loss using the selected historical USD price at the report timestamp. +1. Exclude reports for which no acceptable USD price is available. +1. Aggregate priced P&L across reports, strategies, vaults, chains, and versions. + +The current universe comprises Yearn V2 vaults discovered through two configured Ethereum registries and Yearn V3 vaults returned by configured role managers on Ethereum, Polygon, Base, Arbitrum, and Katana. + +**Coverage begins March 16, 2021, the timestamp of the earliest indexed `StrategyReported` event.** Each included vault is indexed from its recorded deployment block. Coverage applies to the configured vault universe and does not represent Yearn activity outside that universe. + +LTE is gross reported accounting P&L. It is not depositor return, revenue, TVL growth, or net earnings after fees. V3 accountant fees are generally paid through share issuance and therefore dilute existing shareholders without reducing a vault's reported gross strategy P&L. Depositor performance requires a separate share-price or time-weighted-return methodology. + +Each LTE release should include its chain cutoffs, included vault universe, pricing policy, incident-rule version, code revision, and priced-report coverage. + +## Sources + +- [yearn-data source code and exports](https://github.com/schlagopi/yearn-data). diff --git a/docs/developers/data-services/yearn-data.md b/docs/developers/data-services/yearn-data.md index 95f3fe6a1..17ff63d0d 100644 --- a/docs/developers/data-services/yearn-data.md +++ b/docs/developers/data-services/yearn-data.md @@ -2,6 +2,10 @@ If you want to programmatically interact with Yearn data, or need to fetch large amounts of it then you have a few options: +## Metrics + +[Yearn Metrics and Methodologies](/developers/data-services/metrics/) defines how Yearn calculates and interprets published metrics. The section begins with Lifetime Earnings and is intended to expand to metrics such as total value locked, estimated annual percentage yield, and historical annual percentage yield. + ## Kong [Kong](https://kong.yearn.fi/) is an integrated set of services and tools that make it easy to index EVM logs and state, enrich your data with custom hooks, query your data over graphql. Kong is designed to be cheap, reliable, easy to maintain, and simplify the process of updating your index. diff --git a/sidebars/sidebarsDeveloperDocs.js b/sidebars/sidebarsDeveloperDocs.js index fe7bbc099..ca585ce6c 100644 --- a/sidebars/sidebarsDeveloperDocs.js +++ b/sidebars/sidebarsDeveloperDocs.js @@ -105,6 +105,17 @@ export default { id: 'data-services/yearn-data', }, items: [ + { + type: 'category', + label: 'Metrics', + link: { + type: 'doc', + id: 'data-services/metrics/index', + }, + items: [ + 'data-services/metrics/lifetime-earnings', + ], + }, 'data-services/kong', 'data-services/ydaemon', 'data-services/yearn-lens',