Categorygithub.com/ethereum-optimism/optimism/indexer
modulepackage
0.7.0
Repository: https://github.com/ethereum-optimism/optimism.git
Documentation: pkg.go.dev

# README

@eth-optimism/indexer

Getting started

Run indexer vs goerli

  • install docker
  • cp example.env .env
  • fill in .env
  • run docker-compose up to start the indexer vs optimism goerli network

Run indexer with go

See the flags in flags.go for reference of what command line flags to pass to go run

Run indexer vs devnet

TODO add indexer to the optimism devnet compose file (previously removed for breaking CI)

Run indexer vs a custom configuration

docker-compose.dev.yml is git ignored. Fill in your own docker-compose file here.

# Packages

No description provided by the author
No description provided by the author
Database module defines the data DB struct which wraps specific DB interfaces for L1/L2 block headers, contract events, bridging schemas.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Main is the entrypoint into the indexer service.
NewIndexer initializes the Indexer, gathering any resources that will be needed by the TxIndexer and StateIndexer sub-services.
ParseAddress parses a ETH address from a hex string.

# Structs

Indexer is a service that configures the necessary resources for running the Sync and BlockHandler sub-services.