Skip to content

Commit

Permalink
move data indexers (#1139)
Browse files Browse the repository at this point in the history
  • Loading branch information
briwylde08 authored Dec 16, 2024
1 parent bd1735b commit 6b5d747
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 9 deletions.
14 changes: 14 additions & 0 deletions config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ const sidebars: SidebarsConfig = {
{ type: 'ref', id: 'data/hubble/README', label: 'Hubble'},
{ type: 'ref', id: 'data/horizon/README', label: 'Horizon'},
{ type: 'ref', id: 'data/galexie/README', label: 'Galexie'},
{ type: 'ref', id: 'data/data-indexers/README', label: 'Data Indexers'},
],
tools: [
{
Expand Down Expand Up @@ -101,6 +102,19 @@ const sidebars: SidebarsConfig = {
collapsible: false,
},
],
data_indexers: [
{
type: 'category',
label: 'Data Indexers',
items: [
{
type: "autogenerated",
dirName: "data/data-indexers",
},
],
collapsible: false,
},
],
};

export default sidebars;
2 changes: 1 addition & 1 deletion docs/build/guides/dapps/frontend-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@ This is made possible by using the `server.getEvents` method which allows you to

We will be editing the `CounterPage` component to read events from the counter smart contract immediately the page loads to get the initial counter value and update instead of using "Unknown". Before we continue, please take a look at the [contract code](https://github.com/stellar/soroban-examples/blob/main/events/src/lib.rs). In the contract code, an event named `increment` is emitted whenever the `increment` function is called. It is published over 2 topics, `increment` and `COUNTER` and we need to listen to these topics to get the events.

The topics are stored in a data type called `symbol` and we will need to convert both `increment` and `COUNTER` to `symbol` before we can use them in the [`server.getEvents`](https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents) method. At maximum, stellar RPCs keep track of events for 7 days and you can query events that happened within the last 7 days, so if you need to store events for longer, you may need to make use of an [indexer](/docs/tools/developer-tools/data-indexers).
The topics are stored in a data type called `symbol` and we will need to convert both `increment` and `COUNTER` to `symbol` before we can use them in the [`server.getEvents`](https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents) method. At maximum, stellar RPCs keep track of events for 7 days and you can query events that happened within the last 7 days, so if you need to store events for longer, you may need to make use of an [indexer](/docs/data/data-indexers/README.mdx).

To use events,we edit our counter page and add the following code:

Expand Down
4 changes: 2 additions & 2 deletions docs/data/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,13 @@ You can [run your own instance of Horizon](./horizon/admin-guide/README.mdx) or

Galexie is a tool for exporting Stellar ledger metadata to external data storage. Learn more about its [use cases](./galexie/README.mdx) and how to [run](./galexie/admin_guide/README.mdx) your own instance of Galexie.

## [Data Indexers](../tools/developer-tools/data-indexers.mdx)
## [Data Indexers](./data-indexers/README.mdx)

Data indexers are specialized tools that process and index blockchain data, making it more accessible and queryable to end users. They transform raw blockchain data into a more structured format that’s easier for end users to interact with.

Data indexers have advanced querying capabilities and enhanced analytics. They provide features such as statistical analysis of blockchain activity, visualization of transaction flows, or tracking DeFi metrics — capabilities that go beyond basic transaction lookup for current or historical state data.

Data indexers are a potentially more user-friendly, cost-effective choice for users. Check out several available data indexers for the Stellar network in our [Tools section](../tools/developer-tools/data-indexers.mdx).
Data indexers are a potentially more user-friendly, cost-effective choice for users.

## [Analytics Platforms](../tools/developer-tools/analytics-platforms.mdx)

Expand Down
12 changes: 12 additions & 0 deletions docs/data/data-indexers/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 10
title: Data Indexer Introduction
---

## Data Indexers

Data indexers are specialized tools that process and index blockchain data, making it more accessible and queryable to end users. They transform raw blockchain data into a more structured format that’s easier for end users to interact with.

Data indexers have advanced querying capabilities and enhanced analytics. They provide features such as statistical analysis of blockchain activity, visualization of transaction flows, or tracking DeFi metrics — capabilities that go beyond basic transaction lookup for current or historical state data.

Data indexers are a potentially more user-friendly, cost-effective choice for users.
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Data Indexers
description: Explore a suite of developer tools for Stellar, including indexers.
sidebar_label: Data Indexers
sidebar_position: 60
sidebar_position: 20
title: Ecosystem Data Indexer Providers
---

# Data Indexers
## Data Indexers

To power your applications, a range of data services will be available from data indexers with query interfaces. These indexers will allow you to easily store and retrieve decoded ledger data, contract event emissions, and more. You can focus more energy on making your project successful, and waste less time figuring out precisely how to get the important data from the network.

Expand Down
6 changes: 5 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ const config: Config = {
docId: "data/galexie/README",
label: "Galexie",
},

{
type: 'doc',
docId: "data/data-indexers/README",
label: "Data Indexers",
},
]
},
{
Expand Down

0 comments on commit 6b5d747

Please sign in to comment.