Skip to content

Commit

Permalink
Rename Indexers and Node Providers
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Dec 11, 2023
1 parent d2c74fe commit d07cc83
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 51 deletions.
6 changes: 3 additions & 3 deletions docs/subquery_network/consumers/faq.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Frequently Asked Questions

## As a Consumer, do I select 1 Indexer or multiple Indexers?
## As a Consumer, can I select 1 Indexer or multiple Indexers?

Unless a Closed Service Agreement is being used, there will be one or more Indexers indexing a SubQuery project. Consumers have the choice when deciding which Indexer to read data from. Typically Consumers would select the most reliable and lowest latency Indexer. Consumers could also incorporate automatic failover and read data from another Indexer if the first one times out or is not responsive.

## What happens if an Indexer goes offline?
## What happens if a Data Indexer or an RPC Provider goes offline?

Unless a Closed Service Agreement is being used, and if there is more than one Indexer indexing your SubQuery project, it would simply be a matter of switching to another Indexer. The ideal scenario would be include strategies like alert monitoring to be notified of potential issues and intelligent routing and caching.
Unless a Closed Service Agreement is being used, and if there is more than one Data Indexer/RPC provider serving your SubQuery project, it would simply be a matter of switching to another Indexer. The ideal scenario would be include strategies like alert monitoring to be notified of potential issues and intelligent routing and caching.
8 changes: 4 additions & 4 deletions docs/subquery_network/consumers/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ The SubQuery Kepler Network does not yet have the consumer role. Consumers will

## What is a Consumer?

A Consumer is a participant in the SubQuery network and is either an individual or organisation that pays for processed and organised blockchain data from the SubQuery Network. Consumers effectively make requests to the SubQuery Network for specific data and pay an agreed amount of SQT in return.
A Consumer is a participant in the SubQuery network and is either an individual or organisation that pays for processed and organised blockchain data from the SubQuery Network. Consumers effectively make requests to the SubQuery Network for specific data or the ability to submit transactions to RPC providers and pay an agreed amount of SQT in return.

Consumers are typically dApp (decentralised application) developers, data analytic companies, blockchain networks, middleware developers, or even web aggregating companies that need access to blockchain data to provide services to their end-users.
Consumers are typically dApp (decentralised application) developers, data analytic companies, blockchain networks, middleware developers, or even web aggregating companies that need access to blockchain data or performant RPCs to provide services to their end-users.

## Requirements to be a Consumer

There are no requirements as such to become a SubQuery Consumer. However, Consumers will need to understand how to obtain SQT, how to advertise their data requirements and how to consume the JSON data returned.

## Benefits of being a Consumer

As a Consumer, you can receive indexed data from the Network for your dApps, thereby saving you time figuring out how to get blockchain data yourself. Other benefits include:
As a Consumer, you can interact with performant RPCs or receive indexed data from the Network for your dApps. Other benefits include:

- Easy access to blockchain data. There is no need to learn about the intricacies of a blockchain. Just get access to the exact data you need to run your applications.
- Focus on developing your appplication, not on time consuming blockchain integration.
- Cost effective. Combining the two points from above, consuming data from SubQuery results in a very cost effective way to power your applications.

## Costs to being a Consumer

The cost of querying data on the blockchain will be based on supply and demand and will be comparable to other similar services currently available. The advantage of an open and transparent network and ecosystem is that competition is encouraged to provide the best service to the Consumer.
The cost of submitting or querying data on the blockchain will be based on supply and demand and will be comparable to other similar centralised and decentralised services currently available. The advantage of an open and transparent network and ecosystem is that competition is encouraged to provide the best service to the Consumer.

For flexibility, Consumers have 3 payment options to pay for blockchain data, you can read more about these, how they work, and the advantages/disadvantages on the [Payment Methods article](../design/payment-methods.md).
16 changes: 8 additions & 8 deletions docs/subquery_network/delegators/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## What is a Delegator?

A Delegator is a non-technical network role in the SubQuery Network and is a great way to start participating in the SubQuery Network. This role enables Delegators to “delegate” their SQT to one or more Indexers and earn rewards (similar to staking).
A Delegator is a non-technical network role in the SubQuery Network and is a great way to start participating in the SubQuery Network. This role enables Delegators to “delegate” their SQT to one or more Node Operator (RPC Providers or Data Indexers) and earn rewards (similar to staking).

Without Delegators, Indexers will likely earn fewer rewards because they will have less SQT to allocate. Therefore, Indexers compete to attract Delegators by offering a competitive share of an Indexer’s rewards.
Without Delegators, Node Operators would likely earn fewer rewards because they will have less SQT to allocate. Therefore, Node Operators compete to attract Delegators by offering a competitive share of an Node Operator's rewards.

## Requirements to be a Delegator

Expand All @@ -14,17 +14,17 @@ One of the best things about being a Delegator is that you don’t need any devo

There are several benefits of becoming a Delegator:

- It's easy to get started and requires little technical knowledge, Delegators only need to acquire SQT tokens and then learn the process of delegating the tokens to their preferred Indexer(s).
- Delegating contribute to the network and to Indexers. In return, Delegators are rewarded with SQT.
- Delegators earn rewards by putting their SQT to work by delegating their SQT to Indexers and earning a share of the reward pool.
- It's easy to get started and requires little technical knowledge, Delegators only need to acquire SQT tokens and then learn the process of delegating the tokens to their preferred Node Operator(s).
- Delegating contribute to the network and to Node Operators. In return, Delegators are rewarded with SQT.
- Delegators earn rewards by putting their SQT to work by delegating their SQT to Node Operators and earning a share of the reward pool.
- There is no minimum required delegation to be a Delegator. This means that anyone can join no matter how much SQT one has.

## Risks of being a Delegator

Even though it is not considered a risky role, being a Delegator includes a few risks to be aware of.

1. Market volatility risk: The constant fluctuations in the market is a risk that affects not just SQT, but all tokens in the general cryptocurrency marketplace. Taking a long term approach can reduce this type of risk.
2. Constant adjustments of staking parameters by Indexers and delegation fees can increase the risk to a Delegator. For example, a Delegator might miss a change in staking parameters resulting in a less than expected return. To reduce this risk, when Indexers decrease their stake parameters, it will only take effect after the next full Era has been completed, giving time for delegators to assess and make any changes.
3. Indexer poor performance: It is possible that Delegators can select Indexers that perform poorly and therefore provide a substandard return on investment to Delegators. Delegators are therefore encouraged to do Indexer due diligence on potential Indexers. A Reputation Index is also available to help Delegators compare Indexers to each other.
2. Constant adjustments of staking parameters by Node Operators and delegation fees can increase the risk to a Delegator. For example, a Delegator might miss a change in staking parameters resulting in a less than expected return. To reduce this risk, when Node Operators decrease their stake parameters, it will only take effect after the next full Era has been completed, giving time for delegators to assess and make any changes.
3. Node Operator poor performance: It is possible that Delegators can select Node Operators that perform poorly and therefore provide a substandard return on investment to Delegators. Delegators are therefore encouraged to do Node Operator due diligence on potential Node Operators. A Reputation Index is also available to help Delegators compare Node Operators to each other.

Once a preferred Indexer(s) is found, due diligence should be performed to check an Indexer’s reputation and reliability. Assessments could be performed to evaluate if the Indexer is active in the community, if the Indexer helps other members, if it is possible to get in touch with the Indexer, and if the Indexer is up-to-date with protocol and project updates. The aforementioned Reputation Index can also serve as a primary selection indicator.
Once a preferred Node Operator(s) is found, due diligence should be performed to check an Node Operator’s reputation and reliability. Assessments could be performed to evaluate if the Node Operator is active in the community, if the Node Operator helps other members, if it is possible to get in touch with the Node Operator, and if the Node Operator is up-to-date with protocol and project updates. The aforementioned Reputation Index can also serve as a primary selection indicator.
26 changes: 13 additions & 13 deletions docs/subquery_network/delegators/rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,45 @@

## How Delegators are rewarded?

To attract Delegators to support their work, Indexers offer Delegators a share of the rewards they earn.
To attract Delegators to support their work, Node Operators (Data Indexers or RPC providers) offer Delegators a share of the rewards they earn.

:::info Indexer Commission Rate (ICR)
:::info Node Operator Commission Rate (NOCR)

_Indexer’s Commission Rate (ICR)_: This is a percentage share of the rewards received by Indexers from serving requests to Consumers. After deducting the ICR from total rewards, the remaining rewards will be shared within the total delegation/staking pool proportionally to the individual delegated/staked value in the pool.
_Node Operator's Commission Rate (ICR)_: This is a percentage share of the rewards received by Node Operators from serving requests to Consumers. After deducting the ICR from total rewards, the remaining rewards will be shared within the total delegation/staking pool proportionally to the individual delegated/staked value in the pool.

Indexers are free to set this rate to any value they desire. A higher ICR indicates that Indexers keep more of the rewards. A lower ICR indicates that the Indexers share more of their rewards with their Delegators.
Node Operators are free to set this rate to any value they desire. A higher NOCR indicates that Node Operators keep more of the rewards. A lower ICR indicates that the Node Operators share more of their rewards with their Delegators.

:::

Delegators will only receive revenue for staking Eras that they were a part of for the entire period. For example, if they join a staking Era in the middle of the relevant period, then they will not earn any Query Fee revenue for that particular Era.

If an Indexer wishes to increase the Indexer Commission Rate that they offer to their Delegators, they must advertise this for an entire staking Era. The Indexer will be able to decrease their Indexer Commission Rate at any point to raise more delegated SQT for staking in the short term. Delegators can withdraw or undelegate their staked amount at any time, but they will forfeit any rewards earned within the staking Era (as they were not part of the delegation pool for the entire duration of the staking Era).
If an Node Operator wishes to increase the Node Operator Commission Rate that they offer to their Delegators, they must advertise this for an entire staking Era. The Node Operator will be able to decrease their Node Operator Commission Rate at any point to raise more delegated SQT for staking in the short term. Delegators can withdraw or undelegate their staked amount at any time, but they will forfeit any rewards earned within the staking Era (as they were not part of the delegation pool for the entire duration of the staking Era).

## How to select what indexers to delegate to
## How to select what Node Operators to delegate to

You need to assess a few things when deciding on what Indexer to choose.
You need to assess a few things when deciding on what Node Operator to choose.

Indexers set an Indexer’s Commission Rate (ICR) which is the percentage Indexers earn. Therefore, a lower ICR will be more attractive for Delegators as a larger percentage of rewards is shared between Delegators.
Node Operators set an Node Operator’s Commission Rate (NOCR) which is the percentage Node Operators earn. Therefore, a lower NOCR will be more attractive for Delegators as a larger percentage of rewards is shared between Delegators.

For example, Indexer A has set an ICR of 80% and has received SQT from 8 Delegators. This means that the 8 Delegators plus the Indexer itself, will be rewarded a share of the remaining 20% of what the Indexer has earned. The share will be split proportionally between them based on the amount staked/delegated. Alternatively, if Indexer A had an ICR of 30%, then the 8 delegators and indexer would share proportionally rewards from the remaining 70% of rewards. In short, the lower the ICR - the better it is for Delegators.
For example, Node Operator A has set an NOCR of 80% and has received SQT from 8 Delegators. This means that the 8 Delegators plus the Node Operator itself, will be rewarded a share of the remaining 20% of what the Node Operator has earned. The share will be split proportionally between them based on the amount staked/delegated. Alternatively, if Node Operator A had an NOCR of 30%, then the 8 delegators and Node Operator would share proportionally rewards from the remaining 70% of rewards. In short, the lower the NOCR - the better it is for Delegators.

Note that Delegators must have delegated their tokens for the entire Era to be eligible for these rewards (note [Non-reward period](#non-reward-period)).

Additionally, we've made it easier for you to see other data about all indexers in our app. Navigate to `Delegator` > `Indexers` and view the [leaderboard](https://kepler.subquery.network/delegator/node_operators/indexers/top) which shows various scores and details that we think are important to you when deciding what indexer to choose. The Indexer Score takes into account an Indexer’s uptime, slashing events, and other parameters.
For Data Indexers, we've made it easier for you to see other data about all Data Indexers in our app. Navigate to `Delegator` > `Indexers` and view the [leaderboard](https://kepler.subquery.network/delegator/node_operators/indexers/top) which shows various scores and details that we think are important to you when deciding what Data Indexer to choose. The Data Indexers Score takes into account an Data Indexer’s uptime, slashing events, and other parameters.

## Non-reward period

Besides the period when Delegators can effectively earn money, a non-reward period also occurs. Delegators receive rewards for staking Eras that they were a part of for the entire duration. For example, if a Delegator joins a staking era halfway through, they will not earn any rewards for that particular era.

Delegators can change the indexer that their SQT is delegated to (called redelegating), this change will be queued to happen automatically at the end of the Era and no thawing period will occur.
Delegators can change the Node Operator that their SQT is delegated to (called redelegating), this change will be queued to happen automatically at the end of the Era and no thawing period will occur.

If a Delegator decides to undelegate their SQT, a 28 day thawing period starts. The tokens cannot be used during this period, no fees can be accrued or any reward gained.

## Delegation Lifecycle

Delegators delegate (deposit) SQT into an Indexer’s contract.
Delegators delegate (deposit) SQT into an Node Operator’s contract.

Delegators can then decide how much to redelegate to each Indexer of their choice.
Delegators can then decide how much to redelegate to each Node Operator of their choice.

Delegator can undelegate (withdraw) tokens back to their wallet. This will trigger a lock period of 28 days.

Expand Down
Loading

0 comments on commit d07cc83

Please sign in to comment.