Documentation
¶
Index ¶
Constants ¶
const (
// HealthzEndpoint is the fixed path for health checks
HealthzEndpoint = "/healthz"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ElP2PClient ¶ added in v1.13.6
func NewElP2PClientAdmin ¶ added in v1.13.6
func NewElP2PClientAdmin(client *ethclient.Client) ElP2PClient
func NewElP2PClientNet ¶ added in v1.13.6
func NewElP2PClientNet(client *ethclient.Client) ElP2PClient
type HealthStatus ¶ added in v1.13.3
type HealthStatus string
HealthStatus represents the health state of rollup-boost.
const ( HealthStatusHealthy HealthStatus = "healthy" HealthStatusPartial HealthStatus = "partial" HealthStatusUnhealthy HealthStatus = "unhealthy" )
type RollupBoostClient ¶ added in v1.13.3
type RollupBoostClient struct {
// contains filtered or unexported fields
}
RollupBoostClient uses HTTP status codes to determine rollup-boost health.
func NewRollupBoostClient ¶ added in v1.13.3
func NewRollupBoostClient(baseURL string, httpClient *http.Client) *RollupBoostClient
NewRollupBoostClient creates a client that interprets HTTP status codes for health.
func (*RollupBoostClient) Healthcheck ¶ added in v1.13.3
func (c *RollupBoostClient) Healthcheck(ctx context.Context) (HealthStatus, error)
Healthcheck returns health status based on HTTP status codes: 200 OK = Healthy, 206 Partial Content = Partial, 503 Service Unavailable = Unhealthy
type RollupBoostHealthChecker ¶ added in v1.16.4
type RollupBoostHealthChecker interface {
Healthcheck(ctx context.Context) (HealthStatus, error)
}
RollupBoostHealthChecker is the common interface for rollup-boost health checking. Both RollupBoostClient and RollupBoostNextClient implement this interface.
type RollupBoostNextClient ¶ added in v1.16.4
type RollupBoostNextClient struct {
// contains filtered or unexported fields
}
RollupBoostNextClient retrieves rollup-boost health using the JSON-based healthcheck endpoint.
func NewRollupBoostNextClient ¶ added in v1.16.4
func NewRollupBoostNextClient(url string, httpClient *http.Client) *RollupBoostNextClient
NewRollupBoostNextClient constructs a client for querying the rollup-boost health endpoint. The url parameter should be the full URL including path (e.g., "http://localhost:8080/healthz").
func (*RollupBoostNextClient) Healthcheck ¶ added in v1.16.4
func (c *RollupBoostNextClient) Healthcheck(ctx context.Context) (HealthStatus, error)
Healthcheck fetches the rollup-boost health endpoint and interprets the JSON payload.
type RollupBoostNextHealthResponse ¶ added in v1.16.4
type RollupBoostNextHealthResponse struct {
Version string `json:"version"`
RollupBoostHealth string `json:"rollup_boost_health"`
}
RollupBoostNextHealthResponse captures the JSON payload returned by the rollup-boost health endpoint.
type SequencerControl ¶
type SequencerControl interface {
StartSequencer(ctx context.Context, hash common.Hash) error
StopSequencer(ctx context.Context) (common.Hash, error)
SequencerActive(ctx context.Context) (bool, error)
LatestUnsafeBlock(ctx context.Context) (eth.BlockInfo, error)
PostUnsafePayload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope) error
ConductorEnabled(ctx context.Context) (bool, error)
}
SequencerControl defines the interface for controlling the sequencer.
func NewSequencerControl ¶
func NewSequencerControl(exec *sources.EthClient, node *sources.RollupClient) SequencerControl
NewSequencerControl creates a new SequencerControl instance.