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.

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

SubQuery featured #728

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/dapp/indexers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Overview

Indexers, in a broad context, play a fundamental role in organising and optimising data retrieval within various systems. These tools act as navigational aids, allowing efficient access to specific information by creating structured indexes. In the realm of databases and information management, indexers enhance query performance by creating a roadmap to swiftly locate data entries.

In the context of blockchain and dApps, indexers go beyond traditional databases, facilitating streamlined access to on-chain data. This includes transaction histories, smart contract states, and event logs. In the dynamic and decentralised world of blockchain, indexers contribute to the efficiency of data queries, supporting real-time updates and ensuring the seamless functionality of diverse applications and platforms.

There are several indexer solutions available, each offering different levels of decentralisation, ease of development, and performance for you to consider. These solutions serve as intermediaries to assist in indexing Oasis Emerald and Oasis Sapphire networks.
22 changes: 22 additions & 0 deletions docs/dapp/indexers/subquery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# SubQuery Indexer

## Intro

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 100+ ecosystems including Oasis Emerald, Oasis Sapphire, Ethereum, Near, Polygon, Polkadot, Algorand, and Avalanche.

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 and multi-chain block scanners.

Other advantages include superior performance with multiple RPC endpoint configurations, multi-worker capabilities and a configurable caching architecture. To find out more, visit our [documentation](https://academy.subquery.network/).

**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)
- [Oasis Starter Projects](https://github.com/subquery/ethereum-subql-starter/tree/main/Oasis)
- For technical questions and support reach out to us `[email protected]`

## Running and Hosting your Oasis 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).
- 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 Oasis from launch.
11 changes: 11 additions & 0 deletions sidebarDapp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,16 @@ export const sidebarDapp: SidebarsConfig = {
},
],
},
{
type: 'category',
label: 'Indexers',
link: {
type: 'doc',
id: 'dapp/indexers/README',
},
items: [
'dapp/indexers/subquery',
],
},
],
};