Skip to main content

Metrics

Command

yarn start metrics [arguments] [-options]

Metrics commands list

yarn start metrics -h

Overview

Metrics commands provide comprehensive analytics and reporting for Lido Staking Vaults, including APR calculations, rewards tracking, and visual chart generation for performance analysis.

API

CommandDescription
read (r)read commands

Read

CommandDescription
statistic <address>get statistic data for last report
charts-apr <address> <count>get APR charts data for N last reports
charts-rewards <address> <count>get APR charts data for N last reports

Write

Currently no write commands are implemented for metrics.

Command Details

statistic

Analyzes the latest vault report and calculates comprehensive performance metrics and statistics.

Arguments:

  • <address>: Dashboard contract address

Options:

  • -g, --gateway: IPFS gateway URL for report data retrieval

Process:

  • Retrieves latest report data from LazyOracle contract
  • Fetches current and previous vault reports from IPFS
  • Calculates comprehensive performance metrics
  • Displays statistical analysis

Metrics Calculated:

  • Gross Staking Rewards: Total rewards earned from staking
  • Node Operator Rewards: Rewards allocated to node operators
  • Daily Lido Fees: Protocol fees paid to Lido
  • Net Staking Rewards: Rewards after fees and expenses
  • Gross Staking APR: Annual percentage return before fees
  • Net Staking APR: Annual percentage return after fees
  • Efficiency: Ratio of net to gross staking performance
  • Bottom Line: Final profit/loss after all adjustments

Use Case: Get comprehensive performance overview for a specific reporting period.

charts-apr

Generates visual APR (Annual Percentage Rate) charts for historical vault performance analysis.

Arguments:

  • <address>: Dashboard contract address
  • <count>: Number of historical reports to include

Options:

  • -s, --simplified: Use simplified text-based charts instead of interactive charts

Chart Types:

  • Gross Staking APR: Raw staking performance over time
  • Net Staking APR: Performance after node operator fees
  • Efficiency: Ratio showing operational efficiency
  • Bottom Line: Net profit/loss trend
  • Lido APR: Comparative Lido protocol performance

Process:

  • Retrieves historical report data from IPFS
  • Calculates time-series APR metrics
  • Renders interactive charts using blessed-contrib library
  • Displays comparative performance analysis

Use Case: Analyze vault performance trends and identify optimization opportunities.

charts-rewards

Displays visual charts focused on rewards distribution and flow analysis.

Arguments:

  • <address>: Dashboard contract address
  • <count>: Number of historical reports to analyze

Chart Types:

  • Gross Staking Rewards: Total rewards generated over time
  • Node Operator Rewards: Operator compensation tracking
  • Net Staking Rewards: Final rewards after all deductions

Process:

  • Fetches historical vault reports and fee configurations
  • Calculates rewards metrics for each reporting period
  • Generates interactive reward flow visualizations
  • Shows rewards distribution patterns

Use Case: Monitor rewards flow and operator compensation over time.

Data Sources

IPFS Integration

  • Report Storage: Historical data stored on IPFS
  • Decentralized Access: Multiple gateway support
  • Data Integrity: Content-addressed storage verification
  • Caching: Local caching for performance optimization

Oracle Data

  • LazyOracle: Latest report metadata
  • Block-based Queries: Historical contract state access
  • Fee Rate Tracking: Node operator fee history
  • Share Rate Data: stETH share rates

Performance Optimization

Caching Strategy

  • Report Data: Local storage of IPFS content
  • Fee Rates: Cached node operator fees by block
  • Share Rates: Cached stETH share rates
  • Gateway Failover: Multiple IPFS gateway support

Use Cases

Vault Management

  • Monitor long-term performance trends
  • Identify optimization opportunities
  • Track operator efficiency
  • Analyze fee impact

Reporting & Analysis

  • Generate performance reports
  • Compare vault performance
  • Analyze rewards distribution
  • Monitor efficiency metrics

Development & Testing

  • Validate metric calculations
  • Test chart rendering
  • Debug performance issues
  • Analyze historical data patterns