Merge branch 'main' into petera/add-indexer-metrics

.github/CODEOWNERS

@@ -1 +1 @@
-* @sideninja @peterargue @m-Peter
+* @janezpodhostnik @peterargue @m-Peter @zhangchiqing @ramtinms

.golangci.toml

@@ -0,0 +1,4 @@
+[linters]
+enable = [
+    "goimports",
+]

Dockerfile

@@ -27,8 +27,6 @@ WORKDIR /flow-evm-gateway
 RUN apt-get update && apt-get install ca-certificates -y
 
 COPY --from=app-builder /app/bin /flow-evm-gateway/app
-COPY --from=app-builder /app/previewnet-keys.json /flow-evm-gateway/previewnet-keys.json
-COPY --from=app-builder /app/migration-keys.json /flow-evm-gateway/migration-keys.json
 
 EXPOSE 8545
 

README.md

@@ -180,7 +180,6 @@ The application can be configured using the following flags at runtime:
 | `ws-enabled`                 | `false`                         | Enable websocket connections                                                             |
 | `access-node-grpc-host`      | `localhost:3569`                | Host to the flow access node gRPC API                                                    |
 | `access-node-spork-hosts`    | `""`                            | Previous spork AN hosts, defined as a comma-separated list (e.g. `"host-1.com,host2.com"`) |
-| `evm-network-id`             | `testnet   `                    | EVM network ID (options: `testnet`, `mainnet`)                                           |
 | `flow-network-id`            | `flow-emulator`                 | Flow network ID (options: `flow-emulator`, `flow-testnet`, `flow-mainnet`)               |
 | `coinbase`                   | `""`                            | Coinbase address to use for fee collection                                               |
 | `init-cadence-height`        | `0`                             | Cadence block height to start indexing; avoid using on a new network                     |
@@ -204,7 +203,6 @@ The application can be configured using the following flags at runtime:
 | `wallet-api-key`             | `""`                            | ECDSA private key for wallet APIs (local/testing use only)                               |
 | `filter-expiry`              | `5m`                            | Expiry time for idle filters                                                             |
 | `traces-gcp-bucket`          | `""`                            | GCP bucket name for transaction traces                                                   |
-| `prometheus-config-file-path`| `./metrics/prometheus.yml`      | Path to the Prometheus configuration file                                                |
 | `index-only`                 | `false`                         | Run in index-only mode, allowing state queries and indexing but no transaction sending   |
 | `profiler-enabled`           | `false`                         | Enable the pprof profiler server                                                         |
 | `profiler-host`              | `localhost`                     | Host for the pprof profiler                                                              |

bootstrap/bootstrap.go

@@ -57,7 +57,8 @@ type Bootstrap struct {
 
 func New(config *config.Config) (*Bootstrap, error) {
 	logger := zerolog.New(config.LogWriter).
-		With().Timestamp().Logger().Level(config.LogLevel)
+		With().Timestamp().Str("version", api.Version).
+		Logger().Level(config.LogLevel)
 
 	client, err := setupCrossSporkClient(config, logger)
 	if err != nil {
@@ -136,7 +137,7 @@ func (b *Bootstrap) StartEventIngestion(ctx context.Context) error {
 		b.collector,
 	)
 
-	startEngine(ctx, b.events, l)
+	StartEngine(ctx, b.events, l)
 	return nil
 }
 
@@ -160,7 +161,7 @@ func (b *Bootstrap) StartTraceDownloader(ctx context.Context) error {
 		b.collector,
 	)
 
-	startEngine(ctx, b.traces, l)
+	StartEngine(ctx, b.traces, l)
 	return nil
 }
 
@@ -373,23 +374,27 @@ func (b *Bootstrap) StopProfilerServer() {
 	}
 }
 
-// startEngine starts provided engine and panics if there are startup errors.
-func startEngine(
+// StartEngine starts provided engine and panics if there are startup errors.
+func StartEngine(
 	ctx context.Context,
 	engine models.Engine,
 	logger zerolog.Logger,
 ) {
-	logger.Info().Msg("starting engine")
+	l := logger.With().Type("engine", engine).Logger()
+
+	l.Info().Msg("starting engine")
+	start := time.Now()
 	go func() {
 		err := engine.Run(ctx)
 		if err != nil {
-			logger.Error().Err(err).Msg("engine failed to run")
-			panic(err)
+			l.Fatal().Err(err).Msg("engine failed to run")
 		}
 	}()
 
 	<-engine.Ready()
-	logger.Info().Msg("engine started successfully")
+	l.Info().
+		Dur("duration", time.Since(start)).
+		Msg("engine started successfully")
 }
 
 // setupCrossSporkClient sets up a cross-spork AN client.

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/onflow/go-ethereum v1.14.7
 	github.com/prometheus/client_golang v1.18.0
 	github.com/rs/cors v1.8.0
-	github.com/rs/zerolog v1.31.0
+	github.com/rs/zerolog v1.33.0
 	github.com/samber/slog-zerolog v1.0.0
 	github.com/sethvargo/go-limiter v1.0.0
 	github.com/sethvargo/go-retry v0.2.3

go.sum

@@ -1988,8 +1988,8 @@ github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/rs/cors v1.8.0 h1:P2KMzcFwrPoSjkF1WLRPsp3UMLyql8L4v9hQpVeK5so=
 github.com/rs/cors v1.8.0/go.mod h1:EBwu+T5AvHOcXwvZIkQFjUN6s8Czyqw12GL/Y0tUyRM=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
+github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=

models/engine.go

@@ -30,15 +30,15 @@ func NewEngineStatus() *EngineStatus {
 	}
 }
 
-func (e *EngineStatus) IsReady() <-chan struct{} {
+func (e *EngineStatus) Ready() <-chan struct{} {
 	return e.ready
 }
 
-func (e *EngineStatus) IsStopped() <-chan struct{} {
+func (e *EngineStatus) Stopped() <-chan struct{} {
 	return e.stop
 }
 
-func (e *EngineStatus) IsDone() <-chan struct{} {
+func (e *EngineStatus) Done() <-chan struct{} {
 	return e.done
 }
 

models/sequential_height_test.go

@@ -1,9 +1,10 @@
 package models
 
 import (
-	"github.com/stretchr/testify/require"
 	"math"
 	"testing"
+
+	"github.com/stretchr/testify/require"
 )
 
 func TestSequentialHeight(t *testing.T) {

services/ingestion/engine.go

@@ -31,6 +31,8 @@ var _ models.Engine = &Engine{}
 // it will just overwrite the current indexed data. Idempotency is an important
 // requirement of the implementation of this engine.
 type Engine struct {
+	*models.EngineStatus
+
 	subscriber      EventSubscriber
 	store           *pebble.Storage
 	blocks          storage.BlockIndexer
@@ -39,7 +41,6 @@ type Engine struct {
 	accounts        storage.AccountIndexer
 	log             zerolog.Logger
 	evmLastHeight   *models.SequentialHeight
-	status          *models.EngineStatus
 	blocksPublisher *models.Publisher
 	logsPublisher   *models.Publisher
 	collector       metrics.Collector
@@ -60,31 +61,21 @@ func NewEventIngestionEngine(
 	log = log.With().Str("component", "ingestion").Logger()
 
 	return &Engine{
+		EngineStatus: models.NewEngineStatus(),
+
 		subscriber:      subscriber,
 		store:           store,
 		blocks:          blocks,
 		receipts:        receipts,
 		transactions:    transactions,
 		accounts:        accounts,
 		log:             log,
-		status:          models.NewEngineStatus(),
 		blocksPublisher: blocksPublisher,
 		logsPublisher:   logsPublisher,
 		collector:       collector,
 	}
 }
 
-// Ready signals when the engine has started.
-func (e *Engine) Ready() <-chan struct{} {
-	return e.status.IsReady()
-}
-
-// Done signals when the engine has stopped.
-func (e *Engine) Done() <-chan struct{} {
-	// return e.status.IsDone()
-	return nil
-}
-
 // Stop the engine.
 func (e *Engine) Stop() {
 	// todo
@@ -113,7 +104,7 @@ func (e *Engine) Run(ctx context.Context) error {
 
 	e.log.Info().Uint64("start-cadence-height", latestCadence).Msg("starting ingestion")
 
-	e.status.MarkReady()
+	e.MarkReady()
 
 	for events := range e.subscriber.Subscribe(ctx, latestCadence) {
 		if events.Err != nil {

services/requester/rotation_signer_test.go

@@ -2,12 +2,13 @@ package requester
 
 import (
 	"fmt"
+	"sync"
+	"testing"
+
 	"github.com/onflow/flow-go-sdk/crypto"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/exp/maps"
-	"sync"
-	"testing"
 )
 
 func Test_KeyRotation(t *testing.T) {

services/traces/engine.go

@@ -27,8 +27,9 @@ var _ models.Engine = &Engine{}
 // listens for new transaction events and then downloads and index the
 // traces from the transaction execution.
 type Engine struct {
+	*models.EngineStatus
+
 	logger          zerolog.Logger
-	status          *models.EngineStatus
 	blocksPublisher *models.Publisher
 	blocks          storage.BlockIndexer
 	traces          storage.TraceIndexer
@@ -46,7 +47,8 @@ func NewTracesIngestionEngine(
 	collector metrics.Collector,
 ) *Engine {
 	return &Engine{
-		status:          models.NewEngineStatus(),
+		EngineStatus: models.NewEngineStatus(),
+
 		logger:          logger.With().Str("component", "trace-ingestion").Logger(),
 		blocksPublisher: blocksPublisher,
 		blocks:          blocks,
@@ -56,11 +58,13 @@ func NewTracesIngestionEngine(
 	}
 }
 
+// Run the engine.
+// TODO: use the context to stop the engine.
 func (e *Engine) Run(ctx context.Context) error {
 	// subscribe to new blocks
 	e.blocksPublisher.Subscribe(e)
 
-	e.status.MarkReady()
+	e.MarkReady()
 	return nil
 }
 
@@ -148,13 +152,5 @@ func (e *Engine) Error() <-chan error {
 }
 
 func (e *Engine) Stop() {
-	e.status.MarkStopped()
-}
-
-func (e *Engine) Done() <-chan struct{} {
-	return e.status.IsDone()
-}
-
-func (e *Engine) Ready() <-chan struct{} {
-	return e.status.IsReady()
+	e.MarkStopped()
 }

tests/go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/onflow/flow-go v0.37.10
 	github.com/onflow/flow-go-sdk v1.0.0-preview.56
 	github.com/onflow/go-ethereum v1.14.7
-	github.com/rs/zerolog v1.31.0
+	github.com/rs/zerolog v1.33.0
 	github.com/stretchr/testify v1.9.0
 )
 

tests/go.sum

@@ -2264,8 +2264,8 @@ github.com/rs/cors v1.7.0/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU=
 github.com/rs/cors v1.8.0 h1:P2KMzcFwrPoSjkF1WLRPsp3UMLyql8L4v9hQpVeK5so=
 github.com/rs/cors v1.8.0/go.mod h1:EBwu+T5AvHOcXwvZIkQFjUN6s8Czyqw12GL/Y0tUyRM=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
+github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=