Skip to content

Commit f9865d1

Browse files
authored
[indexer] fix broken links (#861)
1 parent 8b2d322 commit f9865d1

File tree

2 files changed

+8
-13
lines changed

2 files changed

+8
-13
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { IndexerBetaNotice } from '@components/index';
99
This guide will walk you through setting up the basic template for a new processor.
1010

1111
## Pre-requisites
12-
You've already set up your environment and have the Indexer SDK `aptos-indexer-sdk` and `aptos-indexer-sdk-server-framework` installed.
12+
You've already set up your environment and have the Indexer SDK `aptos-indexer-sdk` installed.
1313
If you haven't, follow the [Indexer SDK installation guide](./setup.mdx).
1414

1515
## Overview
@@ -25,9 +25,9 @@ The next section goes through each of these pieces more explicitly and provides
2525
The `IndexerProcessorConfig` defines the base configuration for all processors that you'll be running.
2626
It should include configuration for things that are shared across multiple processors, like the database configuration and [Transaction Stream](../../txn-stream.mdx) configuration.
2727

28-
[`ServerArgs`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/blob/main/aptos-indexer-processors-sdk/sdk-server-framework/src/lib.rs#L26) parses a `config.yaml` file and bootstraps a server with all the common pieces to run a processor.
28+
`ServerArgs` parses a `config.yaml` file and bootstraps a server with all the common pieces to run a processor.
2929

30-
To setup the configuration for your processor and make it work with `ServerArgs`, you'll need to define a `IndexerProcessorConfig` that implements the [`RunnableConfig`](https://github.com/aptos-labs/aptos-indexer-processor-sdk/blob/main/aptos-indexer-processors-sdk/sdk-server-framework/src/lib.rs#L102) trait.
30+
To setup the configuration for your processor and make it work with `ServerArgs`, you'll need to define a `IndexerProcessorConfig` that implements the `RunnableConfig` trait.
3131
It also triggers a run method, which can be invoked in `main.rs`.
3232

3333
For basic cases, you can copy the [`IndexerProcessorConfig` from the `aptos-indexer-processor-example`](https://github.com/aptos-labs/aptos-indexer-processor-example/blob/main/aptos-indexer-processor-example/src/config/indexer_processor_config.rs) repository and modify it to fit your needs.

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

+5-10
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,15 @@ The quickstart guide provides a template processor and includes all of this setu
99

1010
If you're migrating an existing processor to the Indexer SDK, follow the steps below.
1111

12-
The Indexer SDK provides several Rust crates:
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.
18-
19-
Depending on your use case, you can import the crates to your `Cargo.toml`.
12+
Add `aptos-indexer-processor-sdk` to your `Cargo.toml`.
2013

2114
```toml
2215
[dependencies]
2316
aptos-indexer-processor-sdk = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
24-
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" }
25-
aptos-indexer-testing-framework = { git = "https://github.com/aptos-labs/aptos-indexer-processor-sdk.git", rev = "aptos-indexer-processor-sdk-v1.0.0" }
2617
```
2718

19+
`aptos-indexer-processor-sdk` includes the following features:
20+
1. `postgres_full` - Interface layer to integrate Postgres with your processor.
21+
2. `testing_framework` - An e2e testing framework for testing processors. If you want to write tests for your processor, add this feature to the crate.
22+
2823
{/* <!-- Add list of SDK releases once we have that --> */}

0 commit comments

Comments
 (0)