Skip to content

chore: add metric definitions #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pyropy merged 6 commits into from
Feb 18, 2026
Merged

chore: add metric definitions #92

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b2c8119
chore: copy METRIC-DEFINITIONS.md from timfong888/filecoin-pay-console
pyropy Jan 28, 2026
54115f3
chore: default to client over server components
pyropy Jan 28, 2026
32701e7
Revert "chore: default to client over server components"
pyropy Jan 28, 2026
7b6b6de
chore: leave only GA metric definitions
pyropy Feb 3, 2026
752f70f
chore: change total locked metric formula
pyropy Feb 9, 2026
fe3b333
fix: total buren description & total locked formula
pyropy Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions METRIC-DEFINITIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Metric Definitions

This document defines the hero metrics displayed in the Filecoin Pay Console dashboard.

## Status

* 2026-02-09 - Initial GA metric set definitions.

---

## 1. Total Locked (USDFC & FIL)

- **Definition:** Total amount of USDFC and FIL currently locked across all payment rails
- **Display:** FIL and USDFC displayed separately (no conversion)
- **Purpose:** Represents funds deposited and locked in active payment rails
- **Source:** `Token` entities from Goldsky subgraph
- **Formula:**
```
For each token (USDFC, FIL):
totalLocked = token.lockupCurrent + token.lockupRate * (blockNumber - token.lockupLastSettledUntilEpoch) where token == tokenAddress
```
- **Conversion:** Divide by 10^18 (TOKEN_DECIMALS) for human-readable values

---

## 2. Total Transacted (USDFC & FIL) — Cumulative

- **Definition:** Cumulative sum of all USDFC and FIL transacted across all payment rails since inception
- **Includes:** Settlement payments + one-time payments
- **Display:** FIL and USDFC displayed separately (no conversion)
- **Source:** `Token.totalSettledAmount` and `Token.totalOneTimePayment` from Goldsky subgraph
- **Formula:**
```
For each token (USDFC, FIL):
totalTransacted = (token.totalSettledAmount + token.totalOneTimePayment) where token == tokenAddress
```
- **Conversion:** Divide by 10^18 (TOKEN_DECIMALS) for human-readable values

---

## 3. Total FIL Burned — Cumulative

- **Definition:** Cumulative sum of FIL burned across all payment rails since inception
- **Sources:**
1. **Direct burn from FIL transfers:** When a payment rail settles in FIL or when a one-time payment occures, a portion of transffered FIL is burned
2. **Auction burn (`burnForFIL`):** FIL burned via Filecoin Pay Auction mechanism
- **Source Entity:** `PaymentsMetric` from Goldsky subgraph
- **Formula:**
```
totalFilBurned = paymentsMetric.totalFilBurned
```
- **Conversion:** Divide by 10^18 for human-readable FIL values