diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 6d6c2a6..8989dad 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -266,6 +266,7 @@ module.exports = { "/developers/ethereum-contracts", "/developers/querying", "/developers/price-feeder", + "/developers/indexers", ], }, { diff --git a/docs/developers/indexers.md b/docs/developers/indexers.md new file mode 100644 index 0000000..47aad0c --- /dev/null +++ b/docs/developers/indexers.md @@ -0,0 +1,26 @@ +# Indexers + +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 UX network. + +## SubQuery + +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 UX, Cosmos, Ethereum, Polygon, Polkadot, Algorand, NEAR, 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, multi-chain block scanners, or projects that index IBC transactions across zones. + +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) +- [UX Indexer Starter Project](https://github.com/subquery/cosmos-subql-starter/tree/main/ux/ux-starter) +- For technical questions and support reach out to us start@subquery.network + +### Running and Hosting your UX 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 UX from launch. diff --git a/docs/developers/querying.md b/docs/developers/querying.md index a4c135b..2a32586 100644 --- a/docs/developers/querying.md +++ b/docs/developers/querying.md @@ -96,3 +96,7 @@ $ grpcurl -d '{"address": "umee17lu4h5nh28ctv9y6ldt0apqz7dxm8arvttx5xc"}' --plai } } ``` + +## Indexers + +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. [Read more](./indexers.md). \ No newline at end of file