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

Featured SubQuery #16

Open
wants to merge 1 commit into
base: master
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
2 changes: 2 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
* [Bridging to Moonbeam](blockchain-layer-1/bridging-to-moonbeam.md)
* [Deployed smart contracts](blockchain-layer-1/deployed-smart-contracts.md)
* [Other blockchains](blockchain-layer-1/other-blockchains.md)
* [Indexers](indexers/overview.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be moved under OriginTrail Parachain section (line 43), as it is indexer only for OriginTrail Parachain.

* [SubQuery](indexers/subquery.md)

## Useful Resources

Expand Down
7 changes: 7 additions & 0 deletions indexers/overview.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 the OriginTrail network.
21 changes: 21 additions & 0 deletions indexers/subquery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# SubQuery Indexer
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you merge this file into one above, and put this as section inside of it


## 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 OriginTrail, Polkadot, Cosmos, Ethereum, Polygon, Algorand, NEAR, and Avalanche.

Another Subquery's competitive edge lies in the capacity to consolidate data, not just within a single blockchain but across multiple blockchains within a unified project. This facilitates the development of comprehensive dashboard analytics, cross-chain block scanners, or initiatives aimed at indexing XCM messages across parachains.

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)
- [OriginTrail Starter Project](https://github.com/subquery/subql-starter/tree/main/OriginTrail/origintrail-starter)
Copy link
Collaborator

Choose a reason for hiding this comment

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

OriginTrail is an ecosystem and there are Decentralized Knowledge Graph (DKG - Layer 2) and OriginTrail Parachain (Layer 1). So precise naming here would be Origintrail-parachain-starter


Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you provide more information from the starter project here, how it can be used, not only useful resource and link to the starter project. Also it is important to point out that this is only indexing transfers from balances pallet, as OriginTrail community is generally more interested in the indexing of evm events on OriginTrail parachain, so some guides how to achieve that would be useful

## Running and Hosting your OriginTrail 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 OriginTrail from launch.