config

type ClientConfig struct {
	Server  ServerConfig  `yaml:"server"`
	Proxy   ProxyConfig   `yaml:"proxy"`
	Proxies []ProxyConfig `yaml:"proxies,omitempty"`
	// contains filtered or unexported fields
}

type Config struct {
	Server  ServerConfig  `yaml:"server"`
	Sandbox SandboxConfig `yaml:"sandbox"`
	// Proxy is the legacy single-proxy form, promoted to Proxies[0] for
	// back-compat. Prefer Proxies (see config.example.yaml).
	Proxy          ProxyConfig          `yaml:"proxy"`
	Proxies        []ProxyConfig        `yaml:"proxies,omitempty"`
	LocalProxy     LocalProxyConfig     `yaml:"local_proxy,omitempty"`
	Storage        StorageConfig        `yaml:"storage"`
	Observability  ObservabilityConfig  `yaml:"observability"`
	ConsensusSpecs ConsensusSpecsConfig `yaml:"consensus_specs,omitempty"`
	// contains filtered or unexported fields
}

type ConsensusSpecsConfig struct {
	// Repository is the GitHub owner/repo (e.g. "ethereum/consensus-specs").
	// Defaults to "ethereum/consensus-specs".
	Repository string `yaml:"repository,omitempty"`

	// Ref is the git ref (branch, tag, or SHA) to fetch.
	// When empty, the latest GitHub release tag is used.
	Ref string `yaml:"ref,omitempty"`
}

type LocalProxyClickHouseConfig struct {
	// Name is the datasource name to expose when the probe is live.
	Name string `yaml:"name"`
	// Description is the human-readable datasource description.
	Description string `yaml:"description,omitempty"`
	// Host is the ClickHouse host to proxy.
	Host string `yaml:"host"`
	// Port is the ClickHouse HTTP port to proxy.
	Port int `yaml:"port"`
	// Database is the default database for proxied queries.
	Database string `yaml:"database,omitempty"`
	// Username is the optional datasource username.
	Username string `yaml:"username,omitempty"`
	// Password is the optional datasource password.
	Password string `yaml:"password,omitempty"`
	// Secure switches the proxied ClickHouse target to HTTPS.
	Secure bool `yaml:"secure,omitempty"`
	// Autodiscover probes this datasource and only exposes it while live.
	Autodiscover bool `yaml:"autodiscover,omitempty"`
	// AutodiscoverInterval is how often to check liveness.
	AutodiscoverInterval time.Duration `yaml:"autodiscover_interval,omitempty"`
	// Contains declares the datasets stored in this datasource, mirroring the
	// standalone proxy's contains entries. Passed through to discovery verbatim.
	Contains []LocalProxyDatasetBinding `yaml:"contains,omitempty"`
}

type LocalProxyConfig struct {
	// Enabled controls whether the server starts an in-process local proxy.
	// Defaults to true.
	Enabled *bool `yaml:"enabled,omitempty"`

	// ClickHouse configures local ClickHouse datasources for the embedded proxy.
	ClickHouse []LocalProxyClickHouseConfig `yaml:"clickhouse,omitempty"`
}

type LocalProxyDatasetBinding struct {
	Dataset string            `yaml:"dataset"`
	Params  map[string]string `yaml:"params,omitempty"`
	Notes   string            `yaml:"notes,omitempty"`
}

type ObservabilityConfig struct {
	MetricsEnabled bool `yaml:"metrics_enabled"`
	MetricsPort    int  `yaml:"metrics_port"`
	// MetricsAddr is the full address (host:port) to serve metrics on. When set,
	// it takes precedence over MetricsPort.
	MetricsAddr string `yaml:"metrics_addr,omitempty"`
}

type OverrideField struct {
	// Path is the dot-separated config key (e.g., "sandbox.timeout").
	Path string

	// Value is the current value (as it should appear in YAML).
	Value any

	// Default is the base config value; if Value == Default, the field is omitted.
	Default any
}

type ProxyAuthConfig struct {
	// Mode describes the proxy auth flow. "oauth" is the legacy embedded proxy issuer,
	// "oidc" is an external OpenID Connect issuer such as Authentik, and
	// "client_credentials" is the non-interactive service-account flow: access
	// tokens are minted from the issuer's token endpoint using Username +
	// Password (Authentik service-account form), cached in memory, and
	// re-minted before expiry. No credential files are written.
	Mode string `yaml:"mode,omitempty"`

	// IssuerURL is the OAuth issuer URL for proxy authentication.
	IssuerURL string `yaml:"issuer_url"`

	// ClientID is the OAuth client ID for authentication.
	ClientID string `yaml:"client_id"`

	// Username is the service-account username for mode "client_credentials".
	Username string `yaml:"username,omitempty"`

	// Password is the service-account app password for mode "client_credentials".
	// Use ${ENV_VAR} substitution to source it from the environment.
	Password string `yaml:"password,omitempty"`

	// Resource is the optional OAuth resource indicator to request.
	// Leave empty for standard OIDC providers that do not use RFC 8707 resource parameters.
	Resource string `yaml:"resource,omitempty"`

	// Scopes are the OAuth scopes requested at login. When empty, the auth client
	// requests its defaults (openid, email, groups, offline_access). When set,
	// this list is sent verbatim — so include those base scopes plus any extras.
	// For example, requesting the workflow-engine audience makes Authentik
	// cross-grant that audience to the panda-proxy token so the same credential
	// works against the workflow engine in passthrough mode. Omitting
	// offline_access means no refresh token is issued.
	Scopes []string `yaml:"scopes,omitempty"`

	// RefreshTokenTTL is the expected lifetime of the refresh token issued by the
	// OIDC provider. When set, the client will proactively refresh at 50% of this
	// duration to keep the refresh token alive via provider rotation.
	RefreshTokenTTL time.Duration `yaml:"refresh_token_ttl,omitempty"`
}

type ProxyConfig struct {
	// Name is the configured proxy identifier used to tag datasource ownership.
	Name string `yaml:"name,omitempty"`

	// URL is the base URL of the proxy server (e.g., http://localhost:18081).
	URL string `yaml:"url"`

	// Auth configures authentication for the proxy.
	// Optional - if not set, the proxy must allow unauthenticated access.
	Auth *ProxyAuthConfig `yaml:"auth,omitempty"`
}

type SandboxConfig struct {
	Backend        string  `yaml:"backend"`
	Image          string  `yaml:"image"`
	Timeout        int     `yaml:"timeout"`
	MemoryLimit    string  `yaml:"memory_limit"`
	CPULimit       float64 `yaml:"cpu_limit"`
	Network        string  `yaml:"network"`
	HostSharedPath string  `yaml:"host_shared_path,omitempty"`

	// Instance identifies this server's sandbox containers with a custom label.
	// Used to distinguish containers from different server instances (e.g., probe runner vs production).
	// When set, containers are labeled with "io.ethpandaops-panda.instance=<value>".
	Instance string `yaml:"instance,omitempty"`

	// Session configuration for persistent execution environments.
	Sessions SessionConfig `yaml:"sessions"`

	// Logging configuration for sandbox executions.
	Logging SandboxLoggingConfig `yaml:"logging"`
}

type SandboxLoggingConfig struct {
	// LogCode logs the full Python code submitted to execute_python.
	// Disabled by default as code may contain sensitive data.
	LogCode bool `yaml:"log_code"`

	// LogOutput logs stdout and stderr from execution.
	// Disabled by default as output may be large or contain sensitive data.
	LogOutput bool `yaml:"log_output"`
}

type ServerConfig struct {
	Host       string `yaml:"host"`
	Port       int    `yaml:"port"`
	BaseURL    string `yaml:"base_url"`
	SandboxURL string `yaml:"sandbox_url,omitempty"`
	URL        string `yaml:"url,omitempty"`

	// Uploads gates the `panda upload` surface (the upload/publish API and the
	// /u/ preview pages). Unset means enabled; set it to false to opt out.
	// Nothing leaves the machine without an explicit publish either way.
	Uploads *bool `yaml:"uploads,omitempty"`

	// Deprecated: Transport is accepted for backwards compatibility but ignored.
	// The server always runs HTTP with both SSE and streamable-http transports.
	Transport string `yaml:"transport,omitempty"`
}

type SessionConfig struct {
	// Enabled controls whether session support is available. Defaults to true.
	Enabled *bool `yaml:"enabled,omitempty"`
	// TTL is the duration after which an idle session is destroyed (since last use).
	TTL time.Duration `yaml:"ttl"`
	// MaxDuration is the maximum lifetime of a session regardless of activity.
	MaxDuration time.Duration `yaml:"max_duration"`
	// MaxSessions is the maximum number of concurrent sessions allowed.
	MaxSessions int `yaml:"max_sessions"`
}

type StorageConfig struct {
	// BaseDir is the directory where uploaded files are stored.
	// Defaults to ~/.panda/data/storage.
	BaseDir string `yaml:"base_dir,omitempty"`

	// CacheDir is the directory for the local embedding vector cache.
	// Defaults to a "cache" sibling of BaseDir.
	CacheDir string `yaml:"cache_dir,omitempty"`
}