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.

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

update readme #414

Merged
merged 1 commit into from
Jun 18, 2024
Merged
Changes from all commits
Commits
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
61 changes: 32 additions & 29 deletions rust/processor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,37 @@ Indexer GRPC parser is to indexer data processor that leverages the indexer grpc
- A running PostgreSQL instance, with a valid database. More tutorial can be
found [here](https://github.com/aptos-labs/aptos-core/tree/main/crates/indexer#postgres)

- A config YAML file
- For example, `config.yaml`

```yaml
health_check_port: 8084
server_config:
processor_config:
type: default_processor
postgres_connection_string: postgresql://postgres:@localhost:5432/postgres_v2
indexer_grpc_data_service_address: 127.0.0.1:50051
indexer_grpc_http2_ping_interval_in_secs: 60
indexer_grpc_http2_ping_timeout_in_secs: 10
number_concurrent_processing_tasks: 10
auth_token: AUTH_TOKEN
starting_version: 0 # optional
ending_version: 0 # optional
transaction_filter:
# Only allow transactions from these contract addresses
# focus_contract_addresses:
# - "0x0"
# Skip transactions from these sender addresses
skip_sender_addresses:
- "0x07"
# Skip all transactions that aren't user transactions
focus_user_transactions: false
deprecated_tables: [
"MOVE_RESOURCES",
]
```
- A config YAML file
- For example, `parser.yaml`

```yaml
health_check_port: 8084
server_config:
processor_config:
type: default_processor
postgres_connection_string: postgresql://postgres:@localhost:5432/postgres_v2
indexer_grpc_data_service_address: 127.0.0.1:50051
indexer_grpc_http2_ping_interval_in_secs: 60
indexer_grpc_http2_ping_timeout_in_secs: 10
number_concurrent_processing_tasks: 10
auth_token: AUTH_TOKEN
starting_version: 0 # optional
ending_version: 0 # optional
transaction_filter:
# Only allow transactions from these contract addresses
# focus_contract_addresses:
# - "0x0"
# Skip transactions from these sender addresses
skip_sender_addresses:
- "0x07"
# Skip all transactions that aren't user transactions
focus_user_transactions: false
deprecated_tables: [
"MOVE_RESOURCES",
"WRITE_SET_CHANGES",
"TRANSACTIONS",
]
```

#### Config Explanation

Expand All @@ -52,6 +54,7 @@ Indexer GRPC parser is to indexer data processor that leverages the indexer grpc
- `starting_version`: start processor at starting_version.
- `ending_version`: stop processor after ending_version.
- `number_concurrent_processing_tasks`: number of tasks to parse and insert; 1 means sequential processing, otherwise,
- `deprecated_tables`: a list of tables to skip writing to alloyDB.
transactions are splitted into tasks and inserted with random order.

### Use docker image for existing parsers(Only for **Unix/Linux**)
Expand Down
Loading