playground

type ArtifactsBuilder struct {
	// contains filtered or unexported fields
}

type BProxy struct {
	TargetAuthrpc         string
	Peers                 []string
	Flashblocks           bool
	FlashblocksBuilderURL string
}

type Bootnode struct {
	Protocol BootnodeProtocol
	Enode    *EnodeAddr
}

type BootnodeProtocol string

type BootnodeRef struct {
	Service string
	ID      string
}

type BuilderHub struct {
	BuilderIP     string
	BuilderConfig string
}

type BuilderNetRecipe struct {
	// contains filtered or unexported fields
}

type Callback func(serviceName string, update TaskStatus)

type ChainMonitor struct {
	L1RPC            string
	L2BlockTime      uint64
	L2BuilderAddress string
	L2RPC            string
}

type ClProxy struct {
	PrimaryBuilder   string
	SecondaryBuilder string
}

type Component struct {
	Name     string
	Services []*Service
	Inner    []*Component
}

type ComponentGen interface {
	Apply(manifest *ExContext) *Component
}

type Contender struct {
	ExtraArgs   []string
	TargetChain string // defaults to "el", may be any chain name in a recipe's spec
}

type ContenderContext struct {
	// Run `contender spam` automatically once all playground services are running.
	Enabled bool

	// Provide additional args to contender's CLI.
	ExtraArgs []string

	// Override the default target chain for contender to spam.
	TargetChain string
}

type CustomRecipeInfo struct {
	Name               string
	Description        string
	Base               string
	ModifiedComponents []string
	NewComponents      []string
}

type DependsOn struct {
	Name      string
	Condition DependsOnCondition
}

type DependsOnCondition string

type EnodeAddr struct {
	PrivKey  *ecdsa.PrivateKey
	Artifact string
}

type ExContext struct {
	LogLevel LogLevel

	// This dependency is not ideal. Doing it so that I do not
	// have to modify the serviceDesc interface to give services
	// access to the output.
	Output *output

	// Bootnode reference for EL nodes.
	// TODO: Extend for CL nodes too
	Bootnode *BootnodeRef

	Contender *ContenderContext
}

type Fileserver struct{}

type FlashblocksRPC struct {
	FlashblocksWSService string
	BaseOverlay          bool
	UseWebsocketProxy    bool // Whether to add /ws path for websocket proxy
}

type HealthCheckResponse struct {
	Output   string
	ExitCode int
}

type InteractiveDisplay struct {
	// contains filtered or unexported fields
}

type L1Recipe struct {
	// contains filtered or unexported fields
}

type LighthouseBeaconNode struct {
	ExecutionNode string
	MevBoostNode  string
}

type LighthouseValidator struct {
	BeaconNode string
}

type LocalRunner struct {
	// contains filtered or unexported fields
}

type LogLevel string

type Manifest struct {
	ID string `json:"session_id"`

	// list of Services
	Services []*Service `json:"services"`

	Bootnode *BootnodeRef `json:"bootnode,omitempty"`

	// Setup contains shell commands to run before any services are launched.
	// Commands run sequentially in SetupDir; each must exit 0.
	Setup []string `json:"setup,omitempty"`

	// SetupDir is the working directory for setup commands.
	SetupDir string `json:"setup_dir,omitempty"`
	// contains filtered or unexported fields
}

type MapStringFlag map[string]string

type MevBoost struct {
	RelayEndpoints []string
}

type MevBoostRelay struct {
	BeaconClient     string
	ValidationServer string
}

type NodeRef struct {
	Service   string `json:"service"`
	PortLabel string `json:"port_label"`
	Protocol  string `json:"protocol"`
	User      string `json:"user"`
}

type OpBatcher struct {
	L1Node             string
	L2Node             string
	RollupNode         string
	MaxChannelDuration uint64
}

type OpGenesisTmplInput struct {
	Timestamp  uint64
	LatestFork *uint64
}

type OpGeth struct {
	// outputs
	Enode *EnodeAddr
}

type OpNode struct {
	L1Node   string
	L1Beacon string
	L2Node   string
}

type OpRbuilder struct {
	Flashblocks bool
}

type OpRecipe struct {
	// contains filtered or unexported fields
}

type OpReth struct{}

type Port struct {
	// Name is the name of the port
	Name string `json:"name"`

	// Port is the port number
	Port int `json:"port"`

	// Protocol (tcp or udp)
	Protocol string

	// HostPort is the port number assigned on the host machine for this
	// container port. It is populated by the local runner
	// TODO: We might want to move this to the runner itself.
	HostPort int
}

type Rbuilder struct{}

type ReadyCheck struct {
	QueryURL    string        `json:"query_url"`
	Test        []string      `json:"test"`
	Interval    time.Duration `json:"interval"`
	StartPeriod time.Duration `json:"start_period"`
	Timeout     time.Duration `json:"timeout"`
	Retries     int           `json:"retries"`
}

type Recipe interface {
	Name() string
	Description() string
	Flags() *flag.FlagSet
	Artifacts() *ArtifactsBuilder
	Apply(ctx *ExContext) *Component
	Output(manifest *Manifest) map[string]interface{}
}

type RethEL struct {
	UseRethForValidation bool
	UseNativeReth        bool
}

type RollupBoost struct {
	ELNode  string
	Builder string

	Flashblocks           bool
	FlashblocksBuilderURL string
}

type RunnerConfig struct {
	Out                  *output
	Manifest             *Manifest
	BindHostPortsLocally bool
	NetworkName          string
	Labels               map[string]string
	LogInternally        bool
	Platform             string
	Callbacks            []Callback
}

type Service struct {
	Name string   `json:"name"`
	Args []string `json:"args"`

	Labels map[string]string `json:"labels,omitempty"`

	// list of environment variables to set for the service
	Env map[string]string `json:"env,omitempty"`

	ReadyCheck *ReadyCheck `json:"ready_check,omitempty"`

	DependsOn []*DependsOn `json:"depends_on,omitempty"`

	Ports    []*Port    `json:"ports,omitempty"`
	NodeRefs []*NodeRef `json:"node_refs,omitempty"`

	FilesMapped   map[string]string        `json:"files_mapped,omitempty"`
	VolumesMapped map[string]*VolumeMapped `json:"volumes_mapped,omitempty"`

	Tag        string `json:"tag,omitempty"`
	Image      string `json:"image,omitempty"`
	Entrypoint string `json:"entrypoint,omitempty"`
	HostPath   string `json:"host_path,omitempty"`

	UngracefulShutdown bool `json:"ungraceful_shutdown,omitempty"`

	// LifecycleHooks enables lifecycle mode for host execution
	LifecycleHooks bool `json:"lifecycle_hooks,omitempty"`
	// Init commands run sequentially before start. Each must return exit code 0.
	Init []string `json:"init,omitempty"`
	// Start command runs the service (for lifecycle hooks). May hang or return 0.
	Start string `json:"start,omitempty"`
	// Stop commands run when playground exits. May return non-zero (best effort).
	Stop []string `json:"stop,omitempty"`
	// RecipeDir is the directory containing the recipe file (for lifecycle hooks)
	RecipeDir string `json:"recipe_dir,omitempty"`
	// contains filtered or unexported fields
}

type ServiceReady interface {
	Ready(service *Service) error
}

type TaskStatus string

type TestTxConfig struct {
	RPCURL            string // Target RPC URL for sending transactions (e.g., rbuilder)
	ELRPCURL          string // EL RPC URL for chain queries (e.g., reth). If empty, uses RPCURL
	PrivateKey        string
	ToAddress         string
	Value             *big.Int
	GasLimit          uint64
	GasPrice          *big.Int
	Timeout           time.Duration // Timeout for waiting for receipt. If 0, no timeout.
	Retries           int           // Max failed receipt requests before giving up. If 0, retry forever.
	Insecure          bool          // Skip TLS certificate verification
	ExpectedExtraData string        // If set, verify block extra data matches this string
}

type ValidationResult struct {
	Errors   []string
	Warnings []string
}

type VolumeMapped struct {
	Name    string
	IsLocal bool
}

type WebsocketProxy struct {
	Upstream string
}

type YAMLComponentConfig struct {
	// Remove indicates whether to remove this component
	Remove bool `yaml:"remove,omitempty"`

	// Services is a map of service name to service config
	Services map[string]*YAMLServiceConfig `yaml:"services,omitempty"`
}

type YAMLRecipe struct {
	// contains filtered or unexported fields
}

type YAMLRecipeConfig struct {
	// Base is the name of the base recipe (l1, opstack, buildernet)
	Base string `yaml:"base"`

	// BaseArgs are arguments to pass to the base recipe's flags
	BaseArgs []string `yaml:"base_args,omitempty"`

	// Description is an optional description of the recipe
	Description string `yaml:"description,omitempty"`

	// Setup is a list of shell commands to run before any services are launched.
	// Commands run sequentially in the recipe's directory; each must exit 0.
	Setup []string `yaml:"setup,omitempty"`

	// Recipe contains the component/service hierarchy to apply as overrides or additions
	Recipe map[string]*YAMLComponentConfig `yaml:"recipe"`
}

type YAMLReleaseConfig struct {
	Name    string `yaml:"name"`
	Org     string `yaml:"org"`
	Repo    string `yaml:"repo,omitempty"`
	Version string `yaml:"version"`
	// Format specifies the download format: "tar.gz" (default) or "binary"
	// For "binary", downloads the raw binary directly without extraction
	Format string `yaml:"format,omitempty"`
}

type YAMLServiceConfig struct {
	// Remove indicates whether to remove this service
	Remove bool `yaml:"remove,omitempty"`

	// Image is the docker image to use
	Image string `yaml:"image,omitempty"`

	// Tag is the docker image tag
	Tag string `yaml:"tag,omitempty"`

	// Entrypoint overrides the container entrypoint
	Entrypoint string `yaml:"entrypoint,omitempty"`

	// Args are the arguments to pass to the service.
	// This should be used when ReplaceArgs is not used.
	Args []string `yaml:"args,omitempty"`

	// ReplaceArgs are the arguments to replace in the service.
	// This should be used when Args is not used.
	ReplaceArgs []string `yaml:"replace_args,omitempty"`

	// Env is a map of environment variables
	Env map[string]string `yaml:"env,omitempty"`

	// Ports is a map of port name to port number
	Ports map[string]int `yaml:"ports,omitempty"`

	// Files is a map of container path to file source
	// File source can be:
	// - "artifact:<name>" to reference a runtime-generated artifact (e.g., "artifact:genesis.json")
	// - A relative path to a file in the same directory as the YAML recipe file
	Files map[string]string `yaml:"files,omitempty"`

	// Volumes is a map of container path to volume name
	Volumes map[string]*YAMLVolumeMappedConfig `yaml:"volumes,omitempty"`

	// DependsOn is a list of services this service depends on
	// Format: "service_name" or "service_name:condition" where condition is "healthy" or "running"
	DependsOn []string `yaml:"depends_on,omitempty"`

	// HostPath is the path to the binary on the host to run instead of Docker
	// When set, the service runs on the host machine instead of in a container
	HostPath string `yaml:"host_path,omitempty"`

	// Release specifies a GitHub release to download for host execution
	Release *YAMLReleaseConfig `yaml:"release,omitempty"`

	// ReadyCheck is a URL to check for service readiness (used for health checks)
	// Format: "http://localhost:PORT/path" - the service is ready when this URL returns 200
	ReadyCheck string `yaml:"ready_check,omitempty"`

	// LifecycleHooks enables lifecycle mode for host execution
	// When true, init/start/stop commands are used instead of host_path/release
	LifecycleHooks bool `yaml:"lifecycle_hooks,omitempty"`

	// Init commands run sequentially before start. Each must return exit code 0.
	// Only used when lifecycle_hooks is true
	Init []string `yaml:"init,omitempty"`

	// Start command runs the service. May hang (long-running) or return 0.
	// Only used when lifecycle_hooks is true
	Start string `yaml:"start,omitempty"`

	// Stop commands run when playground exits. May return non-zero (best effort).
	// Only used when lifecycle_hooks is true
	Stop []string `yaml:"stop,omitempty"`
}

type YAMLVolumeMappedConfig struct {
	Name    string `yaml:"name"`
	IsLocal bool   `yaml:"is_local"`
}