diff --git a/README.md b/README.md index 0e98a65..ba8f85a 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,21 @@ ![GitHub Tag](https://img.shields.io/github/v/tag/grassrootseconomics/eth-indexer) -A lightweight Postgres chain indexer designed to couple with [eth-tracker](https://github.com/grassrootseconomics/eth-tracker) to index all relevant GE related blockchain data on any EVM chain. +A lightweight Postgres chain indexer designed to couple with +[eth-tracker](https://github.com/grassrootseconomics/eth-tracker) to index all +relevant GE related blockchain data on any EVM chain. ## Getting Started ### Prerequisites -* Git -* Docker -* Postgres server -* Access to a `eth-tracker` instance +- Git +- Docker +- Postgres server +- Access to a `eth-tracker` instance -See [docker-compose.yaml](dev/docker-compose.yaml) for an example on how to run and deploy a single instance. +See [docker-compose.yaml](dev/docker-compose.yaml) for an example on how to run +and deploy a single instance. ### 1. Build the Docker image @@ -34,7 +37,9 @@ For an example, see `dev/docker-compose.postgres.yaml`. ### 3. Update config values -See `.env.example` on how to override default values defined in `config.toml` using env variables. Alternatively, mount your own config.toml either during build time or Docker runtime. +See `.env.example` on how to override default values defined in `config.toml` +using env variables. Alternatively, mount your own config.toml either during +build time or Docker runtime. ```bash # Override only specific config values @@ -44,10 +49,10 @@ mv .env.example .env Special env variables: -* DEV=* - -Refer to [`config.toml`](config.toml) to understand different config value settings. +- DEV=* +Refer to [`config.toml`](config.toml) to understand different config value +settings. ### 4. Run the indexer @@ -58,4 +63,4 @@ docker compose up ## License -[AGPL-3.0](LICENSE). \ No newline at end of file +[AGPL-3.0](LICENSE). diff --git a/cmd/service/main.go b/cmd/service/main.go index bcb4440..fcdce1f 100644 --- a/cmd/service/main.go +++ b/cmd/service/main.go @@ -12,12 +12,12 @@ import ( "syscall" "time" - "github.com/grassrootseconomics/eth-indexer/internal/api" - "github.com/grassrootseconomics/eth-indexer/internal/cache" - "github.com/grassrootseconomics/eth-indexer/internal/handler" - "github.com/grassrootseconomics/eth-indexer/internal/store" - "github.com/grassrootseconomics/eth-indexer/internal/sub" - "github.com/grassrootseconomics/eth-indexer/internal/util" + "github.com/grassrootseconomics/eth-indexer/v2/internal/api" + "github.com/grassrootseconomics/eth-indexer/v2/internal/cache" + "github.com/grassrootseconomics/eth-indexer/v2/internal/handler" + "github.com/grassrootseconomics/eth-indexer/v2/internal/store" + "github.com/grassrootseconomics/eth-indexer/v2/internal/sub" + "github.com/grassrootseconomics/eth-indexer/v2/internal/util" "github.com/grassrootseconomics/ethutils" "github.com/knadh/koanf/v2" ) diff --git a/cmd/service/router.go b/cmd/service/router.go index e620f29..91332e3 100644 --- a/cmd/service/router.go +++ b/cmd/service/router.go @@ -1,8 +1,8 @@ package main import ( - "github.com/grassrootseconomics/eth-indexer/internal/handler" - "github.com/grassrootseconomics/eth-indexer/pkg/router" + "github.com/grassrootseconomics/eth-indexer/v2/internal/handler" + "github.com/grassrootseconomics/eth-indexer/v2/pkg/router" ) func bootstrapRouter(handlerContainer *handler.Handler) *router.Router { diff --git a/internal/handler/handler.go b/internal/handler/handler.go index 348460f..3e1460b 100644 --- a/internal/handler/handler.go +++ b/internal/handler/handler.go @@ -3,8 +3,8 @@ package handler import ( "log/slog" - "github.com/grassrootseconomics/eth-indexer/internal/cache" - "github.com/grassrootseconomics/eth-indexer/internal/store" + "github.com/grassrootseconomics/eth-indexer/v2/internal/cache" + "github.com/grassrootseconomics/eth-indexer/v2/internal/store" "github.com/grassrootseconomics/ethutils" ) diff --git a/internal/sub/jetstream.go b/internal/sub/jetstream.go index 9644b34..7b11ad2 100644 --- a/internal/sub/jetstream.go +++ b/internal/sub/jetstream.go @@ -6,7 +6,7 @@ import ( "log/slog" "time" - "github.com/grassrootseconomics/eth-indexer/pkg/router" + "github.com/grassrootseconomics/eth-indexer/v2/pkg/router" "github.com/nats-io/nats.go" "github.com/nats-io/nats.go/jetstream" )