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

Commit 46812b1

Browse files
committed
feedback
1 parent d236cdb commit 46812b1

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Learn how to use the Indexer SDK through guides and documentation.
2929
## Architecture of the Indexer SDK
3030

3131
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-
As a reference, you can see all Aptos-Hosted processors that comprise the Indexer API [here](https://github.com/aptos-labs/aptos-indexer-processors).
3332

3433
Each processor follows this general flow:
3534

@@ -48,3 +47,6 @@ The Indexer SDK's architecture simplifies writing custom processors in several w
4847
2. The SDK collects basic performance metrics, like the number of transactions processed, for each `Step`, which enables observability into subcomponents of the processor.
4948
3. Since each `Step` is independent, you can safely customize parts of the processor without breaking the other pieces.
5049
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.
50+
51+
## Example Processors
52+
As a reference, you can see all Aptos-Hosted processors that comprise the Indexer API [here](https://github.com/aptos-labs/aptos-indexer-processors).

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ title: "Initial Setup"
55
# Initial Setup
66

77
If you're creating a custom processor from scratch, we recommend following the [Quickstart Guide](../quickstart.mdx).
8+
The quickstart guide provides a template processor and includes all of this setup.
89

9-
If you're looking to use the Indexer SDK in an existing Rust project, follow the steps below.
10+
If you're migrating an existing processor to the Indexer SDK, follow the steps below.
1011

1112
The Indexer SDK provides several Rust crates:
12-
1. `aptos-indexer-processor-sdk` - The core SDK that provides the building blocks for creating a processor.
13-
2. `aptos-indexer-processor-sdk-server-framework` - A server framework for creating a server that runs the processor and includes health checks and metrics logging probes.
14-
3. `aptos-indexer-testing-framework` - An e2e testing framework for testing processors.
13+
1. [`aptos-indexer-processor-sdk`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/sdk) - The core SDK that provides the building blocks for writing a processor.
14+
2. [`aptos-indexer-processor-sdk-server-framework`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/sdk-server-framework) - A server framework for creating a server that runs the processor and includes health checks and metrics logging probes.
15+
If you're setting up a server to host your processor, you will need to include this crate.
16+
3. [`aptos-indexer-testing-framework`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/tree/main/aptos-indexer-processors-sdk/testing-framework) - An e2e testing framework for testing processors.
17+
If you want to write tests for your processor, you will need to include this crate.
1518

16-
Depending on what you need, you can choose to include one or more of these crates in your project.
17-
18-
To your `Cargo.toml`, add
19+
Depending on your use case, you can import the crates to your `Cargo.toml`.
1920

2021
```yaml
2122
aptos-indexer-processor-sdk = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
2223
aptos-indexer-processor-sdk-server-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
2324
aptos-indexer-testing-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
2425
```
2526

26-
2727
{/* <!-- Add list of SDK releases once we have that --> */}

0 commit comments

Comments
 (0)