config

type ComponentConfig struct {
	// ID is the component identifier.
	ID component.ID `yaml:"id"`

	// TEE specifies the kind of Trusted Execution Environment (TEE)
	// in which the component should run (none, sgx, tdx).
	//
	// If not provided, the TEE kind is selected automatically.
	TEE TEESelectMode `yaml:"tee,omitempty"`

	// Disabled specifies whether the component is disabled. If a component is specified and not
	// disabled, it is enabled.
	Disabled bool `yaml:"disabled,omitempty"`

	// Networking contains the networking configuration for a component.
	Networking NetworkingConfig `yaml:"networking,omitempty"`

	// Permissions is the list of permissions for this component.
	Permissions []ComponentPermission `yaml:"permissions,omitempty"`

	// Config contains component local configuration.
	Config map[string]any `yaml:"config,omitempty"`
}

type ComponentPermission string

type Config struct {
	// Runtimes is the list of runtimes to configure.
	Runtimes []RuntimeConfig `yaml:"runtimes,omitempty"`

	// Paths to runtime bundles.
	Paths []string `yaml:"paths,omitempty"`

	// Runtime provisioner to use (mock, unconfined, sandboxed).
	Provisioner RuntimeProvisioner `yaml:"provisioner"`

	// Path to the sandbox binary (bubblewrap).
	SandboxBinary string `yaml:"sandbox_binary,omitempty"`

	// Path to SGX runtime loader binary (for SGX runtimes).
	// NOTE: This may go away in the future, use `SGX.Loader` instead.
	SGXLoader string `yaml:"sgx_loader,omitempty"`

	// The runtime environment (sgx, elf, auto).
	// NOTE: This may go away in the future, use `DebugMockTEE` instead.
	Environment RuntimeEnvironment `yaml:"environment,omitempty"`

	// History pruner configuration.
	Prune PruneConfig `yaml:"prune,omitempty"`

	// Indexer is history indexer configuration.
	Indexer IndexerConfig `yaml:"indexer,omitempty"`

	// RuntimeConfig maps runtime IDs to their respective local configurations.
	// NOTE: This may go away in the future, use `RuntimeConfig.Config` instead.
	RuntimeConfig map[string]map[string]any `yaml:"config,omitempty"`

	// Address(es) of sentry node(s) to connect to of the form [PubKey@]ip:port
	// (where the PubKey@ part represents base64 encoded node TLS public key).
	SentryAddresses []string `yaml:"sentry_addresses,omitempty"`

	// Transaction pool configuration.
	TxPool tpConfig.Config `yaml:"tx_pool,omitempty"`

	// Number of epochs before runtime activation epoch when to start the runtime to warm it up and
	// prepare any required attestations. Zero disables pre-warming.
	PreWarmEpochs uint64 `yaml:"pre_warm_epochs,omitempty"`

	// AttestInterval is the interval for periodic runtime re-attestation. If not specified
	// a default will be used.
	AttestInterval time.Duration `yaml:"attest_interval,omitempty"`

	// LoadBalancer is the load balancer configuration.
	LoadBalancer LoadBalancerConfig `yaml:"load_balancer,omitempty"`

	// Registries is the list of base URLs used to fetch runtime bundle metadata.
	//
	// The actual metadata URLs are constructed by appending the manifest hash
	// to the base URL. Therefore, the provided URLs don't need to be valid
	// endpoints themselves, only the constructed URLs need to be valid.
	Registries []string `yaml:"registries,omitempty"`

	// MaxBundleSize is the maximum allowed bundle size.
	//
	// If not specified, a default value is used.
	MaxBundleSize string `yaml:"max_bundle_size,omitempty"`

	// DebugMockTEE enables mocking of the Trusted Execution Environment (TEE).
	//
	// This flag can only be used if the DebugDontBlameOasis flag is set.
	DebugMockTEE bool `yaml:"debug_mock_tee,omitempty"`

	// SGX is configuration specific to Intel SGX.
	SGX SgxConfig `yaml:"sgx,omitempty"`

	// TDX is configuration specific to Intel TDX.
	TDX TdxConfig `yaml:"tdx,omitempty"`

	// Log is the runtime log config.
	Log LogConfig `yaml:"log,omitempty"`
}

type IncomingNetworkingConfig struct {
	// IP is the host IP address to expose to the component.
	IP string `yaml:"ip,omitempty"`
	// Protocol is the optional protocol to expose to the component.
	Protocol string `yaml:"protocol,omitempty"`
	// SrcPort is the source port (on the host).
	SrcPort uint16 `yaml:"src_port"`
	// DstPort is the optional destination port (in the component).
	DstPort uint16 `yaml:"dst_port,omitempty"`
}

type IndexerConfig struct {
	// BatchSize is max number of blocks committed in a batch during history reindex.
	//
	// Setting it to zero uses the default batch size.
	BatchSize uint16 `yaml:"batch_size,omitempty"`
}

type LoadBalancerConfig struct {
	// NumInstances is the number of runtime instances to provision for load-balancing.
	//
	// Setting it to zero or one disables load balancing.
	NumInstances uint64 `yaml:"num_instances,omitempty"`
}

type LogConfig struct {
	// MaxLogSize is the maximum log size in bytes.
	MaxLogSize int `yaml:"max_log_size,omitempty"`
}

type NetworkingConfig struct {
	// Incoming is a list of IPs/ports to expose to the component from the host.
	Incoming []IncomingNetworkingConfig `yaml:"incoming,omitempty"`
}

type PruneConfig struct {
	// History pruner strategy.
	Strategy string `yaml:"strategy"`
	// History pruning interval.
	Interval time.Duration `yaml:"interval"`
	// Number of last rounds to keep.
	NumKept uint64 `yaml:"num_kept"`
}

type RuntimeConfig struct {
	// ID is the runtime identifier.
	ID common.Namespace `yaml:"id"`

	// Components is the list of components to configure.
	Components []ComponentConfig `yaml:"components,omitempty"`

	// Config contains runtime local configuration.
	// NOTE: This may go away in the future, use `Components.Config` instead.
	Config map[string]any `yaml:"config,omitempty"`

	// Registries is the list of base URLs used to fetch runtime bundle metadata.
	//
	// The actual metadata URLs are constructed by appending the manifest hash
	// to the base URL. Therefore, the provided URLs don't need to be valid
	// endpoints themselves, only the constructed URLs need to be valid.
	Registries []string `yaml:"registries,omitempty"`
}

type RuntimeEnvironment string

type RuntimeProvisioner string

type SgxConfig struct {
	// Loader is the path to the SGX runtime loader binary.
	Loader string `yaml:"loader,omitempty"`
}

type TEESelectMode string

type TdxConfig struct {
	// CidStart is the start of the CID range allocated to VMs.
	CidStart uint32 `yaml:"cid_start,omitempty"`
	// CidCount is the number of CIDs allocated to VMs.
	CidCount uint32 `yaml:"cid_count,omitempty"`
}