Optimize config (#95)

Author: boqiu

blockchain/sync/core/adapter.go

@@ -14,18 +14,18 @@ import (
 const defaultRpcRetry = 3
 
 type AdapterConfig struct {
-	URL string
+	AdapterOption `mapstructure:",squash"`
 
-	Option AdapterOption
+	URL string
 }
 
 type AdapterOption struct {
 	// RPC
 	RequestTimeout time.Duration `default:"3s"`
 
 	// latest block number
-	LatestBlockNumberTag    string `default:"latest_state"`
-	LatestBlockNumberOffset uint64 `default:"5"`
+	LatestBlockNumberTag    string `default:"latest_state"` // latest_mined, latest_state, latest_confirmed or latest_finalized
+	LatestBlockNumberOffset uint64 `default:"5"`            // N blocks behind the `LatestBlockNumberTag`
 	latestEpoch             *types.Epoch
 
 	// allow to ignore receipts and/or traces, only block and transactions are required
@@ -73,7 +73,7 @@ func NewAdapterWithConfig(config AdapterConfig) (*Adapter, error) {
 		return nil, errors.New("URL not specified")
 	}
 
-	return NewAdapter(config.URL, config.Option)
+	return NewAdapter(config.URL, config.AdapterOption)
 }
 
 // Close closes the underlying RPC client.

blockchain/sync/evm/adapter.go

@@ -13,18 +13,18 @@ import (
 )
 
 type AdapterConfig struct {
-	URL string
+	AdapterOption `mapstructure:",squash"`
 
-	Option AdapterOption
+	URL string
 }
 
 type AdapterOption struct {
 	// RPC
 	RequestTimeout time.Duration `default:"3s"`
 
 	// latest block number
-	LatestBlockNumberTag    int64  `default:"-1"` // "latest" block
-	LatestBlockNumberOffset uint64 `default:"5"`
+	LatestBlockNumberTag    int64  `default:"-1"` // -1: "latest", -3: "finalized", -4: "safe"
+	LatestBlockNumberOffset uint64 `default:"5"`  // N blocks behind the `LatestBlockNumberTag`
 
 	// allow to ignore receipts and/or traces, only block and transactions are required
 	IgnoreReceipts bool
@@ -62,7 +62,7 @@ func NewAdapterWithConfig(config AdapterConfig) (*Adapter, error) {
 		return nil, errors.New("URL not specified")
 	}
 
-	return NewAdapter(config.URL, config.Option)
+	return NewAdapter(config.URL, config.AdapterOption)
 }
 
 // Close closes the underlying RPC client.

blockchain/sync/poll/parallel_worker.go

@@ -11,7 +11,7 @@ import (
 )
 
 type ParallelOption struct {
-	parallel.SerialOption
+	parallel.SerialOption `mapstructure:",squash"`
 
 	RetryInterval time.Duration `default:"1s"`
 

blockchain/sync/process/db/processor_agg.go

@@ -18,15 +18,15 @@ type Processor[T any] interface {
 type Option struct {
 	RetryInterval time.Duration `default:"3s"`
 
-	Health health.CounterConfig
+	Health health.TimedCounterConfig
 }
 
 // AggregateProcessor aggregates multiple processor to process blockchain data in batch.
 type AggregateProcessor[T any] struct {
 	option     Option
 	db         *gorm.DB
 	processors []Processor[T]
-	health     *health.Counter
+	health     *health.TimedCounter
 }
 
 func NewAggregateProcessor[T any](option Option, db *gorm.DB, processors ...Processor[T]) *AggregateProcessor[T] {
@@ -36,7 +36,7 @@ func NewAggregateProcessor[T any](option Option, db *gorm.DB, processors ...Proc
 		option:     option,
 		db:         db,
 		processors: processors,
-		health:     health.NewCounter(option.Health),
+		health:     health.NewTimedCounter(option.Health),
 	}
 }
 

blockchain/sync/process/db/processor_batch.go

@@ -26,7 +26,7 @@ type BatchProcessor[T any] interface {
 }
 
 type BatchOption struct {
-	Processor Option
+	Option `mapstructure:",squash"`
 
 	BatchSize       int           `default:"3000"`
 	BatchTimeout    time.Duration `default:"3s"`
@@ -54,7 +54,7 @@ func NewBatchAggregateProcessor[T any](option BatchOption, db *gorm.DB, processo
 	}
 
 	return &BatchAggregateProcessor[T]{
-		AggregateProcessor: NewAggregateProcessor(option.Processor, db, innerProcessors...),
+		AggregateProcessor: NewAggregateProcessor(option.Option, db, innerProcessors...),
 		option:             option,
 		processors:         processors,
 		lastBatchTime:      time.Now(),