Clarify fee volume fields
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 7
- Avg merge
- 4h 1m
- Merged PRs (30d)
- 6
Description
As mentioned by @jmulq in https://github.com/livepeer/subgraph/pull/168#pullrequestreview-3577959998, the current `volume*` fields (e.g. `Protocol.totalVolumeETH`, `BroadcasterDay.volumeETH`) are used to track fee payouts (such as winning ticket redemptions), but the term **“volume”** is ambiguous for downstream consumers and may be misinterpreted.
A possible improvement would be to introduce more explicit fields (e.g. `totalFeesPaidETH` / `totalFeesPaidUSD`) and populate them alongside the existing `volume*` fields. The existing fields should be kept for backward compatibility, with clear documentation of their meaning and a plan to deprecate them over time.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Protocol.totalVolumeETH and BroadcasterDay.volumeETH fields and the pull request review linked in the issue. Trace where these fields are defined and populated, then document their fee-payout meaning and determine the scope for explicit fee fields, backward compatibility, and deprecation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100