Skip to content

Commit

Permalink
Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Apr 18, 2024
1 parent 7c35036 commit b24f93d
Show file tree
Hide file tree
Showing 31 changed files with 69 additions and 69 deletions.
6 changes: 3 additions & 3 deletions docs/miscellaneous/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/vulnerability-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
8 changes: 4 additions & 4 deletions docs/subquery_network/architects/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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.

:::

Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/subquery_network/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions docs/subquery_network/consumers/boosting.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/subquery_network/consumers/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/subquery_network/consumers/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/subquery_network/consumers/plan.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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)

Expand Down Expand Up @@ -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=<APIKEY>`) or as a request header (`'apikey': '<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.

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/subquery_network/data_node/introduction.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/subquery_network/data_node/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
```
Expand Down
4 changes: 2 additions & 2 deletions docs/subquery_network/delegators/delegating.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)

Expand Down
Loading

0 comments on commit b24f93d

Please sign in to comment.