Skip to content

Commit

Permalink
Add RPC provider docs and redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Dec 11, 2023
1 parent 2b04b94 commit d2c74fe
Show file tree
Hide file tree
Showing 18 changed files with 158 additions and 72 deletions.
100 changes: 57 additions & 43 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,49 +240,63 @@ export default defineUserConfig({
id: "G-MY90N76MNK",
}),
redirectPlugin({
config: {
"/subquery_network/architects.html":
"/subquery_network/architects/introduction.html",
"/subquery_network/consumers.html":
"/subquery_network/consumers/introduction.html",
"/subquery_network/delegators.html":
"/subquery_network/delegators/introduction.html",
"/subquery_network/indexers.html":
"/subquery_network/indexers/introduction.html",
"/subquery_network/token.html": "/subquery_network/token/token.html",
"/subquery_network/design-philosophy.html":
"/subquery_network/design/design-philosophy.html",
"/subquery_network/payment-methods.html":
"/subquery_network/design/payment-methods.html",
"/subquery_network/kepler/welcome.html":
"/subquery_network/introduction.html",
"/subquery_network/kepler/ksqt.html":
"/subquery_network/token/token.html",
"/subquery_network/kepler/indexers/become-an-indexer.html":
"/subquery_network/indexers/become-an-indexer.html",
"/subquery_network/kepler/indexers/install-indexer-locally.html":
"/subquery_network/indexers/install-indexer-locally.html",
"/subquery_network/kepler/indexers/install-indexer-linux.html":
"/subquery_network/indexers/install-indexer-linux.html",
"/subquery_network/kepler/indexers/index-project.html":
"/subquery_network/indexers/index-project.html",
"/subquery_network/kepler/indexers/dictionary-restore.html":
"/subquery_network/indexers/dictionary-restore.html",
"/subquery_network/kepler/indexers/plans.html":
"/subquery_network/indexers/plans.html",
"/subquery_network/kepler/indexers/troubleshooting-indexers.html":
"/subquery_network/indexers/troubleshooting-indexers.html",
"/subquery_network/kepler/indexers/faqs-indexers.html":
"/subquery_network/indexers/faqs-indexers.html",
"/subquery_network/kepler/indexers/ssl-configuration.html":
"/subquery_network/indexers/indexer-security-guide.html",
"/subquery_network/indexers/ssl-configuration.html":
"/subquery_network/indexers/indexer-security-guide.html",
"/build/manifest/terra.html": "/build/manifest/cosmos.html",
"/build/mapping/terra.html": "/build/mapping/cosmos.html",
"/build/quickstart/quickstart_chains/terra.html":
"/build/quickstart/quickstart_chains/cosmos.html",
"/run_publish/ipfs.html": "/miscellaneous/ipfs.html",
config: (app) => {
const redirects: Record<string, string> = {
"/subquery_network/architects.html":
"/subquery_network/architects/introduction.html",
"/subquery_network/consumers.html":
"/subquery_network/consumers/introduction.html",
"/subquery_network/delegators.html":
"/subquery_network/delegators/introduction.html",
"/subquery_network/indexers.html":
"/subquery_network/node_operators/indexers/introduction.html",
"/subquery_network/token.html": "/subquery_network/token/token.html",
"/subquery_network/design-philosophy.html":
"/subquery_network/design/design-philosophy.html",
"/subquery_network/payment-methods.html":
"/subquery_network/design/payment-methods.html",
"/subquery_network/kepler/welcome.html":
"/subquery_network/introduction.html",
"/subquery_network/kepler/ksqt.html":
"/subquery_network/token/token.html",
"/subquery_network/kepler/indexers/become-an-indexer.html":
"/subquery_network/node_operators/indexers/become-an-indexer.html",
"/subquery_network/kepler/indexers/install-indexer-locally.html":
"/subquery_network/node_operators/indexers/install-indexer-locally.html",
"/subquery_network/kepler/indexers/install-indexer-linux.html":
"/subquery_network/node_operators/indexers/install-indexer-linux.html",
"/subquery_network/kepler/indexers/index-project.html":
"/subquery_network/node_operators/indexers/index-project.html",
"/subquery_network/kepler/indexers/dictionary-restore.html":
"/subquery_network/node_operators/indexers/dictionary-restore.html",
"/subquery_network/kepler/indexers/plans.html":
"/subquery_network/node_operators/indexers/plans.html",
"/subquery_network/kepler/indexers/troubleshooting-indexers.html":
"/subquery_network/node_operators/indexers/troubleshooting-indexers.html",
"/subquery_network/kepler/indexers/faqs-indexers.html":
"/subquery_network/node_operators/indexers/faqs-indexers.html",
"/subquery_network/kepler/indexers/ssl-configuration.html":
"/subquery_network/node_operators/indexers/indexer-security-guide.html",
"/subquery_network/indexers/ssl-configuration.html":
"/subquery_network/node_operators/indexers/indexer-security-guide.html",
"/build/manifest/terra.html": "/build/manifest/cosmos.html",
"/build/mapping/terra.html": "/build/mapping/cosmos.html",
"/build/quickstart/quickstart_chains/terra.html":
"/build/quickstart/quickstart_chains/cosmos.html",
"/run_publish/ipfs.html": "/miscellaneous/ipfs.html",
};
return {
...redirects,
...Object.fromEntries(
app.pages.map(({ path }) => [
path.replace(
"/subquery_network/node_operators/indexers/",
"/subquery_network/indexers/"
),
path,
])
),
};
},
}),
],
Expand Down
43 changes: 27 additions & 16 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -460,29 +460,40 @@ export const getSidebar = (locale: string) =>
],
},
{
text: "Indexers",
link: `${locale}/subquery_network/indexers/introduction.md`,
text: "Node Operators",
link: `${locale}/subquery_network/node_operators/introduction.md`,
collapsible: true,
children: [
`${locale}/subquery_network/indexers/introduction.md`,
`${locale}/subquery_network/indexers/rewards.md`,
{
text: "Becoming an Indexer",
link: `${locale}/subquery_network/indexers/become-an-indexer.md`,
text: "Data Indexers",
link: `${locale}/subquery_network/node_operators/indexers/introduction.md`,
collapsible: true,
children: [
`${locale}/subquery_network/indexers/become-an-indexer.md`,
`${locale}/subquery_network/indexers/install-indexer-locally.md`,
`${locale}/subquery_network/indexers/install-indexer-linux.md`,
`${locale}/subquery_network/indexers/separated-db.md`,
`${locale}/subquery_network/indexers/indexer-security-guide.md`,
`${locale}/subquery_network/indexers/index-project.md`,
`${locale}/subquery_network/indexers/dictionary-restore.md`,
`${locale}/subquery_network/indexers/troubleshooting-indexers.md`,
`${locale}/subquery_network/node_operators/indexers/introduction.md`,
`${locale}/subquery_network/node_operators/indexers/rewards.md`,
{
text: "Becoming an Indexer",
link: `${locale}/subquery_network/node_operators/indexers/become-an-indexer.md`,
collapsible: true,
children: [
`${locale}/subquery_network/node_operators/indexers/become-an-indexer.md`,
`${locale}/subquery_network/node_operators/indexers/install-indexer-locally.md`,
`${locale}/subquery_network/node_operators/indexers/install-indexer-linux.md`,
`${locale}/subquery_network/node_operators/indexers/separated-db.md`,
`${locale}/subquery_network/node_operators/indexers/indexer-security-guide.md`,
`${locale}/subquery_network/node_operators/indexers/index-project.md`,
`${locale}/subquery_network/node_operators/indexers/dictionary-restore.md`,
`${locale}/subquery_network/node_operators/indexers/troubleshooting-indexers.md`,
],
},
`${locale}/subquery_network/node_operators/indexers/plans.md`,
`${locale}/subquery_network/node_operators/indexers/faq.md`,
],
},
`${locale}/subquery_network/indexers/plans.md`,
`${locale}/subquery_network/indexers/faq.md`,
{
text: "RPC Providers",
link: `${locale}/subquery_network/node_operators/rpc_providers/introduction.md`,
},
],
},
`${locale}/subquery_network/architects/introduction.md`,
Expand Down
2 changes: 1 addition & 1 deletion docs/subquery_network/delegators/rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For example, Indexer A has set an ICR of 80% and has received SQT from 8 Delegat

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/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.
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.

## Non-reward period

Expand Down
2 changes: 1 addition & 1 deletion docs/subquery_network/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There’s a role for everyone in the network, from highly technical developers t

**Consumers** will ask the SubQuery Network for specific data for their dApps or tools, and pay an advertised amount of SQT for each request. Learn more about [Consumers](./consumers/introduction.md).

**Indexers** will run and maintain high quality SubQuery projects in their own infrastructure, running both the indexer and query service, and will be rewarded in SQT for the requests that they serve. Learn more about [Indexers](./indexers/introduction.md).
**Indexers** will run and maintain high quality SubQuery projects in their own infrastructure, running both the indexer and query service, and will be rewarded in SQT for the requests that they serve. Learn more about [Indexers](./node_operators/indexers/introduction.md).

**Delegators** will participate in the Network by supporting their favourite Indexers to earn rewards based on the work those indexers do. Learn more about [Delegators](./delegators/introduction.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Once your Indexing Service is all set and running successfully, connect to your

At this stage, only Indexers that received kSQT tokens via the airdrop can obtain and participate as Indexers in Kepler. This may change soon as we test and verify that aspects of the Kepler network are running smoothly.

For Kepler, you can obtain kSQT tokens from the [Kepler Airdrop App](https://airdrop.subquery.foundation). Learn more about kSQT and how to add it to your wallet in [kSQT](../token/token.md#ksqt).
For Kepler, you can obtain kSQT tokens from the [Kepler Airdrop App](https://airdrop.subquery.foundation). Learn more about kSQT and how to add it to your wallet in [kSQT](../../token/token.md#ksqt).

## 4. How to index a project

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Restoring Dictionary Projects

Below are the [Dictionary Projects](../../academy/tutorials_examples/dictionary.md) supported on Kepler. These projects are commonly used, are simple to index and create, but create large datasets.
Below are the [Dictionary Projects](../../../academy/tutorials_examples/dictionary.md) supported on Kepler. These projects are commonly used, are simple to index and create, but create large datasets.

In order to speed up the onboarding of Indexers, we are providing database snapshots for most of these dictionaries

Expand Down Expand Up @@ -42,7 +42,7 @@ curl -o dictionary.tar <Download_URL>

## Restoring the Database Snapshot

This assumes that you have an indexer [running locally](../../run_publish/run.md) with admin access to a PostgresQL database (you will be using the `pg_restore` command).
This assumes that you have an indexer [running locally](../../../run_publish/run.md) with admin access to a PostgresQL database (you will be using the `pg_restore` command).

1. First extract the downloaded snapshot and then extract it using the following command:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The following projects are available for indexing on the Kepler network. Some pr
| Astar | Astar Dictionary | `QmUmnKPhcE6JwGMYvY3Yitb5j8qxbQBMxgpkHpVQuXqxDH` | ~65G | N/A | [Yes](./dictionary-restore.md) |

::: info Note
If you are wanting to index a Dictionary, then you may be able to restore your project from our dictionary snapshots to save a lot of time. Instructions are [here](../indexers/dictionary-restore.md)
If you are wanting to index a Dictionary, then you may be able to restore your project from our dictionary snapshots to save a lot of time. Instructions are [here](./dictionary-restore.md)
:::

Enter the project deployment ID when addding the new project.
Expand Down Expand Up @@ -177,6 +177,6 @@ On the network page, the Indexer can check the era information and confirm that

Congratulations! You have successfully indexed your SubQuery Project.

- If you encounter any trouble while running the indexing service, please visit [Troubleshooting](../indexers/troubleshooting-indexers.md)) and find all your solutions in one place.
- If you encounter any trouble while running the indexing service, please visit [Troubleshooting](./troubleshooting-indexers.md)) and find all your solutions in one place.

- Find the list of [FAQs](./faq.md), and resolve your query.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There are plenty of online guies on how to launch a compute engine on various cl
DO NOT skip checking the Indexer Version after you finish the SSH process.
:::

- Visit [this section](../indexers/become-an-indexer.md#_2-1-check-indexer-version) and complete the process.
- Visit [this section](./become-an-indexer.md#_2-1-check-indexer-version) and complete the process.

::: warning Important
Please change the default PostgreSQL password in the `POSTGRES_PASSWORD` field and in the coordinator-service's `postgres-password` field. Replace it with your own one.
Expand Down Expand Up @@ -167,5 +167,5 @@ Add space limit to journald by set up `SystemMaxUse` and `RuntimeMaxUse`
We highly recommend setting up SSL on your new server. [Follow the guide here](./indexer-security-guide.md#ssl-certificate-configuration).

::: tip Tip
Having trouble running a command or setting up the service? Got stuck in the process? Find your solutions [here](../indexers/troubleshooting-indexers.md).
Having trouble running a command or setting up the service? Got stuck in the process? Find your solutions [here](./troubleshooting-indexers.md).
:::
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ chmod +x ipfs/ipfs.sh
```

::: warning Important
DO NOT skip checking the indexer version after you finish the installation process. Visit [this section](../indexers/become-an-indexer.md#_2-1-check-indexer-version) to check the latest indexer version is used and to to complete the set up process.
DO NOT skip checking the indexer version after you finish the installation process. Visit [this section](./become-an-indexer.md#_2-1-check-indexer-version) to check the latest indexer version is used and to to complete the set up process.

Also, please change the default PostgreSQL password in the `POSTGRES_PASSWORD` field and in the coordinator-service's `postgres-password` field in the docker-compose.yml file.
:::
Expand Down Expand Up @@ -78,7 +78,7 @@ Open `http://localhost:8000/` in your browser to view the Indexer App.
We highly recommend setting up SSL on your new server. [Follow the guide here](./indexer-security-guide.md#ssl-certificate-configuration).

:::tip Tip
Having trouble running a command or setting up the service? Got stuck in the process? Find your solutions [here](../indexers/troubleshooting-indexers.md).
Having trouble running a command or setting up the service? Got stuck in the process? Find your solutions [here](./troubleshooting-indexers.md).

If you want to use a separated database for the Indexing service, you can follow [this guide](./separated-db.md) to set up the database and install the Indexing service.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Finally, interested parties should be prepared to invest time in maintaining the

### Staking requirements

Indexers are expected to stake and maintain a minimum amount of tokens. This is to ensure that Indexers have some skin in the game and are committed to supporting the network. SubQuery is yet to determine this but it is one of our [design philosophies](../design/design-philosophy.md) that this be as low and as accessible as possible.
Indexers are expected to stake and maintain a minimum amount of tokens. This is to ensure that Indexers have some skin in the game and are committed to supporting the network. SubQuery is yet to determine this but it is one of our [design philosophies](../../design/design-philosophy.md) that this be as low and as accessible as possible.

Should an Indexer experience a slashable event and their staked SQT balance fall below the minimum required, they will have to top up their staked SQT in order to continue to earn rewards from their work.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Indexers benefit from higher total stake (with the help of delegators) in ways:
For indexers, since these benefits are delicate, it is always a challenge to consider the best strategy, how many delegator's stake do I need.
Too many delegation will dilute the reward, small delegation will limit the opportunity of more rewards. By changing commission rate, indexer can adjust the delegation proportion to a balance point.

You should read more about how Delegators will pick Indexers [here](../delegators/rewards.md#how-to-select-what-indexers-to-delegate-to)
You should read more about how Delegators will pick Indexers [here](../../delegators/rewards.md#how-to-select-what-indexers-to-delegate-to)

The main two aspects of how Delegators will pick indexers is the [Indexer Score from the Indexer Leaderboard](https://kepler.subquery.network/delegator/indexers/top), and the Indexer Commission Rate (ICR). The Indexer’s Commission Rate (ICR) is the percentage Indexers earn. The remaining is then shared amongst the Indexer and all Delegators propotionally by staked/delegated amount. Therefore, Indexers need to decide on the proportion of rewards an Indexer wishes to retain versus the amount to share with their Delegators. A lower ICR will be more attractive for Delegators.

Expand Down
3 changes: 3 additions & 0 deletions docs/subquery_network/node_operators/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Node Operators

SubQuery has a commitment to expanding the SubQuery Network to decentralise both Data Indexers, as well as supercharging RPCs to address a much broader centralisation issue throughout Web3 infrastructure. The SubQuery network will see thousands of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases.
Loading

0 comments on commit d2c74fe

Please sign in to comment.