#225 Implement portfolio performance analytics (APY, Sharpe ratio, dr…#241
Open
Kappa16 wants to merge 2 commits into
Conversation
…e ratio, drawdown) FIXED
|
@Kappa16 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
…nce-analytics-(APY,-Sharpe-ratio,-drawdown)-FIX
Author
|
PLEASE CAN YOU REVIEW AND PING ME BACK |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Findings:
The codebase already collected rich YieldSnapshot history (principal + yield + timestamp) but had no consolidated analytics endpoint.
Existing analytics routes (/apy-history, /user-yield, etc.) were limited.
All required metrics can be derived purely from existing data.
Fix Features Implemented:
calculateRealizedAPY() — Uses CAGR formula, manually verified in tests.
calculateSharpeRatio() — Uses daily returns + annualized, respects RISK_FREE_RATE (default 0).
calculateMaxDrawdown() — Peak-to-trough calculation.
calculateProtocolAllocation() — From positions (preferred) or snapshots.
computeAnalyticsMetrics() — Orchestrates all metrics.
New route: GET /api/analytics?period=30d|90d|1y
Full unit test coverage for every calculation function.
OpenAPI spec + API reference updated.
Risk-free rate configurable via env.
Key code excerpt (src/utils/analytics.ts):
TypeScript
export function calculateRealizedAPY(snapshots, periodDays) { /* CAGR / }
export function calculateSharpeRatio(snapshots, rfRate = 0) { / risk-adjusted / }
export function calculateMaxDrawdown(snapshots) { / peak-to-trough */ }
export function calculateProtocolAllocation(...) { ... }
export async function computeAnalyticsMetrics(...) { ... }
CLOSE #225