Skip to content

user-ops-indexer

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

user-ops-indexer

README.md

User Ops Indexer

User Ops Indexer is a service designed to index, decode and serve user operations as per the ERC-4337 standard.

The service can index 2 official ERC-4337 Entrypoint deployments:

The service consists of 2 parts:

  • Indexer logic - entrypoint contract indexing module. Each entrypoint contract is indexed in a separate tokio async task.
  • API server - API module serving data about indexed user operations, accounts, factories, bundlers.

Requirements

No additional dependencies

How to run

Production

Set the following ENVs on the Blockscout instance (configuration):

  • MICROSERVICE_ACCOUNT_ABSTRACTION_ENABLED=true
  • MICROSERVICE_ACCOUNT_ABSTRACTION_URL={service_url}

And the following ENVs on the Blockscout frontend (configuration):

  • NEXT_PUBLIC_HAS_USER_OPS=true

It's recommended to run all the services using docker compose or Blockscout Stack Helm charts.

Locally

For testing and development purposes, service can be run locally, without having an active instance of Blockscout Elixir backend, but it'll need access to the working JSON RPC URL and to the fully indexed Blockscout database (tables blocks and logs in particular).

Configure env as described above and then run the service as following:

cargo run --bin user-ops-indexer-server

Envs

Here, we describe variables specific to this service. Variables common to all services can be found here.

Variable Req​uir​ed Description Default value
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. 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__V06_ENTRY_POINT Entrypoint v0.6 contract addresses, comma separated 0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789
USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V07 Enable Entrypoint v0.7 indexer true
USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V07_ENTRY_POINT Entrypoint v0.7 contract addresses, comma separated 0x0000000071727De22E5E9d8BAf0edAc6f37da032
USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V08 Enable Entrypoint v0.8 indexer true
USER_OPS_INDEXER__INDEXER__ENTRYPOINTS__V08_ENTRY_POINT Entrypoint v0.8 contract addresses, comma separated 0x4337084D9E255Ff0702461CF8895CE9E3b5Ff108
USER_OPS_INDEXER__INDEXER__REALTIME__ENABLED Enable forward realtime indexing of user operations from the latest block true
USER_OPS_INDEXER__INDEXER__REALTIME__POLLING_INTERVAL Polling interval for forward realtime indexing of user operations from the latest block, when using an HTTP RPC node 6
USER_OPS_INDEXER__INDEXER__REALTIME__POLLING_BLOCK_RANGE Extra block range offset for polling in realtime indexing to recover from small re-orgs. 6
USER_OPS_INDEXER__INDEXER__REALTIME__MAX_BLOCK_RANGE Max block range for single polling request in realtime indexing. 10000
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__INDEXER__TRACE_CLIENT RPC tracing namespace to use for tracing transactions, debug for using debug_traceTransaction, trace for using trace_transaction. If null - chosen based on web3_clientVersion. null
USER_OPS_INDEXER__INDEXER__DEDUPLICATION_CACHE_SIZE Cache size for indexer job (txn hash + block number) deduplication. 1000
USER_OPS_INDEXER__INDEXER__DEDUPLICATION_INTERVAL Interval for deduplication cache. Within this interval, subsequent equal jobs will be considered duplicate 600
USER_OPS_INDEXER__INDEXER__RESTART_DELAY Interval for restarting the indexer when encountering fatal errors 60
USER_OPS_INDEXER__DATABASE__CONNECT__URL true Postgres connect URL to Blockscout DB with read/write access
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__DATABASE__CONNECT_OPTIONS__MAX_CONNECTIONS Maximum number of connections for a pool. If null - default value from sqlx options is used (currently - 10). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__MIN_CONNECTIONS Minimum number of connections for a pool. If null - default value from sqlx options is used (currently - 0). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__CONNECT_TIMEOUT The connection timeout for a packet connection, in seconds. If null - default value from sqlx options is used (currently - 30). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__IDLE_TIMEOUT Maximum idle time for a particular connection to prevent network resource exhaustion, in seconds. If null - default value from sqlx options is used (currently - 600). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__ACQUIRE_TIMEOUT Maximum amount of time to spend waiting for acquiring a connection, in seconds. If null - default value from sqlx options is used (currently - 30). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__MAX_LIFETIME Maximum lifetime of individual connections, in seconds. If null - default value from sqlx options is used (currently - 1800). null
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__SQLX_LOGGING Enable SQLX logging true
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__SQLX_LOGGING_LEVEL SQLX logging level debug
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__SQLX_SLOW_STATEMENTS_LOGGING_LEVEL SQLX logging level for slow statements warnings off
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__SQLX_SLOW_STATEMENTS_LOGGING_THRESHOLD Threshold duration for SQLX slow statements warnings 1
USER_OPS_INDEXER__DATABASE__CONNECT_OPTIONS__CONNECT_LAZY Only establish SQL connections if necessary (see sqlx/sea-orm documentation for details) false

Links