Skip to content
This repository was archived by the owner on Jul 30, 2025. It is now read-only.

Commit e582226

Browse files
authored
Add section for Indexer SDK (#756)
* indexer sdk * add initial setup page * add steps page * fix lint * remove documentation.mdx * feedback * fix links
1 parent 63bb7a4 commit e582226

File tree

19 files changed

+482
-494
lines changed

19 files changed

+482
-494
lines changed

apps/nextra/next.config.mjs

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -393,13 +393,28 @@ export default withBundleAnalyzer(
393393
permanent: true,
394394
},
395395
{
396-
source: "/indexer/custom-processors/e2e-tutorial",
397-
destination: "/en/build/indexer/custom-processors/e2e-tutorial",
396+
source: "/indexer/indexer-sdk/quickstart",
397+
destination: "/en/build/indexer/indexer-sdk/quickstart",
398398
permanent: true,
399399
},
400400
{
401-
source: "/indexer/custom-processors/parsing-txns",
402-
destination: "/en/build/indexer/custom-processors/parsing-txns",
401+
source: "/indexer/indexer-sdk/documentation",
402+
destination: "/en/build/indexer/indexer-sdk/documentation",
403+
permanent: true,
404+
},
405+
{
406+
source: "/indexer/indexer-sdk/documentation/setup",
407+
destination: "/en/build/indexer/indexer-sdk/documentation/setup",
408+
permanent: true,
409+
},
410+
{
411+
source: "/indexer/indexer-sdk/documentation/steps",
412+
destination: "/en/build/indexer/indexer-sdk/documentation/steps",
413+
permanent: true,
414+
},
415+
{
416+
source: "/indexer/indexer-sdk/documentation/parsing-txns",
417+
destination: "/en/build/indexer/indexer-sdk/documentation/parsing-txns",
403418
permanent: true,
404419
},
405420
{

apps/nextra/pages/en/build/cli/running-a-local-network.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ As you can see from the example output in step 4, once the local network is runn
118118
119119
- [Node API](../../network/nodes/aptos-api-spec.mdx): This is a REST API that runs directly on the node. It enables core write functionality such as transaction submission and a limited set of read functionality, such as reading account resources or Move module information.
120120
- [Indexer API](../indexer/aptos-hosted.mdx): This is a [GraphQL](https://graphql.org/) API that provides rich read access to indexed blockchain data. If you click on the URL for the Indexer API above, by default [http://127.0.0.1:8090](http://127.0.0.1:8090/), it will open the Hasura Console, a web UI that will help you query the Indexer GraphQL API.
121-
- [Transaction Stream Service](../indexer/txn-stream.mdx): This is a gRPC stream of transactions used by the Indexer API. This is only relevant to you if you are developing a [custom processor](../indexer/custom-processors.mdx).
121+
- [Transaction Stream Service](../indexer/txn-stream.mdx): This is a gRPC stream of transactions used by the Indexer API and SDK. This is only relevant to you if you are developing a [Indexer SDK](../indexer/indexer-sdk.mdx) custom processor.
122122
- [Postgres](https://www.postgresql.org/): This is the database that the Indexer processors write to. The Indexer API reads from this database.
123123
- [Faucet](../apis/faucet-api.mdx): You can use this to fund accounts on your local network.
124124
@@ -166,7 +166,7 @@ const client = new Aptos(config);
166166
Sometimes while developing it is helpful to reset the local network back to its initial state, for example:
167167
168168
- You made backwards incompatible changes to a Move module, and you'd like to redeploy it without renaming it or using a new account.
169-
- You are building a [custom indexer processor](../indexer/custom-processors.mdx) and would like to index using a fresh network.
169+
- You are building an [Indexer SDK](../indexer/indexer-sdk.mdx) custom processor and would like to index using a fresh network.
170170
- You want to clear all on chain state, e.g. accounts, objects, etc.
171171
172172
To start with a brand new local network, use the `--force-restart` flag:

apps/nextra/pages/en/build/indexer.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@ If the hosted Indexer API is not enough, you can customize and host your own ver
107107
<Card.Title>Architecture</Card.Title>
108108
<Card.Description>Detailed layout of the Indexer's architecture.</Card.Description>
109109
</Card>
110-
<Card href="indexer/custom-processors">
111-
<Card.Title>Custom Processors</Card.Title>
112-
<Card.Description>Customize way data is processed and shared in the Indexer</Card.Description>
110+
<Card href="indexer/indexer-sdk">
111+
<Card.Title>Indexer SDK</Card.Title>
112+
<Card.Description>Create a custom processor with the Indexer SDK</Card.Description>
113113
</Card>
114114
<Card href="indexer/txn-stream">
115115
<Card.Title>Transaction Streaming Service</Card.Title>

apps/nextra/pages/en/build/indexer/_meta.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ export default {
1616
type: "separator",
1717
title: "Indexer Customizations (Advanced)",
1818
},
19-
"custom-processors": {
20-
title: "Custom Processors",
19+
"indexer-sdk": {
20+
title: "Indexer SDK",
2121
},
2222
"txn-stream": {
2323
title: "Transaction Stream Service",

apps/nextra/pages/en/build/indexer/architecture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Here is how the Indexer creates that API at a high-level:
2929
/>
3030
</center>
3131

32-
The Indexer uses the [Transaction Stream Service](./txn-stream.mdx) and [Custom Processors](./custom-processors.mdx) to update a database with rich tables. Then it exposes an API for Aptos apps to access the consolidated data.
32+
The Indexer uses the [Transaction Stream Service](./txn-stream.mdx) and custom processors written with the [Indexer SDK](./indexer-sdk.mdx) to update a database with rich tables. Then it exposes an API for Aptos apps to access the consolidated data.
3333

34-
For situations where you need to go beyond the Aptos hosted Indexer API data, you will want to create a [custom processor](./custom-processors.mdx).
34+
For situations where you need to go beyond the Aptos hosted Indexer API data, you will want to create a custom processor with the Indexer SDK (./indexer-sdk.mdx).
3535

3636
Writing a custom processor can help you:
3737
1. Get access to different types of data.

apps/nextra/pages/en/build/indexer/custom-processors.mdx

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)