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

Commit 8fe5632

Browse files
committed
fix links
1 parent 46812b1 commit 8fe5632

File tree

8 files changed

+43
-30
lines changed

8 files changed

+43
-30
lines changed

apps/nextra/next.config.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,11 @@ export default withBundleAnalyzer(
397397
destination: "/en/build/indexer/indexer-sdk/quickstart",
398398
permanent: true,
399399
},
400+
{
401+
source: "/indexer/indexer-sdk/documentation",
402+
destination: "/en/build/indexer/indexer-sdk/documentation",
403+
permanent: true,
404+
},
400405
{
401406
source: "/indexer/indexer-sdk/documentation/setup",
402407
destination: "/en/build/indexer/indexer-sdk/documentation/setup",

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 and SDK. This is only relevant to you if you are developing a custom processor with the [Indexer SDK](../indexer/indexer-sdk.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 with the [Indexer SDK](./indexer/indexer-sdk.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/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/indexer-sdk.mdx

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,6 @@ Learn how to use the Indexer SDK through guides and documentation.
2626
</Card>
2727
</Cards>
2828

29-
## Architecture of the Indexer SDK
30-
31-
In the Aptos indexing stack, a processor indexes a specific subset of data from the blockchain and ingests the data into an external database.
32-
33-
Each processor follows this general flow:
34-
35-
1. Receive a stream of Aptos transactions
36-
2. Extract the relevant data from the transactions
37-
3. Transform and merge the extracted data into a coherent, standardized schema
38-
4. Store the transformed data into a database
39-
40-
The Aptos Indexer SDK allows you to write and model each of your processor as a graph of independent `Step`'s'.
41-
Each `Step` has an input and an output, and the output of one `Step` is connected to the input of another `Step` by a channel.
42-
The flow above can be modeled as a graph of `Step`'s connected by channels.
43-
44-
The Indexer SDK's architecture simplifies writing custom processors in several ways:
45-
46-
1. You can reuse `Step` implementations across processors which reduces duplication of common data extraction logic.
47-
2. The SDK collects basic performance metrics, like the number of transactions processed, for each `Step`, which enables observability into subcomponents of the processor.
48-
3. Since each `Step` is independent, you can safely customize parts of the processor without breaking the other pieces.
49-
For example, you can add additional `Step`'s to pre/post-process data or batch data writes. Each `Step` can also be tested in isolation from the rest of the processor.
5029

5130
## Example Processors
5231
As a reference, you can see all Aptos-Hosted processors that comprise the Indexer API [here](https://github.com/aptos-labs/aptos-indexer-processors).
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Documentation"
3+
---
4+
import { Callout } from 'nextra/components'
5+
import { IndexerBetaNotice } from '@components/index';
6+
7+
# Documentation
8+
9+
## Architecture of the Indexer SDK
10+
11+
In the Aptos indexing stack, a processor indexes a specific subset of data from the blockchain and ingests the data into an external database.
12+
13+
Each processor follows this general flow:
14+
15+
1. Receive a stream of Aptos transactions
16+
2. Extract the relevant data from the transactions
17+
3. Transform and merge the extracted data into a coherent, standardized schema
18+
4. Store the transformed data into a database
19+
20+
The Aptos Indexer SDK allows you to write and model each of your processor as a graph of independent `Step`'s'.
21+
Each `Step` has an input and an output, and the output of one `Step` is connected to the input of another `Step` by a channel.
22+
The flow above can be modeled as a graph of `Step`'s connected by channels.
23+
24+
The Indexer SDK's architecture simplifies writing custom processors in several ways:
25+
26+
1. You can reuse `Step` implementations across processors which reduces duplication of common data extraction logic.
27+
2. The SDK collects basic performance metrics, like the number of transactions processed, for each `Step`, which enables observability into subcomponents of the processor.
28+
3. Since each `Step` is independent, you can safely customize parts of the processor without breaking the other pieces.
29+
For example, you can add additional `Step`'s to pre/post-process data or batch data writes. Each `Step` can also be tested in isolation from the rest of the processor.

apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/parsing-txns.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Fundamentally an indexer processor is just something that consumes a stream of a
1717

1818
## What is a transaction?
1919

20-
A transaction is a unit of execution on the Aptos blockchain. If the execution of the program in a transaction (e.g. starting with an entry function in a Move module) is successful, the resulting change in state will be applied to the ledger. Learn more about the transaction lifecycle at [this page](../../../network/blockchain/blockchain-deep-dive.mdx#life-of-a-transaction).
20+
A transaction is a unit of execution on the Aptos blockchain. If the execution of the program in a transaction (e.g. starting with an entry function in a Move module) is successful, the resulting change in state will be applied to the ledger. Learn more about the transaction lifecycle at [this page](../../../../network/blockchain/blockchain-deep-dive.mdx#life-of-a-transaction).
2121

2222
There are four types of transactions on Aptos:
2323

@@ -28,7 +28,7 @@ There are four types of transactions on Aptos:
2828

2929
The first 3 of these are internal to the system and are not relevant to most processors; we do not cover them in this guide.
3030

31-
Generally speaking, most user transactions originate from a user calling an entry function in a Move module deployed on chain, for example `0x1::coin::transfer`. In all other cases they originate from [Move scripts](../../smart-contracts/scripts.mdx). You can learn more about the different types of transactions [here](../../../network/blockchain/txns-states.mdx#types-of-transaction-payloads).
31+
Generally speaking, most user transactions originate from a user calling an entry function in a Move module deployed on chain, for example `0x1::coin::transfer`. In all other cases they originate from [Move scripts](../../../../smart-contracts/scripts.mdx). You can learn more about the different types of transactions [here](../../../../network/blockchain/txns-states.mdx#types-of-transaction-payloads).
3232

3333
A user transaction that a processor handles contains a variety of information. At a high level it contains:
3434

@@ -47,7 +47,7 @@ The payload is what the user submits to the blockchain when they wish to execute
4747
- The address + module name + function name of the function being executed.
4848
- The arguments to the function.
4949

50-
There is other potentially interesting information in the payload that you can learn about at [this page](../../../network/blockchain/txns-states.mdx#contents-of-a-transaction).
50+
There is other potentially interesting information in the payload that you can learn about at [this page](../../../../network/blockchain/txns-states.mdx#contents-of-a-transaction).
5151

5252
### Events
5353

apps/nextra/pages/en/build/indexer/txn-stream/aptos-hosted-txn-stream.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { IndexerBetaNotice } from '@components/index';
88

99
<IndexerBetaNotice />
1010

11-
If you are running your own instance of the [Indexer API](../../indexer.mdx), or a [custom processor](../custom-processors.mdx), you must have access to an instance of the Transaction Stream Service. This page contains information about how to use the Aptos Labs Hosted Transaction Stream Service.
11+
If you are running your own instance of the [Indexer API](../../indexer.mdx), or an [Indexer SDK](../indexer-sdk.mdx) custom processor, you must have access to an instance of the Transaction Stream Service. This page contains information about how to use the Aptos Labs Hosted Transaction Stream Service.
1212

1313
## Endpoints
1414

apps/nextra/pages/en/network/nodes/localnet/local-development-network.mdx

Lines changed: 1 addition & 1 deletion
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
{/* TODO: replace API spec link */}
119119
- [Node API](../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](../../../build/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](../../../build/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 with the [Indexer SDK](../../../build/indexer/indexer-sdk.mdx).
121+
- [Transaction Stream Service](../../../build/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 an[Indexer SDK](../../../build/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](../../../build/apis/faucet-api.mdx): You can use this to fund accounts on your local network.
124124

0 commit comments

Comments
 (0)