-
Notifications
You must be signed in to change notification settings - Fork 155
Update indexing documentation for Exponential Rebates #454
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.
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
Conversation
Co-authored-by: Benoît Rouleau <[email protected]>
Co-authored-by: Benoît Rouleau <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I think this is good from a "removing prior references" standpoint, I think maybe there could be a short explanation within the docs themselves (vs. always linking to the GIP) to explain why there is a rebate function at all, and in laymans terms how the exponential rebate function works.
--- | ||
|
||
Indexers are node operators in The Graph Network that stake Graph Tokens (GRT) in order to provide indexing and query processing services. Indexers earn query fees and indexing rewards for their services. They also earn from a Rebate Pool that is shared with all network contributors proportional to their work, following the Cobb-Douglas Rebate Function. | ||
Indexers are node operators in The Graph Network that stake Graph Tokens (GRT) in order to provide indexing and query processing services. Indexers earn query fees and indexing rewards for their services. They also earn query fees that are rebated according to an exponential rebate function. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be worth providing a bit more of a legible explanation of what the rebate function is for (essentially ensuring that indexers have sufficient stake allocated when claiming a given amount of query fees)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. To be explicit, after "to an exponential rebate function.", you could add:
This aim of using this rebate function is to ensure indexers achieve the best outcome by faithfully serving queries. This works by incentivizing Indexers to allocate a large amount of stake (which can be slashed for erring when serving a query) relative to the amount of query fees they may collect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, agree with Adam's point on adding a brief explainer on the new mechanism, maybe in the section where we link to the GIP we could add one sentence or two kind of a TL;DR for the GIP. @howardheaton might be able to help?
@tmigone, I agree. It's a bit long, but how about this for a tl;dr?
|
Removes references to Cobb-Douglas, rebate pools, and legacy allocation states. Tagging @tmigone for visibility.
Thanks 😄