Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SubQuery Featured #2917

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

SubQuery Featured #2917

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6a61e1b
SubQuery Featured
bgodlin Mar 17, 2024
51ed147
Update docs/tools/subquery.md
bgodlin Mar 19, 2024
723508e
Update docs/tools/subquery.md
bgodlin Mar 19, 2024
0c13bb7
Update docs/tools/subquery.md
bgodlin Mar 19, 2024
c757311
Update docs/tools/subquery.md
bgodlin Mar 19, 2024
a52ea0b
Apply suggestions from code review
bgodlin Mar 29, 2024
8a18d69
Apply suggestions from code review
bgodlin Mar 30, 2024
14a6a42
Apply suggestions from code review
bgodlin Apr 11, 2024
f3baf93
Update subquery.md
bgodlin Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/tools/subquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
order: 5
---

# SubQuery Indexer

SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open source and decentralised APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralised applications in a faster and more efficient way. SubQuery supports 150+ ecosystems including Iris, Cosmos, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche.
bgodlin marked this conversation as resolved.
Show resolved Hide resolved

Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a comma after "blockchains" for better readability and changing "multi-chain" to "multichain" for consistency with industry terminology.

- across multiple blockchains all within a single project
+ across multiple blockchains, all within a single project
- multi-chain block scanners
+ multichain block scanners
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones.
Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains, all within a single project. This allows the creation of feature-rich dashboard analytics, multichain block scanners, or projects that index IBC transactions across zones.


## Useful resources

- SubQuery Docs: [SubQuery Academy (Documentation)](https://academy.subquery.network/)
- Intro Quick Start Guide: [1. Create a New Project](https://academy.subquery.network/quickstart/quickstart.html)
- [Starter Project](https://github.com/subquery/cosmos-subql-starter/tree/main/Iris/iris-starter)

For technical questions and support reach out to us `[email protected]`
bgodlin marked this conversation as resolved.
Show resolved Hide resolved

## Running and Hosting your Iris SubQuery APIs

SubQuery is open-source, meaning you have the freedom to run it in the following three ways:

- Locally on your own computer (or a cloud provider of your choosing), [view the instructions on how to run SubQuery Locally](https://academy.subquery.network/run_publish/run.html).
- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using "production-ready" as a hyphenated compound adjective to modify "services" and "mission-critical" with a hyphen when used as a compound adjective.

- production ready services
+ production-ready services
- mission critical data
+ mission-critical data
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).
- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrases "production ready" and "mission critical" are often hyphenated when used as compound adjectives. Consider adding hyphens to improve readability.

- production ready services for mission critical data
+ production-ready services for mission-critical data
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production ready services for mission critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).
- You can publish it to SubQuery's enterprise-level [Managed Service](https://managedservice.subquery.network/), where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. [Find out how](https://academy.subquery.network/run_publish/publish.html).

- You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document uses British English spelling for "decentralised" and "incentivised". Ensure consistency in spelling conventions throughout the document. If the target audience primarily uses American English, consider changing to "decentralized" and "incentivized".

- decentralised
+ decentralized
- incentivised
+ incentivized
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch.
- You can publish it to the decentralized [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivized and verifiable way and supports Iris from launch.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document uses British English spelling for "decentralised" and "incentivised". If the target audience primarily uses American English, consider changing to "decentralized" and "incentivized".

- decentralised
+ decentralized
- incentivised
+ incentivized
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- You can publish it to the decentralised [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Iris from launch.
- You can publish it to the decentralized [SubQuery Network](https://subquery.network/network), the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivized and verifiable way and supports Iris from launch.