Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README to SDK Dir and Update the Legacy README #604

Merged
merged 4 commits into from
Nov 14, 2024
Merged

Add README to SDK Dir and Update the Legacy README #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21ab273
Add supported coin type mappings and create sdk readme
dermanyang Nov 13, 2024
b2cf4d5
Add sub-header
dermanyang Nov 13, 2024
3664a74
Rewording
dermanyang Nov 14, 2024
b4328eb
Merge branch 'main' into sdy/update_readmes
dermanyang Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions rust/processor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Indexer GRPC Parser
# Transaction Stream Processor

Indexer GRPC parser is to indexer data processor that leverages the indexer grpc data.
Processors that index data from the Aptos Transaction Stream (GRPC).

- **Note: We'll launch an official endpoint soon; stay tuned!**

Expand Down Expand Up @@ -74,3 +74,8 @@ transactions are splitted into tasks and inserted with random order.

### Manually running diesel-cli
- `cd` into the database folder you use under `src/db/` (e.g. `src/db/postgres`), then run it.

## Processor Specific Notes

### Supported Coin Type Mappings
See mapping in [v2_fungible_asset_balances.rs](https://github.com/aptos-labs/aptos-indexer-processors/blob/main/rust/processor/src/db/common/models/fungible_asset_models/v2_fungible_asset_balances.rs#L40) for a list supported coin type mappings.
12 changes: 12 additions & 0 deletions rust/sdk-processor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Transaction Stream Processors (SDK)
Processors that index data from the Aptos Transaction Stream (GRPC). These processors have been (re)-written using the new Indexer SDK.

- **Note: Official releases coming soon!**

## Tutorial
Follow tutorial in the [example repo](https://github.com/aptos-labs/aptos-indexer-processor-example).

## Processor Specific Notes

### Supported Coin Type Mappings
See mapping in [v2_fungible_asset_balances.rs](https://github.com/aptos-labs/aptos-indexer-processors/blob/main/rust/processor/src/db/common/models/fungible_asset_models/v2_fungible_asset_balances.rs#L40) for a list supported coin type mappings.
Loading