Skip to content

Commit

Permalink
chore: update readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
@k1rill-fedoseev
k1rill-fedoseev committed May 9, 2024
1 parent adf01b7 commit 0b34210
Showing 1 changed file with 49 additions and 51 deletions.
100 changes: 49 additions & 51 deletions user-ops-indexer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,47 +16,28 @@ The service consists of 2 parts:
* [API server](./user-ops-indexer-server) - API module serving data about indexed user operations, accounts, factories,
bundlers.

## Build

### Using docker

Service is built using docker (see [Dockerfile](./Dockerfile)). Public build images are available
through [GitHub Container Registry](https://github.com/blockscout/blockscout-rs/pkgs/container/user-ops-indexer)

## Config

### Env

| Variable | Description | Required | Default value |
|-----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------|
| `USER_OPS_INDEXER__SERVER__HTTP__ENABLED` | Enable HTTP API server | | `true` |
| `USER_OPS_INDEXER__SERVER__HTTP__ADDR` | HTTP API listening interface | | `0.0.0.0:8050` |
| `USER_OPS_INDEXER__SERVER__HTTP__MAX_BODY_SIZE` | Max HTTP body size for incoming API requests | | `2097152` |
| `USER_OPS_INDEXER__SERVER__GRPC__ENABLED` | Enable GRPC API server | | `false` |
| `USER_OPS_INDEXER__SERVER__GRPC__ADDR` | GRPC API listening interface | | `0.0.0.0:8051` |
| `USER_OPS_INDEXER__API__MAX_PAGE_SIZE` | Max page size for API requests | | `100` |
| `USER_OPS_INDEXER__INDEXER__RPC_URL` | Indexer RPC URL, should be an archive JSON RPC node with `eth`, `web3` and `trace`/`debug` namespaces enabled. Both HTTP and WS protocols are supported. WS is recommended for local RPC nodes, use HTTP otherwise. | true | `ws://127.0.0.1:8546` |
| `USER_OPS_INDEXER__INDEXER__CONCURRENCY` | Indexer concurrency. Will process up to the configured number of transactions concurrently | | `10` |
| `USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V06` | Enable Entrypoint v0.6 indexer | | `true` |
| `USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V07` | Enable Entrypoint v0.7 indexer | | `true` |
| `USER_OPS_INDEXER__INDEXER__REALTIME__ENABLED` | Enable forward realtime indexing of user operations from the `latest` block | | `true` |
| `USER_OPS_INDEXER__INDEXER__PAST_RPC_LOGS_INDEXER__ENABLED` | Enable one-time reindex of missed user operations from recent blocks | | `false` |
| `USER_OPS_INDEXER__INDEXER__PAST_RPC_LOGS_INDEXER__BLOCK_RANGE` | Block range width for missed user operations reindex. Will re-index events from a given number of blocks prior the `latest` block | | `0` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__ENABLED` | Enable one-time reindex of missed user operations from core Blockscout DB. Will query relevant events from `logs` Postgres table | | `false` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__START_BLOCK` | Block range start for one-time DB reindex. Use positive number for static block number, or zero/negative number to count backwards from `latest` | | `0` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__END_BLOCK` | Block range end for one-time DB reindex. Use positive number for static block number, or zero/negative number to count backwards from `latest` | | `0` |
| `USER_OPS_INDEXER__DATABASE__CONNECT__URL` | Postgres connect URL to Blockscout DB with read/write access | true | (empty) |
| `USER_OPS_INDEXER__DATABASE__CREATE_DATABASE` | Create database if doesn't exist | | `false` |
| `USER_OPS_INDEXER__DATABASE__RUN_MIGRATIONS` | Run database migrations | | `false` |
| `USER_OPS_INDEXER__METRICS__ENABLED` | Enable metrics collection endpoint | | `false` |
| `USER_OPS_INDEXER__METRICS__ADDR` | Metrics collection listening interface | | `0.0.0.0:6060` |
| `USER_OPS_INDEXER__METRICS__ROUTE` | Metrics collection API route | | `/metrics` |
| `USER_OPS_INDEXER__JAEGER__ENABLED` | Enable Jaeger tracing | | `false` |
| `USER_OPS_INDEXER__JAEGER__AGENT_ENDPOINT` | Jaeger tracing listening interface | | `127.0.0.1:6831` |
| `USER_OPS_INDEXER__TRACING__ENABLED` | Enable tracing log module | | `true` |
| `USER_OPS_INDEXER__TRACING__FORMAT` | Tracing format. `default` / `json` | | `default` |

## Running
## Requirements

No additional dependencies

## How to run

### Production

Set the following ENVs on the Blockscout
instance ([configuration](https://github.com/blockscout/docs/blob/master/for-developers/information-and-settings/env-variables.md#blockscout-account-abstraction)):

* `MICROSERVICE_ACCOUNT_ABSTRACTION_ENABLED=true`
* `MICROSERVICE_ACCOUNT_ABSTRACTION_URL={service_url}`

And the following ENVs on the Blockscout
frontend ([configuration](https://github.com/blockscout/frontend/blob/main/docs/ENVS.md#user-operations-feature-erc-4337))

* `NEXT_PUBLIC_HAS_USER_OPS=true`

It's recommended to run all the services
using [docker compose](https://github.com/blockscout/blockscout/tree/master/docker-compose)
or [Blockscout Stack Helm charts](https://docs.blockscout.com/for-developers/deployment/kubernetes-deployment).

### Locally

Expand All @@ -70,13 +51,30 @@ Configure env as described above and then run the service as following:
cargo run --bin user-ops-indexer-server
```

### Production

Production setup should also include necessary Elixir
backend [configuration](https://github.com/blockscout/docs/blob/master/for-developers/information-and-settings/env-variables.md#blockscout-account-abstraction)
and
frontend [configuration](https://github.com/blockscout/frontend/blob/main/docs/ENVS.md#user-operations-feature-erc-4337)

Running using [docker compose](https://github.com/blockscout/blockscout/tree/master/docker-compose)
or [Blockscout Stack Helm charts](https://docs.blockscout.com/for-developers/deployment/kubernetes-deployment) is
recommended.
## Envs

Here, we describe variables specific to this service. Variables common to all services can be
found [here](../docs/common-envs.md).

| Variable | Required | Description | Default value |
|-----------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| `USER_OPS_INDEXER__API__MAX_PAGE_SIZE` | | Max page size for API requests | `100` |
| `USER_OPS_INDEXER__INDEXER__RPC_URL` | true | Indexer RPC URL, should be an archive JSON RPC node with `eth`, `web3` and `trace`/`debug` namespaces enabled. Both HTTP and WS protocols are supported. WS is recommended for local RPC nodes, use HTTP otherwise. | `ws://127.0.0.1:8546` |
| `USER_OPS_INDEXER__INDEXER__CONCURRENCY` | | Indexer concurrency. Will process up to the configured number of transactions concurrently | `10` |
| `USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V06` | | Enable Entrypoint v0.6 indexer | `true` |
| `USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V07` | | Enable Entrypoint v0.7 indexer | `true` |
| `USER_OPS_INDEXER__INDEXER__REALTIME__ENABLED` | | Enable forward realtime indexing of user operations from the `latest` block | `true` |
| `USER_OPS_INDEXER__INDEXER__PAST_RPC_LOGS_INDEXER__ENABLED` | | Enable one-time reindex of missed user operations from recent blocks | `false` |
| `USER_OPS_INDEXER__INDEXER__PAST_RPC_LOGS_INDEXER__BLOCK_RANGE` | | Block range width for missed user operations reindex. Will re-index events from a given number of blocks prior the `latest` block | `0` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__ENABLED` | | Enable one-time reindex of missed user operations from core Blockscout DB. Will query relevant events from `logs` Postgres table | `false` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__START_BLOCK` | | Block range start for one-time DB reindex. Use positive number for static block number, or zero/negative number to count backwards from `latest` | `0` |
| `USER_OPS_INDEXER__INDEXER__PAST_DB_LOGS_INDEXER__END_BLOCK` | | Block range end for one-time DB reindex. Use positive number for static block number, or zero/negative number to count backwards from `latest` | `0` |
| `USER_OPS_INDEXER__DATABASE__CONNECT__URL` | true | Postgres connect URL to Blockscout DB with read/write access | (empty) |
| `USER_OPS_INDEXER__DATABASE__CREATE_DATABASE` | | Create database if doesn't exist | `false` |
| `USER_OPS_INDEXER__DATABASE__RUN_MIGRATIONS` | | Run database migrations | `false` |

## Links

- [Swagger](https://blockscout.github.io/swaggers/services/user-ops-indexer/index.html)
- [Packages](https://github.com/blockscout/blockscout-rs/pkgs/container/user-ops-indexer)
- [Releases](https://github.com/blockscout/blockscout-rs/releases?q=user-ops-indexer&expanded=true)

0 comments on commit 0b34210

Please sign in to comment.