You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/create-processor.mdx
+3-3
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ import { IndexerBetaNotice } from '@components/index';
9
9
This guide will walk you through setting up the basic template for a new processor.
10
10
11
11
## 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.
13
13
If you haven't, follow the [Indexer SDK installation guide](./setup.mdx).
14
14
15
15
## Overview
@@ -25,9 +25,9 @@ The next section goes through each of these pieces more explicitly and provides
25
25
The `IndexerProcessorConfig` defines the base configuration for all processors that you'll be running.
26
26
It should include configuration for things that are shared across multiple processors, like the database configuration and [Transaction Stream](../../txn-stream.mdx) configuration.
27
27
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.
29
29
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.
31
31
It also triggers a run method, which can be invoked in `main.rs`.
32
32
33
33
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.
Copy file name to clipboardexpand all lines: apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/setup.mdx
+5-10
Original file line number
Diff line number
Diff line change
@@ -9,20 +9,15 @@ The quickstart guide provides a template processor and includes all of this setu
9
9
10
10
If you're migrating an existing processor to the Indexer SDK, follow the steps below.
11
11
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`.
0 commit comments