compose

type AutoConfig struct {
	// Dir is the directory to use for compose artifacts.
	Dir string
	// AlertTimeout is the timeout to collect alerts before shutdown. Zero disables timeout.
	AlertTimeout time.Duration
	// SudoPerms enables changing all compose artefacts file permissions using sudo.
	SudoPerms bool
	// Print generated docker-compose.yml files.
	PrintYML bool
	// RunTmplFunc allows arbitrary overrides in the run step template.
	RunTmplFunc func(*TmplData)
	// DefineTmplFunc allows arbitrary overrides if the define step template.
	DefineTmplFunc func(*TmplData)
	// LogFile enables writing (appending) docker-compose output to this file path instead of stdout.
	LogFile string
}

type Config struct {
	// Version defines the compose config version.
	Version string `json:"version"`

	// Step defines the current completed compose step.
	Step step `json:"step"`

	// NumNodes is the number of charon nodes in the cluster.
	NumNodes int `json:"num_nodes"`

	// Threshold required for signature reconstruction. Defaults to safe value for number of nodes/peers.
	Threshold int `json:"threshold"`

	// NumValidators is the number of DVs (n*32ETH) to be created in the cluster lock file.
	NumValidators int `json:"num_validators"`

	// ImageTag defines the charon docker image tag: obolnetwork/charon:{ImageTag}.
	ImageTag string `json:"image_tag"`

	// BuildBinary enables building a local charon binary from source and using that in the containers.
	BuildBinary bool `json:"build_binary"`

	// PrebuiltBinary enables using a prebuilt local charon binary to use in the containers.
	PrebuiltBinary bool `json:"prebuilt_binary"`

	// KeyGen defines the key generation process.
	KeyGen KeyGen `json:"key_gen"`

	// SplitKeysDir directory containing keys to split for keygen==create.
	SplitKeysDir string `json:"split_keys_dir"`

	// BeaconNode url endpoint or "mock" for simnet.
	BeaconNode string `json:"beacon_node"`

	// ExternalBootnode HTTP url endpoint or empty to disable.
	ExternalBootnode string `json:"external_bootnode"`

	// VCs define the types of validator clients to use.
	VCs []VCType `json:"validator_clients"`

	// FeatureSet defines the minimum feature set to enable.
	FeatureSet string `json:"feature_set"`

	// DisableMonitoringPorts defines whether to disable prometheus and jaeger monitoring port binding.
	DisableMonitoringPorts bool `json:"disable_monitoring_ports"`

	// InsecureKeys generates insecure keys. Useful when testing large validator sets
	// as it speeds up keystore encryption and decryption.
	InsecureKeys bool `json:"insecure_keys"`
}

type KeyGen string

type RunFunc func(context.Context, string, Config) (TmplData, error)

type TmplData struct {
	ComposeDir string

	CharonImageTag   string
	CharonEntrypoint string
	CharonCommand    string

	Nodes []TmplNode
	VCs   []TmplVC

	Bootnode        bool
	Monitoring      bool
	MonitoringPorts bool
}

type TmplNode struct {
	ImageTag   string // ImageTag is empty by default, resulting in CharonImageTag being used.
	Entrypoint string // Entrypoint is empty by default, resulting in CharonEntrypoint being used.
	EnvVars    []kv
	Ports      []port
}

type TmplVC struct {
	Label   string
	Image   string
	Build   string
	Command string
	Ports   []port
}

type VCType string