diff --git a/docs/.vuepress/public/assets/img/network/indexer_auto_allocation.png b/docs/.vuepress/public/assets/img/network/indexer_auto_allocation.png new file mode 100644 index 00000000000..91322fbbd24 Binary files /dev/null and b/docs/.vuepress/public/assets/img/network/indexer_auto_allocation.png differ diff --git a/docs/subquery_network/node_operators/setup/becoming-a-node-operator.md b/docs/subquery_network/node_operators/setup/becoming-a-node-operator.md index 681f21ae49a..ce00a8741f4 100644 --- a/docs/subquery_network/node_operators/setup/becoming-a-node-operator.md +++ b/docs/subquery_network/node_operators/setup/becoming-a-node-operator.md @@ -16,9 +16,10 @@ Let's take an overview of the basic steps involved in the process: | [Step 4](#4-index-or-sync-a-project) | Index a project or sync an RPC endpoint | | [Step 5](#5-create-a-plan-from-a-plan-template) | Create a Plan from a Plan Template | | [Step 6](#6-configure-a-node-operator-commission-rate-nocr) | Set a Node Operator Commission Rate | -| [Step 7](#7-troubleshooting-and-faqs) | Troubleshooting and FAQs | -| [Step 8](#8-setting-up-a-grafana-dashboard-optional) | Optional: Setting up a Grafana Dashboard | -| [Step 9](#9-upgrade-node-operator-services-ongoing) | Ongoing: Update Node Operator Services | +| [Step 7](#7-allocate-your-sqt-stake-to-start-receiving-rewards) | Allocate your SQT to start receiving rewards | +| [Step 8](#8-troubleshooting-and-faqs) | Troubleshooting and FAQs | +| [Step 9](#9-setting-up-a-grafana-dashboard-optional) | Optional: Setting up a Grafana Dashboard | +| [Step 10](#10-upgrade-node-operator-services-ongoing) | Ongoing: Update Node Operator Services | ## 1. Deploy Node Operator Services @@ -119,11 +120,19 @@ Enter a new value (in a percent) and submit via your wallet. Changes will come into effect at the start of the next [Era](../../introduction/era.md). -## 7. Troubleshooting and FAQs +## 7. Allocate your SQT stake to start receiving rewards + +You must [actively allocate or assign your staked and delegated SQT to certain projects](../stake.md#allocating-stake) you run in order to receive rewards. Unallocated SQT is essentially wasted. + +We suggest you check this page at the start of each Era, and make sure you are keeping on top to maximise allocated SQT, and also allocate SQT to more profitable projects (e.g. ones with a higer APY). [Find out how here](../stake.md#allocating-stake). + +We also highly recommend that you enable [Auto Reduce Over Allocation](../stake.md#automatically-reduce-over-allocation) to prevent being over allocated. + +## 8. Troubleshooting and FAQs Visit [Troubleshooting](./troubleshooting.md) or [FAQs](./faq.md) if you run into technical issues. -## 8. Setting up a Grafana Dashboard (Optional) +## 9. Setting up a Grafana Dashboard (Optional) This guide will walk you through setting up a preconfigured Grafana Dashboard to view metrics from the `indexer-coordinator` and `indexer-proxy`. @@ -174,7 +183,7 @@ Once you have successfully logged in, look for 'dashboards' on the left-hand sid ![grafana_query_count](/assets/img/network/grafana_query_count.png) ![grafana_query_stats](/assets/img/network/grafana_query_stats.png) -## 9. Upgrade Node Operator services (Ongoing) +## 10. Upgrade Node Operator services (Ongoing) To upgrade a Node Operator service, you will need to update the version of the image used in the docker-compose file. This can be done by updating the image field in the service definition to the new version you want to use. diff --git a/docs/subquery_network/node_operators/stake.md b/docs/subquery_network/node_operators/stake.md index f0a7cf2c802..312d650ce3b 100644 --- a/docs/subquery_network/node_operators/stake.md +++ b/docs/subquery_network/node_operators/stake.md @@ -1,8 +1,8 @@ # Staking and Allocating SQT -:::tip New for Mainnet - Please read +:::info -One key difference between Kepler and the mainnet is that now Node Operators must actively manage their staking allocation to each project deployment. +Node Operators must actively manage their staking allocation to each project deployment to maximise their rewards. We also highly recommend that you enable [Auto Reduce Over Allocation](#automatically-reduce-over-allocation) to prevent being [over allocated](#over-allocated-stake). ::: @@ -59,6 +59,25 @@ When the Current Total Stake bar turns red, you are over allocated. You must imm You can use the estimate of the Own Stake and Total Delegated for the next Era on this page to avoid situations where departing delegators might result in you over allocating. +## Automatically Reduce Over Allocation + +:::info + +We highly recommend that you enable this feature + +::: + +In your Node Operator Admin App and in the Config section there is a setting called "Auto Reduce Over Allocation", we highly recommend that you enable it. + +If enabled, in the event of when you are overallocated, then your allocaton will automaticaly evenly reduce across all of your projects until you are no longer over allocated +- Allocation reduction will be by an even percent. For example, each project will decrease by 10% of it's initial allocation. +- Allocation will not be reduced below 1 SQT on any single project +- If you have 0 projects then it will un-allocate all SQT + +It runs immediately at the start of the next era when delegation changes take effect. + +![Enabling Node Operator Auto Reduce Allocation](/assets/img/network/indexer_auto_allocation.png) + ## How much SQT should you Stake There are multiple reasons why Node Operators should consider staking more SQT or attracting more Delegation.