From b24f93def145f3538a0f229978d25ec1c89277ff Mon Sep 17 00:00:00 2001 From: James Bayly Date: Fri, 19 Apr 2024 10:11:06 +1200 Subject: [PATCH] Typos --- docs/miscellaneous/contributing.md | 6 +++--- docs/miscellaneous/vulnerability-reporting.md | 2 +- docs/subquery_network/architects/publish.md | 8 ++++---- docs/subquery_network/community.md | 2 +- docs/subquery_network/consumers/boosting.md | 4 ++-- docs/subquery_network/consumers/faq.md | 2 +- docs/subquery_network/consumers/introduction.md | 2 +- docs/subquery_network/consumers/plan.md | 10 +++++----- docs/subquery_network/data_node/introduction.md | 6 +++--- docs/subquery_network/data_node/rpc.md | 2 +- docs/subquery_network/delegators/delegating.md | 4 ++-- docs/subquery_network/delegators/introduction.md | 6 +++--- docs/subquery_network/delegators/rewards.md | 10 +++++----- docs/subquery_network/glossary.md | 2 +- docs/subquery_network/introduction/introduction.md | 2 +- .../introduction/reward-distribution.md | 4 ++-- .../node_operators/indexers/index-project.md | 10 +++++----- docs/subquery_network/node_operators/plans.md | 6 +++--- docs/subquery_network/node_operators/rewards.md | 2 +- .../node_operators/setup/becoming-a-node-operator.md | 12 ++++++------ .../node_operators/setup/install-linux.md | 2 +- .../node_operators/setup/install-local-docker.md | 2 +- .../node_operators/setup/security-guide.md | 6 +++--- .../node_operators/setup/separated-db.md | 4 ++-- docs/subquery_network/node_operators/stake.md | 6 +++--- docs/subquery_network/parameters.md | 2 +- docs/subquery_network/token/claim.md | 6 +++--- docs/subquery_network/token/swap.md | 2 +- docs/subquery_network/token/token.md | 2 +- docs/subquery_network/token/tokenomics.md | 2 +- docs/subquery_network/welcome.md | 2 +- 31 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/miscellaneous/contributing.md b/docs/miscellaneous/contributing.md index 14db08e6b73..d62d211e7c2 100644 --- a/docs/miscellaneous/contributing.md +++ b/docs/miscellaneous/contributing.md @@ -21,7 +21,7 @@ We take our open source community projects and responsibility seriously and hold Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: - Search for existing Issues and PRs before creating your own. -- We work hard to makes sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. A friendly @ mention in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. A friendly @ mention in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking. ## How to Contribute @@ -31,8 +31,8 @@ Bugs are tracked as GitHub issues. When logging an issue, explain the problem an - Use a clear and descriptive title for the issue to identify the problem. - Describe the exact steps to reproduce the problem. -- Describe the behavior you observed after following the steps. -- Explain which behavior you expected to see instead and why. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. - Include screenshots if possible. If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) diff --git a/docs/miscellaneous/vulnerability-reporting.md b/docs/miscellaneous/vulnerability-reporting.md index 3772e0e43cc..d38f82b101c 100644 --- a/docs/miscellaneous/vulnerability-reporting.md +++ b/docs/miscellaneous/vulnerability-reporting.md @@ -6,7 +6,7 @@ SubQuery welcomes security vulnerability reports from the public, and we do pay While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. -At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Managed Service](https://managedservice.subquery.network/) and [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a cusomer's codebase we will: +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Managed Service](https://managedservice.subquery.network/) and [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: - Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. - If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). diff --git a/docs/subquery_network/architects/publish.md b/docs/subquery_network/architects/publish.md index 37021bea916..0939c108f43 100644 --- a/docs/subquery_network/architects/publish.md +++ b/docs/subquery_network/architects/publish.md @@ -24,7 +24,7 @@ The SubQuery Network is the future of web3 infrastructure, it allows you to comp ## Deploying your Project -The SubQuery Network is a public permissionless network, anyone can deploy their project freely. To do so, head to the SubQuery Explorer and click "Publish New Project". +The SubQuery Network is a public permission-less network, anyone can deploy their project freely. To do so, head to the SubQuery Explorer and click "Publish New Project". ![Explorer - Publish Button](/assets/img/network/architect_publish.png) @@ -46,7 +46,7 @@ Once entered, click "Publish" to publish your project, you will then be taken to ::: info How to encourage Node Operators to sync your project -At this stage you should reach out to Node Operators in our Discord to encourage them to start syncing it, once they do you will be able to create plans and start quering this data. You might also want to consider [boosting your project](../consumers/boosting.md) to incentivise Node Operators to do so, and in return recieve free queries to it. +At this stage you should reach out to Node Operators in our Discord to encourage them to start syncing it, once they do you will be able to create plans and start querying this data. You might also want to consider [boosting your project](../consumers/boosting.md) to incentivise Node Operators to do so, and in return receive free queries to it. ::: @@ -56,11 +56,11 @@ You can easily make changes to your project or deploy a new version by accessing ![Manage Existing Project](/assets/img/network/architect_manage_project.png) -Firstly, you can publish a new verison by clicking "Deploy New Version". This will let Node Operators know and allow them to upgrade to the new version of your Project. For the deployment you shoud provide: +Firstly, you can publish a new version by clicking "Deploy New Version". This will let Node Operators know and allow them to upgrade to the new version of your Project. For the deployment you should provide: - the deployment CID, you will need to publish your project to IPFS first, [follow the guide here](../../run_publish/publish.md#publish-your-subquery-project-to-ipfs) - a version number, we recommend it follows [semantic versioning rules](https://semver.org/) -- check the box if you want to make this version recommended, this means that you are reccommending Node Operators to immediately update to it. Don't check this if it's a test build or if it has major breaking changes +- check the box if you want to make this version recommended, this means that you are recommending Node Operators to immediately update to it. Don't check this if it's a test build or if it has major breaking changes - the deployment description, which might include additional information for Node Operators about migration steps or breaking changes in this version ![Manage Existing Project - Deploy New Version](/assets/img/network/architect_manage_project_deploy.png) diff --git a/docs/subquery_network/community.md b/docs/subquery_network/community.md index b4019df8965..23ca6d4515b 100644 --- a/docs/subquery_network/community.md +++ b/docs/subquery_network/community.md @@ -14,7 +14,7 @@ When the conversation is deeper and requires more thought, we move the conversat SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). -The following codebases are where you can find code for all the contracts, appliations, and backend SubQuery projects. We're looking forward to seeing your contributions! +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! ### `network-app` diff --git a/docs/subquery_network/consumers/boosting.md b/docs/subquery_network/consumers/boosting.md index 244403e7f3a..54697a4f5b8 100644 --- a/docs/subquery_network/consumers/boosting.md +++ b/docs/subquery_network/consumers/boosting.md @@ -1,6 +1,6 @@ # Consumer Boosting -The idea behind Consumer boosting is to allow Consumers an alternative way of bootstraping projects that they would like to be run across the network. It’s specifically to allow projects to be free to Consumers, while still ensuring that Indexers are best matching supply of indexing compute with demand from Consumers. The end result is: +The idea behind Consumer boosting is to allow Consumers an alternative way of bootstrapping projects that they would like to be run across the network. It’s specifically to allow projects to be free to Consumers, while still ensuring that Indexers are best matching supply of indexing compute with demand from Consumers. The end result is: - The SubQuery market is efficiently matching supply with demand for Consumers' projects. - Consumers can receive heavily discounted (or even free) access to these projects that they boost. @@ -29,7 +29,7 @@ Once you confirm the relevant transactions via your wallet, and wait for a few s ## Manage Existing Boost -You can easily view all existing projects that you have boosed under the Consumer > My Boosted Projects menu. Here you can view total query rewards, as well as add or remove boost from each project. +You can easily view all existing projects that you have boosted under the Consumer > My Boosted Projects menu. Here you can view total query rewards, as well as add or remove boost from each project. ![Manage boost](/assets/img/network/consumer_boosting_manage.png) diff --git a/docs/subquery_network/consumers/faq.md b/docs/subquery_network/consumers/faq.md index 665112ea2b6..7660a5dccb7 100644 --- a/docs/subquery_network/consumers/faq.md +++ b/docs/subquery_network/consumers/faq.md @@ -2,7 +2,7 @@ ## As a Consumer, can I select 1 Indexer or multiple Indexers? -Depending on demand, there will often be multiple Indexers indexing an given SubQuery project and multiple RPC providers for each network. Consumers have the choice when deciding which Node Operator to make agreements with. Typically Consumers would select Node Operators from a combination of cost, reliability, and latency. Consumers could also incorporate automatic failover and read data from another Node Operator if the first one times out or is not responsive. +Depending on demand, there will often be multiple Indexers indexing a given SubQuery project and multiple RPC providers for each network. Consumers have the choice when deciding which Node Operator to make agreements with. Typically Consumers would select Node Operators from a combination of cost, reliability, and latency. Consumers could also incorporate automatic failover and read data from another Node Operator if the first one times out or is not responsive. ## What happens if a Node Operator goes offline? diff --git a/docs/subquery_network/consumers/introduction.md b/docs/subquery_network/consumers/introduction.md index 485ce698aec..92051261d98 100644 --- a/docs/subquery_network/consumers/introduction.md +++ b/docs/subquery_network/consumers/introduction.md @@ -18,7 +18,7 @@ As a Consumer, you can interact with performant RPCs or receive indexed data fro - Faster performance for your dApps. Since your dApps an get data from a decentralised network of Node Operators (RPCs or data indexers), the average latency will be lower and performance higher - Higher reliability. Due to the decentralised nature of the network, your dApp can immediately fall back to an alternative when an RPC provider goes offline. -- Focus on developing your appplication, not on running blockchain infrastructure. +- Focus on developing your application, not on running blockchain infrastructure. - 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 diff --git a/docs/subquery_network/consumers/plan.md b/docs/subquery_network/consumers/plan.md index 7cf66e1ef67..7d810f8fcf7 100644 --- a/docs/subquery_network/consumers/plan.md +++ b/docs/subquery_network/consumers/plan.md @@ -1,8 +1,8 @@ # Creating Plans and Making Requests -Consumers can easily create plans to start quering data from their chosen indexed project via our decentralised netowrk of Node Operators. +Consumers can easily create plans to start querying data from their chosen indexed project via our decentralised network of Node Operators. -Our Flex plan creation process is as strealined as possible and is similar to any centralised alternative, it only takes a few minutes before you have a API key and a single production endpoint that you can query through. +Our Flex plan creation process is as streamlined as possible and is similar to any centralised alternative, it only takes a few minutes before you have a API key and a single production endpoint that you can query through. ## Plan Options @@ -14,7 +14,7 @@ Some Project deployments also have a free public endpoint sponsored by the custo To create a new Flex Plan, the first place to start should be finding your selected Project Deployment on the [SubQuery Network Explorer](https://app.subquery.network/explorer/home). On each project deployment, you will see a button called "Get Endpoint". -You may be asked to chose between the different options for a plan for this Project Deployment. Select Flex Plan to continue, or otherwise consider using a public endpoint. +You may be asked to choose between the different options for a plan for this Project Deployment. Select Flex Plan to continue, or otherwise consider using a public endpoint. ![Consumer Get Endpoint Step 1](/assets/img/network/consumer_get_endpoint_1.png) @@ -42,13 +42,13 @@ You will be prompted to sign and approve a number of transactions. Please follow ### View and Access Endpoint and API key -You can view your personalised endpoint and API key on the final step. This allows you to connect to the endpoint and make queries through SubQuerys Gateway. You can get the endpoint in the future by also navigating to Consumer > My Flex Plans. +You can view your personalised endpoint and API key on the final step. This allows you to connect to the endpoint and make queries through SubQuery's Gateway. You can get the endpoint in the future by also navigating to Consumer > My Flex Plans. This endpoint acts like any other endpoint that you would use for API or RPC calls. In many cases we even show an example query right there for you to copy into your terminal window to try out. API keys can either be sent as a query parameter (`https:://your.endpoint.url/?apikey=`) or as a request header (`'apikey': ''`). ::: warning API keys are private -Never share your API key with anyone, they give access to make queries through your own billing acccount. When using them, keep them private as environment variables and avoid publishing them in public git repositories or on public websites. +Never share your API key with anyone, they give access to make queries through your own billing account. When using them, keep them private as environment variables and avoid publishing them in public git repositories or on public websites. ::: diff --git a/docs/subquery_network/data_node/introduction.md b/docs/subquery_network/data_node/introduction.md index e9141cd2a68..6a209e668de 100644 --- a/docs/subquery_network/data_node/introduction.md +++ b/docs/subquery_network/data_node/introduction.md @@ -1,10 +1,10 @@ # Introduction -The performance limitations of data indexers and many other decentralised applications have long been limited by the RPC endpoint. Developers have long focused on building nodes to ensure efficient validation, ensuring the safety of the network. As a result of this sacrifice, RPCs are extremely costly, and they're not at all optimized for querying. +The performance limitations of data indexers and many other decentralised applications have long been limited by the RPC endpoint. Developers have long focused on building nodes to ensure efficient validation, ensuring the safety of the network. As a result of this sacrifice, RPCs are extremely costly, and they're not at all optimised for querying. This is compounded by the rise of L2 chains, where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. -The **SubQuery Data Node** solves this; it's an enhanced RPC node that is perfectly optimized for querying, especially on endpoints like `eth_getLogs`, and provides the ability to filter transactions in a single API call. The Data Node will be open source, allowing people to contribute, extend, or fork the implementation in any way. It will support leading layer-2s and other EVM networks initially, and they will be optimised to run on the SubQuery Network in a decentralised way. +The **SubQuery Data Node** solves this; it's an enhanced RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLogs`, and provides the ability to filter transactions in a single API call. The Data Node will be open source, allowing people to contribute, extend, or fork the implementation in any way. It will support leading layer-2s and other EVM networks initially, and they will be optimised to run on the SubQuery Network in a decentralised way. Working together, the SubQuery Indexer and SubQuery Data Node will provide the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. Our node runners will be able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. @@ -56,6 +56,6 @@ Running SubQuery data nodes is the same as running the unforked nodes but there Later, SubQuery will work to democratise RPCs (and [solve EIP-4444](https://blog.subquery.network/using-the-subquery-sharded-data-node-to-solve-eip-4444/?lng=en)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. EIP-4444 focuses on the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth. SubQuery believes that in order to drive decentralisation of RPCs, you need to be able to make running these nodes easier and more accessible to everyday users. -SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery's Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimize further for query performance rather than validation and verification. +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery's Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. You can read more about how the sharded data node will solve EIP-4444 [here](https://blog.subquery.network/using-the-subquery-sharded-data-node-to-solve-eip-4444/?lng=en). diff --git a/docs/subquery_network/data_node/rpc.md b/docs/subquery_network/data_node/rpc.md index e122012665e..308b92c0345 100644 --- a/docs/subquery_network/data_node/rpc.md +++ b/docs/subquery_network/data_node/rpc.md @@ -31,7 +31,7 @@ type Capability = { // Describes the possible response data fields that can be returned. These are defined by us. e.g 'basic', 'complete', 'trace' supportedResponses: ('basic', 'complete')[]; genesisHash: string; // The chains first block hash, used to identify the network - chainId: string; // The identifier of the network, with ethereum this is a decimal string + chainId: string; // The identifier of the network, with Ethereum this is a decimal string } ``` diff --git a/docs/subquery_network/delegators/delegating.md b/docs/subquery_network/delegators/delegating.md index 762d810a8df..6abecd5ffe3 100644 --- a/docs/subquery_network/delegators/delegating.md +++ b/docs/subquery_network/delegators/delegating.md @@ -16,7 +16,7 @@ Ensure you have ether for gas fees. Ether needs to be on the Base network. More ![Delegate Node Operator List](/assets/img/network/delegate_indexers.png) -Select your source for the delegation (it can be your wallet, or from an existing delegation amount) and enter an amount. Click on `Delegate`. You will be asked to confirm your transaction with Metamask. Please wait for a while after confirming the transaction. +Select your source for the delegation (it can be your wallet, or from an existing delegation amount) and enter an amount. Click on `Delegate`. You will be asked to confirm your transaction with your wallet. Please wait for a while after confirming the transaction. ![Delegate to a Node Operator part 2](/assets/img/network/delegate_action.png) @@ -36,7 +36,7 @@ To undelegate from a Node Operator, navigate to `Delegator` -> `Delegating`. ![Undelegate from a Node Operator](/assets/img/network/delegate_status.png) -Click on `Undelegate` and enter the amount of SQT you want to undelegate. Then click `Confirm Undelegation`. You will be asked to confirm your transaction with Metamask. Confirm it and wait for a few seconds. +Click on `Undelegate` and enter the amount of SQT you want to undelegate. Then click `Confirm Undelegation`. You will be asked to confirm your transaction with your wallet. Confirm it and wait for a few seconds. ![Confirm undelegate](/assets/img/network/delegate_undelegate.png) diff --git a/docs/subquery_network/delegators/introduction.md b/docs/subquery_network/delegators/introduction.md index 0bc36829061..dbbc91b2079 100644 --- a/docs/subquery_network/delegators/introduction.md +++ b/docs/subquery_network/delegators/introduction.md @@ -4,11 +4,11 @@ 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, Node Operators would likely earn fewer rewards because they will have less SQT to stake. Therefore, Node Operators compete to attract Delegators by offering a competitive share of an Node Operator's rewards. +Without Delegators, Node Operators would likely earn fewer rewards because they will have less SQT to stake. Therefore, Node Operators compete to attract Delegators by offering a competitive share of a Node Operator's rewards. ## Requirements to be a Delegator -One of the best things about being a Delegator is that you don’t need any devops, coding, or technical experience. Basic understanding of the SubQuery Network is all that is required to become a Delegator. +One of the best things about being a Delegator is that you don’t need any DevOps, coding, or technical experience. Basic understanding of the SubQuery Network is all that is required to become a Delegator. ## Benefits of being a Delegator @@ -25,4 +25,4 @@ Even though it is not considered a risky role, being a Delegator includes a few 1. 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](../introduction/era.md) has been completed, giving time for delegators to assess and make any changes. 2. 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 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. +Once a preferred Node Operator(s) is found, due diligence should be performed to check a 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. diff --git a/docs/subquery_network/delegators/rewards.md b/docs/subquery_network/delegators/rewards.md index 830297608c0..88332296f2d 100644 --- a/docs/subquery_network/delegators/rewards.md +++ b/docs/subquery_network/delegators/rewards.md @@ -14,7 +14,7 @@ Node Operators are free to [set this rate to any value they desire](../node_oper Delegators will only receive revenue for staking [Eras](../introduction/era.md) 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 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](../introduction/era.md). 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). +If a 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](../introduction/era.md). 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). ![Token economic flow](/assets/img/network/token_economy.png) @@ -22,7 +22,7 @@ If an Node Operator wishes to increase the Node Operator Commission Rate that th You need to assess a few things when deciding on what Node Operator to choose. -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. +Node Operators set a 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, Node Operator A has set an NOCR of 30% 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 70% 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 20%, then the 8 delegators and Node Operator would share proportionally rewards from the remaining 80% of rewards. In short, the lower the NOCR - the better it is for Delegators. @@ -30,7 +30,7 @@ Note that Delegators must have delegated their tokens for the entire [Era](../in Node Operators also have a maximum delegation capacity based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. The current multiple for delegation capacity can be found on our [network parameters](../parameters.md) page. -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://app.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. +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://app.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 a Data Indexer’s uptime, slashing events, and other parameters. ## Non-reward period @@ -42,7 +42,7 @@ If a Delegator decides to undelegate their SQT, a lock period starts ([see lengt ## Delegation Lifecycle -Delegators delegate (deposit) SQT into an Node Operator’s contract. +Delegators delegate (deposit) SQT into a Node Operator’s contract. Delegators can then decide how much to redelegate to each Node Operator of their choice. @@ -52,7 +52,7 @@ After the unlocking period has been completed, tokens become available for withd ::: info You can redelegate without waiting for the unlocking period -If you want to switch your delegation from one Node Operator to another, you can avoid the undelegation lock period by instead redelegating. When you initially delegate to an Node Operator, you can instead select another Node Operator's delegation as the source of funds to redelegate. +If you want to switch your delegation from one Node Operator to another, you can avoid the undelegation lock period by instead redelegating. When you initially delegate to a Node Operator, you can instead select another Node Operator's delegation as the source of funds to redelegate. ::: diff --git a/docs/subquery_network/glossary.md b/docs/subquery_network/glossary.md index c844007bdbe..a3551670f77 100644 --- a/docs/subquery_network/glossary.md +++ b/docs/subquery_network/glossary.md @@ -66,7 +66,7 @@ Act of Indexer restaking SQT during the lock period to return locked period toke ## **Contract Ratio** -The sum of daily contracts value (defined as contract value/period) can not exceed a ratio with their total stake (indexer + delegator). +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). ## **Era** diff --git a/docs/subquery_network/introduction/introduction.md b/docs/subquery_network/introduction/introduction.md index 991b954688c..7f7fb26c3ce 100644 --- a/docs/subquery_network/introduction/introduction.md +++ b/docs/subquery_network/introduction/introduction.md @@ -10,7 +10,7 @@ We’re building the most open, performant, reliable, and scalable web3 infrastr The SubQuery Network is facilitating an open web3 data revolution by allowing you to completely decentralise your infrastructure stack. -_SubQuery will aim to power the future plethora of serverless applications in different blockchain ecosystems and accelerate our transition to a decentralised future._ +_SubQuery will aim to power the future plethora of server-less applications in different blockchain ecosystems and accelerate our transition to a decentralised future._ ![The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner](/assets/img/network/technical_stack.png) diff --git a/docs/subquery_network/introduction/reward-distribution.md b/docs/subquery_network/introduction/reward-distribution.md index 7eba4e2bbc6..92154e12be1 100644 --- a/docs/subquery_network/introduction/reward-distribution.md +++ b/docs/subquery_network/introduction/reward-distribution.md @@ -25,7 +25,7 @@ Additionally, for Node Operators, running projects incurs significant costs. Wit The solution to this comes from network inflation as a reward source for Indexer rewards, in addition to rewards for productive work. We allow Consumers to use [Boosting](../consumers/boosting.md) to direct Network Inflation Rewards, which distributed to Node Operators proportionally based on the total boosted SQT on their projects. -In order to receive network inflaton rewards, Node Operators must be running a project that has a non-zero amount of consumer boosting, and be online/available to the public with a sync progress of 100%. Node Operators will not receive all of the network inflation rewards, some rewards are distributed to the Consumers that boosted the project, as described in [Consumer Boosting](../consumers/boosting.md#how-are-boosters-rewarded). +In order to receive network inflation rewards, Node Operators must be running a project that has a non-zero amount of consumer boosting, and be online/available to the public with a sync progress of 100%. Node Operators will not receive all of the network inflation rewards, some rewards are distributed to the Consumers that boosted the project, as described in [Consumer Boosting](../consumers/boosting.md#how-are-boosters-rewarded). Network inflation rewards are allocated to all project types supported by the SubQuery Network, e.g data indexing projects and RPC endpoints. The split of network inflation rewards between the Consumer that boosted the project, and the Node Operator may vary by project type. @@ -51,4 +51,4 @@ Delegated SQT to a Node Operator do not count towards the Node Operators minimum ::: -If an Node Operator is caught misbehaving (such as by providing invalid, incomplete, or incorrect data), they are liable to have a portion of their staked SQT (on the particular reward pool ip) reallocated to the SubQuery Foundation Treasury, diminishing their holdings of staked SQT in the network and therefore their potential reward. Since the Node Operator's allocated stake is determined by a percentage of their total SQT, this will have a flow on effect to all other reward pools that the Node Operator is party to. +If a Node Operator is caught misbehaving (such as by providing invalid, incomplete, or incorrect data), they are liable to have a portion of their staked SQT (on the particular reward pool ip) reallocated to the SubQuery Foundation Treasury, diminishing their holdings of staked SQT in the network and therefore their potential reward. Since the Node Operator's allocated stake is determined by a percentage of their total SQT, this will have a flow on effect to all other reward pools that the Node Operator is party to. diff --git a/docs/subquery_network/node_operators/indexers/index-project.md b/docs/subquery_network/node_operators/indexers/index-project.md index 66d49dcd93f..46e293d888a 100644 --- a/docs/subquery_network/node_operators/indexers/index-project.md +++ b/docs/subquery_network/node_operators/indexers/index-project.md @@ -16,11 +16,11 @@ Depending on where the application has been installed, you may find the Indexer ### 1.2 Request Approval -Click `Get Started` and then select `Approve`. Then MetaMask will pop up, asking you to sign this transaction. +Click `Get Started` and then select `Approve`. Then your wallet will pop up, asking you to sign this transaction. ### 1.3 Register Indexer -Fill in the details to register your Indexer and confirm the MetaMask transaction. +Fill in the details to register your Indexer and confirm the wallet transaction. ![Register MetMask-Confirm Transaction](/assets/img/network/indexer_registration.png) @@ -40,13 +40,13 @@ Now, two accounts will appear on the screen. The Indexer Account where you can u The Controller, a distinct and seperate account that must be created, holds a small amount of Eth tokens to facilitate Indexer configuration updates and run day to day operations. -Updating a Indexer configuration is a signable event. That means it is an on-chain update that requires transaction fees to be paid (in Eth). +Updating a Indexer configuration is a sign-able event. That means it is an on-chain update that requires transaction fees to be paid (in Eth). Click `Managed Controllers` and then select `Create an Account`. This adds an account that you will need to fund with some tokens. Then set the account to `Active`. ![Add Controller](/assets/img/network/indexer_controller_add.png) -Activating a controller is an on-chain signable event. +Activating a controller is an on-chain sign-able event. Once the controller account is added, it should appear as follows: @@ -111,7 +111,7 @@ The following projects are available for indexing on the Mainnet network. Some p 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. +Enter the project deployment ID when adding the new project. ![Add a New Project Using Deploy ID](/assets/img/network/indexer_project_add.png) diff --git a/docs/subquery_network/node_operators/plans.md b/docs/subquery_network/node_operators/plans.md index d859e069ae5..00ffd475b8e 100644 --- a/docs/subquery_network/node_operators/plans.md +++ b/docs/subquery_network/node_operators/plans.md @@ -20,13 +20,13 @@ Enter a price (in SQT) and the Deployment ID that you want to create the plan fo ![Set plan parameters](/assets/img/network/plans_price.png) -You will see a pop-up to confirm your transaction with Metamask. Click on `Confirm` and wait for a few seconds. Then you will see a default plan created in the `Default` tab. +You will see a pop-up to confirm your transaction with your wallet. Click on `Confirm` and wait for a few seconds. Then you will see a default plan created in the `Default` tab. ![Default plan created](/assets/img/network/plans.png) :::info Early Stages of Mainnet will automatically select your plan -Note, for early stages of the Mainnet, the SubQuery council will automatically select and create agreements from the best node operators based off your plans. You don't need to do anything else here to be selected apart from performing your key role as an Node Operator. +Note, for early stages of the Mainnet, the SubQuery council will automatically select and create agreements from the best node operators based off your plans. You don't need to do anything else here to be selected apart from performing your key role as a Node Operator. ::: @@ -41,7 +41,7 @@ To create or view your existing Flex plans, on the Node Operator Admin App, navi Click `Enable Flex Plan` to enable flex plan pricing for this particular project. You can then enter the following settings - The price per 1,000 requests. A good starting place is 1 kSQT or SQT per 1,000 requests -- A validity period. This is for how long the pricing will be valid for consumers that take this up. E.g. if a new consumer opens a state channel with your Flex plan, they are garanteed this price for this many days once that channel is opened. A longer number of days gives greater price certainty, but reduces the Node Operators ability to adjust prices to match costs. A good starting place is 7 days. +- A validity period. This is for how long the pricing will be valid for consumers that take this up. E.g. if a new consumer opens a state channel with your Flex plan, they are guaranteed this price for this many days once that channel is opened. A longer number of days gives greater price certainty, but reduces the Node Operators ability to adjust prices to match costs. A good starting place is 7 days. ![Flex Plan Create](/assets/img/network/flex-plan-create.png) diff --git a/docs/subquery_network/node_operators/rewards.md b/docs/subquery_network/node_operators/rewards.md index 325397883e5..c728a95d432 100644 --- a/docs/subquery_network/node_operators/rewards.md +++ b/docs/subquery_network/node_operators/rewards.md @@ -51,7 +51,7 @@ There are several indicators that need to be considered when selecting a project ### Boosted SQT and Booster Rewards -When a deployment has a large amout of [Boosted SQT](../consumers/boosting.md) allocated to it, it means a potential larger share of [network inflation rewards](../introduction/reward-distribution.md#network-inflation-rewards) for all Node Operators running this deployment. Network Inflation rewards will likely be the largest source of rewards in the early stage of the SubQuery network as it bootstraps. +When a deployment has a large amount of [Boosted SQT](../consumers/boosting.md) allocated to it, it means a potential larger share of [network inflation rewards](../introduction/reward-distribution.md#network-inflation-rewards) for all Node Operators running this deployment. Network Inflation rewards will likely be the largest source of rewards in the early stage of the SubQuery network as it bootstraps. ### Query Fee Opportunities 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 35839add8f9..79f153c058b 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 @@ -22,7 +22,7 @@ Welcome to this guide on how to become a Node Operator. Let's take an overview o For those who are new to SubQuery, it is recommended to try running the Node Operator Service on your local machine first. For **intermediate to advanced users**, it is recommended to set up a VM on AWS (or similar) to host your Node Operator service. -**Select the appropriate link to follow the guide to setup an Node Operator:** +**Select the appropriate link to follow the guide to setup a Node Operator:** - [Locally via Docker (easy)](./install-local-docker.md) - [Linux](./install-linux.md) @@ -39,13 +39,13 @@ Please return here after following these guides. ### Port configurations -Here are the recommended port configurations for running an Node Operator service: +Here are the recommended port configurations for running a Node Operator service: - Port `8000 / TCP`: This port should be configured to only allow access from your own IP address, used by `indexer_coordinator`. - Port `7370 / UDP`: This port can be opened to the public and used for broadcasting data to multiple clients or nodes in a peer-to-peer network, used by `indexer_proxy`. - Port `80 / HTTP`: This port can be opened to the public and used by `indexer_proxy`. -It's important to ensure that these ports are properly configured and secured to prevent any unauthorized access or security breaches. +It's important to ensure that these ports are properly configured and secured to prevent any unauthorised access or security breaches. ### Docker @@ -106,13 +106,13 @@ Guides to setup RPC endpoints will come shortly. For the initial stages of Mainnet, the SubQuery Council will set some default plan templates to make plan management and creation easier. As a result, plan creation is very easy and just requires to you enter a price. [See the guide here](../plans.md#creating-a-plan). -## 6. Configure an Node Operator Commission Rate (NOCR) +## 6. Configure a Node Operator Commission Rate (NOCR) Please update your Node Operator Commission Rate (NOCR) in order to attract more Delegators. You can [read more about this here](../rewards.md#how-to-attract-delegators). You can do this by viewing your Node Operator Delegators page, and you can change it by clicking `Change commission rate` ![Viewing your NOCR](/assets/img/network/indexer_icr.png) -Enter a new value (in a percent) and submit via Metamask. +Enter a new value (in a percent) and submit via your wallet. ![Changing your NOCR](/assets/img/network/indexer_icr_change.png) @@ -175,7 +175,7 @@ Once you have successfully logged in, look for 'dashboards' on the left-hand sid ## 9. Upgrade Node Operator services (Ongoing) -To upgrade an 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. +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. Once the image version has been updated in the docker-compose file, you can restart the specific container that needs to be upgraded. This can be done by running the following command in the terminal: diff --git a/docs/subquery_network/node_operators/setup/install-linux.md b/docs/subquery_network/node_operators/setup/install-linux.md index 3a5909222ff..7c3c4ddf28f 100644 --- a/docs/subquery_network/node_operators/setup/install-linux.md +++ b/docs/subquery_network/node_operators/setup/install-linux.md @@ -12,7 +12,7 @@ Note: You can use any other cloud providers, we will try our best to provide sup ### Step 1 - Launch a Virtual Machine -There are plenty of online guies on how to launch a compute engine on various cloud providers, including AWS, GCP, Azure, Digital Ocean etc. You can follow [this tutorial to launch a new EC2 on AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) (we recommend a compute engine equivalent to a [t3.medium](https://aws.amazon.com/ec2/instance-types/) linux EC2) +There are plenty of online guides on how to launch a compute engine on various cloud providers, including AWS, GCP, Azure, Digital Ocean etc. You can follow [this tutorial to launch a new EC2 on AWS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html) (we recommend a compute engine equivalent to a [t3.medium](https://aws.amazon.com/ec2/instance-types/) linux EC2) ### Step 2 - Install Docker and Docker-Compose diff --git a/docs/subquery_network/node_operators/setup/install-local-docker.md b/docs/subquery_network/node_operators/setup/install-local-docker.md index a50c68eef05..8d0cdb00cee 100644 --- a/docs/subquery_network/node_operators/setup/install-local-docker.md +++ b/docs/subquery_network/node_operators/setup/install-local-docker.md @@ -19,7 +19,7 @@ Now, let's explore how to run the Node Operator Service Locally step-by-step. ## Step 1 - Download the Indexer Service file -- Donwload node operator services `docker-compose.yml` file to you machine, which consists of all the images to build and start the various applications. +- Download node operator services `docker-compose.yml` file to you machine, which consists of all the images to build and start the various applications. ```bash mkdir subquery-indexer && cd subquery-indexer diff --git a/docs/subquery_network/node_operators/setup/security-guide.md b/docs/subquery_network/node_operators/setup/security-guide.md index f6beaae4723..8d69040a2dc 100644 --- a/docs/subquery_network/node_operators/setup/security-guide.md +++ b/docs/subquery_network/node_operators/setup/security-guide.md @@ -77,7 +77,7 @@ ufw-docker status ### Docker -The Coordinator has unrestricted access to your host's Docker, which can pose security risks if not adequately shielded. If the machine is solely utilized for running SubQuery services, Node Operators should contemplate applying specific Docker security measures. Refer to documentation on SeLinux or AppArmor for further insights. +The Coordinator has unrestricted access to your host's Docker, which can pose security risks if not adequately shielded. If the machine is solely utilised for running SubQuery services, Node Operators should contemplate applying specific Docker security measures. Refer to documentation on SeLinux or AppArmor for further insights. ### Other Best Practices @@ -88,7 +88,7 @@ The Coordinator has unrestricted access to your host's Docker, which can pose se SSL certificate is an important way to secure your Node Operator service and encrypt traffic between your query service and the Consumers requesting data from it. It's a good idea to obtain an SSL certificate for any professional service and SubQuery is no different. Additionally, a SSL certificate is required for when a Consumer access a website via SSL and that website is requesting data from your SubQuery project. -**Since it's such a standard best practice, although it's not required, we rank Node Operators higher in the Node Operator leaderboard if they have SSL enabled. You can tell if an Node Operator has SSL enabled by confirming that the `Proxy Server Endpoint` in Node Operator's metadata starts with `https` instead of `http`.** +**Since it's such a standard best practice, although it's not required, we rank Node Operators higher in the Node Operator leaderboard if they have SSL enabled. You can tell if a Node Operator has SSL enabled by confirming that the `Proxy Server Endpoint` in Node Operator's metadata starts with `https` instead of `http`.** ### Enabling SSL @@ -153,7 +153,7 @@ server { } -# link the new configution with a symlink to your edited file +# link the new configuration with a symlink to your edited file sudo ln -s /etc/nginx/sites-available/proxy.mysqindexer.com /etc/nginx/sites-enabled/proxy.mysqindexer.com ``` diff --git a/docs/subquery_network/node_operators/setup/separated-db.md b/docs/subquery_network/node_operators/setup/separated-db.md index a4969fdcd5f..70e219fb93a 100644 --- a/docs/subquery_network/node_operators/setup/separated-db.md +++ b/docs/subquery_network/node_operators/setup/separated-db.md @@ -31,7 +31,7 @@ sudo ufw allow from to ### Step 1 - Download the Indexer Service file -- Donwloand indexing services `docker-compose.yml` file to you machine, which consists of all the images to build and start the various applications. +- Download indexing services `docker-compose.yml` file to your machine, which consists of all the images to build and start the various applications. ```bash mkdir subquery-indexer && cd subquery-indexer @@ -48,7 +48,7 @@ chmod +x ipfs/ipfs.sh - Update the `docker-compose.yml` file with the database information. ```bash -# 1. remove or commment the postgres section +# 1. remove or comment the postgres section # postgres: # image: postgres:16-alpine # container_name: indexer_db diff --git a/docs/subquery_network/node_operators/stake.md b/docs/subquery_network/node_operators/stake.md index be18988911d..f0a7cf2c802 100644 --- a/docs/subquery_network/node_operators/stake.md +++ b/docs/subquery_network/node_operators/stake.md @@ -19,7 +19,7 @@ Node Operators can always see their current own stake, total delegation, and any At the top of the page shows the current staking amount (and the amount that is estimated for the next Era). - Own Stake: This is the total current amount of SQT that you as the Node Operator has staked. Remember, you must meet a minimum ratio here to delegated stake - see [how much SQT should you stake](#how-much-sqt-should-you-stake). -- Total Delegation: This is the total amount of delegated SQT to you as an Node Operator. +- Total Delegation: This is the total amount of delegated SQT to you as a Node Operator. - Unallocated Stake: This is the amount of stake that is not allocated to any project deployment. **You should always try to minimise this to as close to 0**. See how to [allocate stake](#allocating-stake). - Over Allocated Stake: **This is really bad** - please immediately see [over allocated stake](#over-allocated-stake). @@ -49,7 +49,7 @@ Remember, both network inflation rewards and query rewards (for Flex plans) dist :::danger -This is really bad. When your stake is overallocated, your receive 0 rewards for that the period of time that it is over allocated - immediately fix this! +This is really bad. When your stake is over-allocated, your receive 0 rewards for that the period of time that it is over allocated - immediately fix this! ::: @@ -68,4 +68,4 @@ There are multiple reasons why Node Operators should consider staking more SQT o - More total stake means more SQT to allocate on different deployments the Node Operator runs and more Network Inflation Rewards to earn. - It provides an advantage over other Node Operators when payment method is flex plan (PAYG) due to the way the [Cobb-Douglas function](../introduction/reward-distribution.md#cobb-douglas-production-function) works. -In order to become an Node Operator on the SubQuery Network, you must stake a minimum number of SQT. In addition, you will want to attract delegators to [increase the rewards that you receive](./rewards.md). +In order to become a Node Operator on the SubQuery Network, you must stake a minimum number of SQT. In addition, you will want to attract delegators to [increase the rewards that you receive](./rewards.md). diff --git a/docs/subquery_network/parameters.md b/docs/subquery_network/parameters.md index 9fddd32a561..8005e9ab046 100644 --- a/docs/subquery_network/parameters.md +++ b/docs/subquery_network/parameters.md @@ -8,7 +8,7 @@ The SubQuery technical council is constantly adjusting various parameters of the | Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | | Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | | Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | -| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Tresury | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | | Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | | Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | | Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | diff --git a/docs/subquery_network/token/claim.md b/docs/subquery_network/token/claim.md index 9b0062eb058..9f9b86d2853 100644 --- a/docs/subquery_network/token/claim.md +++ b/docs/subquery_network/token/claim.md @@ -8,7 +8,7 @@ To claim your subquery tokens, visit [https://claim.subquery.foundation](https:/ ![SQT claim page](/assets/img/network/claim_page.png) -The first step token is to connect your ERC20 compatiable crypto wallet. We recommend either Metamask, Talisman, Rainbow, or any other WalletConnect compatiable wallet. +The first step token is to connect your ERC20 compatible crypto wallet. We recommend either Metamask, Talisman, Rainbow, or any other WalletConnect compatible wallet. ![connect wallet](/assets/img/network/claim_connect_wallet.png) @@ -21,7 +21,7 @@ If claiming your public sale tokens, you must use the same wallet address you pa Select the appropriate account and then click next. You may have to approve to switch the network connection to the Base network. -The SubQuery Token Claim claim page should load up showing any token allocation that you have permission to claim. Once the tokens have been generated and allocated on the token generation date, the balance should reflect your correct amount. +The SubQuery Token Claim page should load up showing any token allocation that you have permission to claim. Once the tokens have been generated and allocated on the token generation date, the balance should reflect your correct amount. ![claim page](/assets/img/network/claim_page_tokens.png) @@ -73,4 +73,4 @@ If you get an “Unknown error”, check that you have opened the Ethereum accou If you have any other issues, please contact our #public-sale-support channel on [Discord](https://discord.com/invite/subquery). - + diff --git a/docs/subquery_network/token/swap.md b/docs/subquery_network/token/swap.md index 31b699f1061..b34e2c49263 100644 --- a/docs/subquery_network/token/swap.md +++ b/docs/subquery_network/token/swap.md @@ -40,7 +40,7 @@ After this step, you will now have kSQT on Polygon - the contract address of SQT We recommend using official bridges like [Polygon Portal](https://portal.polygon.technology/bridge). SubQuery can't be responsible for the use of any third party bridges. -You will want to brige from `Polygon POS`, not `Polygon zkEVM` - the token address for SQT on Polygon POS is [`0xc52F0f8361835B53A18408BB44d7f4136f0EF69D`](https://polygonscan.com/token/0xc52F0f8361835B53A18408BB44d7f4136f0EF69D#balances). +You will want to bridge from `Polygon POS`, not `Polygon zkEVM` - the token address for SQT on Polygon POS is [`0xc52F0f8361835B53A18408BB44d7f4136f0EF69D`](https://polygonscan.com/token/0xc52F0f8361835B53A18408BB44d7f4136f0EF69D#balances). In the [Polygon Portal bridge](https://portal.polygon.technology/bridge), when selecting tokens, you can click `+ Add Token` and then enter the SubQuery Token Address on Polygon `0xc52F0f8361835B53A18408BB44d7f4136f0EF69D` diff --git a/docs/subquery_network/token/token.md b/docs/subquery_network/token/token.md index 801949a42b6..ed8771ff906 100644 --- a/docs/subquery_network/token/token.md +++ b/docs/subquery_network/token/token.md @@ -31,7 +31,7 @@ SQT is supported on the [Crypto.com](https://crypto.com/price/subquery-network) SQT is supported on [Gate.io](https://www.gate.io).Gate.io is a cryptocurrency exchange platform offering a wide range of digital assets, advanced trading features, and security measures for global users. Spot trade SQT/USDT on Gate at [https://www.gate.io/trade/SQT_USDT](https://www.gate.io/trade/SQT_USDT) - Ethereum and Base deposits and withdrawls only. -SQT is on a number of DEX Pools however most liqudity is on Uniswap. Please ensure that you are trading the correct SQT token (see contract addresses above) +SQT is on a number of DEX Pools however most liquidity is on Uniswap. Please ensure that you are trading the correct SQT token (see contract addresses above) - Uniswap Pool on Ethereum: [https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) - Unsiwap Pool on Base: [https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) diff --git a/docs/subquery_network/token/tokenomics.md b/docs/subquery_network/token/tokenomics.md index 602aa967f11..77935ff253e 100644 --- a/docs/subquery_network/token/tokenomics.md +++ b/docs/subquery_network/token/tokenomics.md @@ -1,6 +1,6 @@ # Tokenomics -**Total Supply**: The total supply will initally be 10 Billion SQT tokens. +**Total Supply**: The total supply will initially be 10 Billion SQT tokens. **Inflation**: SubQuery Network is inflationary, you can see the current rate on the [parameters page](../parameters.md). This will be used to help the SubQuery Foundation bootstrap the network by supporting Node Operators during the early launch phase where Consumers numbers will still be growing, as well as contribute funds to the SubQuery Foundation treasury. Read more about [network inflation rewards here](../introduction/reward-distribution.md#network-inflation-rewards). diff --git a/docs/subquery_network/welcome.md b/docs/subquery_network/welcome.md index d0e758f2a7a..a17b164228e 100644 --- a/docs/subquery_network/welcome.md +++ b/docs/subquery_network/welcome.md @@ -172,7 +172,7 @@ const oneNetworkAllWeb3 = ref([ title: 'Decentralised Data Indexers', subtitle: 'Fast, reliable, decentralised, and customised APIs for your web3 project', contents: [ - "SubQuery APIs make your dApp lighting quick. By providing a indexed data layer, your dApps get richer data faster to allow you to build intuitive and immersive experiences for your users.", + "SubQuery APIs make your dApp lighting quick. By providing an indexed data layer, your dApps get richer data faster to allow you to build intuitive and immersive experiences for your users.", "Easy to build, test, deploy, and run, SubQuery’s Data Indexer makes dApp development a breeze." ], },