options

type Cache struct {
	Addr            string        `yaml:"addr" json:"addr"`
	Password        string        `yaml:"password" json:"password"`
	DB              int           `yaml:"db" json:"db"`
	MaxRetries      int           `yaml:"maxRetries" json:"maxRetries"`
	MinRetryBackoff time.Duration `yaml:"minRetryBackoff" json:"minRetryBackoff"`
	MaxRetryBackoff time.Duration `yaml:"maxRetryBackoff" json:"maxRetryBackoff"`
	DialTimeout     time.Duration `yaml:"dialTimeout" json:"dialTimeout"`
	ReadTimeout     time.Duration `yaml:"readTimeout" json:"readTimeout"`
	WriteTimeout    time.Duration `yaml:"writeTimeout" json:"writeTimeout"`
}

type Cloudflare struct {
	Enabled     bool   `yaml:"enabled"`
	AccountID   string `yaml:"accountId"`
	ApiToken    string `yaml:"apiToken"`
	BucketScope string `yaml:"bucketScope"`
	BucketName  string `yaml:"bucketName"`
	DatasetPath string `yaml:"datasetPath"`
}

type Cors struct {
	Debug              bool     `yaml:"debug"`
	MaxAge             int      `yaml:"maxAge"`
	AllowCredentials   bool     `yaml:"allowCredentials"`
	OptionsPassthrough bool     `yaml:"optionsPassthrough"`
	AllowedOrigins     []string `yaml:"allowedOrigins"`
	AllowedMethods     []string `yaml:"allowedMethods"`
	AllowedHeaders     []string `yaml:"allowedHeaders"`
	ExposedHeaders     []string `yaml:"exposedHeaders"`
}

type Db struct {
	Dialects []Dialect `yaml:"dialects"`
}

type Dialect struct {
	Name                  string   `yaml:"name"`
	Enabled               bool     `yaml:"enabled"`
	Datasource            string   `yaml:"datasource"`   // Sqlite related configuration
	MigrationDir          string   `yaml:"migrationDir"` // Sqlite related configuration
	Endpoints             []string `yaml:"endpoints"`    // Clickhouse related configuration
	Username              string   `yaml:"username"`     // Clickhouse related configuration
	Password              string   `yaml:"password"`     // Clickhouse related configuration
	Database              string   `yaml:"database"`     // Clickhouse and Sqlite related configuration
	Tls                   bool     `yaml:"tls"`
	Insecure              bool     `yaml:"insecure"`    // Clickhouse related configuration
	Compression           string   `yaml:"compression"` // Clickhouse related configuration
	DialTimeout           string   `yaml:"dialTimeout"`
	MaxIdleConnections    int      `yaml:"maxIdleConnections"`    // Clickhouse and Sqlite related configuration
	MaxOpenConnections    int      `yaml:"maxOpenConnections"`    // Clickhouse and Sqlite related configuration
	ConnectionMaxLifetime string   `yaml:"connectionMaxLifetime"` // Clickhouse and Sqlite related configuration
}

type GraphQL struct {
	Transports []string     `yaml:"transports"`
	Addr       string       `yaml:"addr"`
	Cors       Cors         `yaml:"cors"`
	Cache      GraphQLCache `yaml:"cache"`
}

type GraphQLCache struct {
	Adapter            string        `yaml:"adapter"`
	QueryCacheDuration time.Duration `yaml:"queryCacheDuration"`
}

type Indexer struct {
	Subscribers []Subscriber `yaml:"subscribers"`
}

type Ipfs struct {
	Enabled bool   `yaml:"enabled"`
	Addr    string `yaml:"addr"`
}

type Labels struct {
	DataPath string `yaml:"path"`
}

type Logger struct {
	Env   string `yaml:"env" json:"env"`     // Env specifies the environment (e.g., "production", "development").
	Level string `yaml:"level" json:"level"` // Level defines the logging level (e.g., "info", "debug").
}

type ModuleConfig interface {
	Validate() error // Example validation method
}

type Nats struct {
	Enabled bool    `yaml:"enabled"`
	Addr    string  `yaml:"addr"`
	Queues  []Queue `yaml:"queues"`
}

type Network struct {
	Name          string `yaml:"name"`
	NetworkId     int    `yaml:"networkId"`
	CanonicalName string `yaml:"canonicalName"`
	Symbol        string `yaml:"symbol"`
	Website       string `yaml:"website"`
	Suspended     bool   `yaml:"suspended"`
	Maintenance   bool   `yaml:"maintenance"`
}

type Options struct {
	OptionsPath string                  `default:"~/.unpack/inspector/options.yaml" env:"UNPACK_OPTIONS_PATH"` // OptionsPath defines the path to the configuration file.
	Logger      Logger                  `yaml:"logger" json:"logger"`                                          // Logger specifies the configuration settings for logging.
	Networks    []Network               `yaml:"networks" json:"networks"`                                      // Networks lists all the network configurations.
	Clients     *clients.Options        `yaml:"blockchain"`
	Db          Db                      // Db configure database settings.
	Nats        Nats                    // Nats defines the configuration for NATS client and its queues.
	Storage     Storage                 // Storage specifies the settings for storage mechanisms.
	Cache       Cache                   // Cache outlines the configurations for caching, typically with redis.
	Etherscan   *etherscan.Options      // Etherscan holds options for interacting with the Etherscan API.
	Indexer     Indexer                 `yaml:"indexer"`    // Indexer configures the synchronization options.
	Unpacker    Unpacker                `yaml:"unpacker"`   // Unpacker details the settings for unpacking and processing data.
	Graphql     GraphQL                 `yaml:"graphql"`    // Graphql configures the GraphQL server settings.
	Pprof       []Pprof                 `yaml:"pprof"`      // Pprof includes settings for profiling the application.
	Stats       []Prometheus            `yaml:"stats"`      // Stats contains configurations for Prometheus metrics.
	Ipfs        Ipfs                    `yaml:"ipfs"`       // Ipfs configures the IPFS node settings.
	Rpc         Rpc                     `yaml:"rpc"`        // Rpc configures the RPC server settings.
	Cloudflare  Cloudflare              `yaml:"cloudflare"` // Cloudflare holds configurations specific to Cloudflare integrations.
	Sourcify    Sourcify                `yaml:"sourcify"`
	Labels      Labels                  `yaml:"labels"`
	Solc        Solc                    `yaml:"solc"`
	Modules     map[string]ModuleConfig // Modules holds configuration settings for various modular components of the application.
}

type Pprof struct {
	Name    string `yaml:"name"`
	Enabled bool   `yaml:"enabled"`
	Addr    string `yaml:"addr"`
}

type Prometheus struct {
	Name    string `yaml:"name"`
	Enabled bool   `yaml:"enabled"`
	Addr    string `yaml:"addr"`
}

type Queue struct {
	Name          string `yaml:"name"`
	Subject       string `yaml:"subject"`
	DeliveryGroup string `yaml:"deliveryGroup"`
}

type Rpc struct {
	Enabled                bool     `yaml:"enabled"`
	Addr                   string   `yaml:"addr"`
	ExposeSmd              bool     `yaml:"exposeSmd"`
	AllowCORS              bool     `yaml:"allowCORS"`
	DisableTransportChecks bool     `yaml:"disableTransportChecks"`
	Namespaces             []string `yaml:"namespaces"`
	Transports             []string `yaml:"transports"`
	Docs                   bool     `yaml:"docs"`
	DocsTitle              string   `yaml:"docsTitle"`
}

type Solc struct {
	Enabled           bool          `yaml:"enabled"`
	SyncEvery         time.Duration `yaml:"syncEvery"`
	ReleasesPath      string        `yaml:"releasesPath"`
	HttpClientTimeout time.Duration `yaml:"httpClientTimeout"`
}

type Sourcify struct {
	Enabled           bool          `yaml:"enabled"`
	Endpoint          string        `yaml:"endpoint"`
	MaxRetry          int           `yaml:"maxRetry"`
	RetryDelay        time.Duration `yaml:"retryDelay"`
	RateLimit         int           `yaml:"rateLimit"`
	RateLimitDuration time.Duration `yaml:"rateLimitDuration"`
}

type Storage struct {
	Enabled       bool   `yaml:"enabled" json:"enabled"`
	ContractsPath string `yaml:"contractsPath" json:"contractsPath"`
	DatabasePath  string `yaml:"databasePath" json:"databasePath"`
}

type Subscriber struct {
	Enabled           bool   `yaml:"enabled"`
	SubjectName       string `yaml:"subjectName"`
	Network           string `yaml:"network"`
	Resumption        bool   `yaml:"resumption"`
	Type              string `yaml:"type"`
	WorkersCount      int    `yaml:"workersCount"`
	ChannelBufferSize int    `yaml:"channelBufferSize"`
	StartBlockNumber  int    `yaml:"startBlockNumber"`
	EndBlockNumber    int    `yaml:"endBlockNumber"`
}

type Unpacker struct {
	ForceReprocess bool `yaml:"forceReprocess"` // Reprocess all the contracts regardless of their local state
	OtsEnabled     bool `yaml:"otsEnabled"`
}