scroll/coordinator/internal/config/config.go

package config

import (
	"encoding/json"
	"os"
	"path/filepath"

	"scroll-tech/common/database"
	"scroll-tech/common/utils"
)

// ProverManager loads sequencer configuration items.
type ProverManager struct {
	// The amount of provers to pick per proof generation session.
	ProversPerSession uint8 `json:"provers_per_session"`
	// Number of attempts that a session can be retried if previous attempts failed.
	// Currently we only consider proving timeout as failure here.
	SessionAttempts uint8 `json:"session_attempts"`
	// Zk verifier config.
	Verifier *VerifierConfig `json:"verifier"`
	// BatchCollectionTimeSec batch Proof collection time (in seconds).
	BatchCollectionTimeSec int `json:"batch_collection_time_sec"`
	// ChunkCollectionTimeSec chunk Proof collection time (in seconds).
	ChunkCollectionTimeSec int `json:"chunk_collection_time_sec"`
	// BundleCollectionTimeSec bundle Proof collection time (in seconds).
	BundleCollectionTimeSec int `json:"bundle_collection_time_sec"`
}

// L2 loads l2geth configuration items.
type L2 struct {
	// l2geth chain_id.
	ChainID uint64 `json:"chain_id"`
}

// Auth provides the auth coordinator
type Auth struct {
	Secret                     string `json:"secret"`
	ChallengeExpireDurationSec int    `json:"challenge_expire_duration_sec"`
	LoginExpireDurationSec     int    `json:"login_expire_duration_sec"`
}

// Config load configuration items.
type Config struct {
	ProverManager *ProverManager   `json:"prover_manager"`
	DB            *database.Config `json:"db"`
	L2            *L2              `json:"l2"`
	Auth          *Auth            `json:"auth"`
}

// CircuitConfig circuit items.
type CircuitConfig struct {
	ParamsPath       string `json:"params_path"`
	AssetsPath       string `json:"assets_path"`
	ForkName         string `json:"fork_name"`
	MinProverVersion string `json:"min_prover_version"`
}

// VerifierConfig load zk verifier config.
type VerifierConfig struct {
	MockMode           bool           `json:"mock_mode"`
	LowVersionCircuit  *CircuitConfig `json:"low_version_circuit"`
	HighVersionCircuit *CircuitConfig `json:"high_version_circuit"`
}

// NewConfig returns a new instance of Config.
func NewConfig(file string) (*Config, error) {
	buf, err := os.ReadFile(filepath.Clean(file))
	if err != nil {
		return nil, err
	}

	cfg := &Config{}
	err = json.Unmarshal(buf, cfg)
	if err != nil {
		return nil, err
	}

	// Override config with environment variables
	err = utils.OverrideConfigWithEnv(cfg, "SCROLL_COORDINATOR")
	if err != nil {
		return nil, err
	}

	return cfg, nil
}