relay

package

v1.7.1 Latest Latest Go to latest Published: Dec 17, 2025 License: GPL-3.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethpandaops/xatu

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func IsRetryableError(err error) bool
type Client
- func NewClient(namespace string, config Config, networkName string) (*Client, error)
type Config
- func (c *Config) Validate() error
type Metrics
- func GetMetrics(namespace string) *Metrics
type RelayError
- func IsRelayError(err error) (*RelayError, bool)
- func NewRelayError(statusCode int, message, endpoint string) *RelayError

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	GetProposerPayloadEndpoint       = "get_proposer_payload"
	GetValidatorRegistrationEndpoint = "get_validator_registration"
)

API endpoint constants

View Source

var (
	ErrValidatorNotRegistered = errors.New("validator not registered")
	ErrRateLimited            = errors.New("rate limited")
)

Sentinel errors for specific conditions.

View Source

var (
	GetBidsEndpoint = "get_bids"
)

Functions ¶

func IsRetryableError ¶ added in v1.7.1

func IsRetryableError(err error) bool

IsRetryableError checks if an error is retryable (either a retryable RelayError or a network error).

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(namespace string, config Config, networkName string) (*Client, error)

NewClient creates a new relay client

func (*Client) GetBids ¶

func (c *Client) GetBids(ctx context.Context, params url.Values) ([]*mevrelay.BidTrace, error)

func (*Client) GetProposerPayloadDelivered ¶ added in v0.0.197

func (c *Client) GetProposerPayloadDelivered(ctx context.Context, params url.Values) ([]*mevrelay.ProposerPayloadDelivered, error)

func (*Client) GetValidatorRegistrations ¶ added in v1.0.24

func (c *Client) GetValidatorRegistrations(ctx context.Context, pubkey string) (*mevrelay.ValidatorRegistration, error)

func (*Client) Name ¶

func (c *Client) Name() string

func (*Client) URL ¶

func (c *Client) URL() string

type Config ¶

type Config struct {
	URL  string `yaml:"url"`
	Name string `yaml:"name"`
}

func (*Config) Validate ¶

func (c *Config) Validate() error

type Metrics ¶

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

func GetMetrics ¶

func GetMetrics(namespace string) *Metrics

func (*Metrics) IncAPIFailures ¶

func (m *Metrics) IncAPIFailures(relay, endpoint, network string)

func (*Metrics) IncAPIRequests ¶

func (m *Metrics) IncAPIRequests(relay, endpoint, network string)

func (*Metrics) IncBidsReceived ¶

func (m *Metrics) IncBidsReceived(relay, network string, count int)

func (*Metrics) IncProposerPayloadDelivered ¶ added in v0.0.197

func (m *Metrics) IncProposerPayloadDelivered(relay, network string, count int)

func (*Metrics) IncValidatorRegistrationsReceived ¶ added in v1.0.24

func (m *Metrics) IncValidatorRegistrationsReceived(relay, network string, count int)

func (*Metrics) ObserveResponseTime ¶ added in v1.0.52

func (m *Metrics) ObserveResponseTime(relay, endpoint, network string, duration float64)

type RelayError ¶ added in v1.7.1

type RelayError struct {
	StatusCode int
	Message    string
	Endpoint   string
}

RelayError represents an error from the relay API with status code information.

func IsRelayError ¶ added in v1.7.1

func IsRelayError(err error) (*RelayError, bool)

IsRelayError checks if an error is a RelayError and returns it.

func NewRelayError ¶ added in v1.7.1

func NewRelayError(statusCode int, message, endpoint string) *RelayError

NewRelayError creates a new RelayError.

func (*RelayError) Error ¶ added in v1.7.1

func (e *RelayError) Error() string

func (*RelayError) IsClientError ¶ added in v1.7.1

func (e *RelayError) IsClientError() bool

IsClientError returns true if the error is a 4xx client error (excluding rate limiting).

func (*RelayError) IsRateLimited ¶ added in v1.7.1

func (e *RelayError) IsRateLimited() bool

IsRateLimited returns true if the error is due to rate limiting.

func (*RelayError) IsRetryable ¶ added in v1.7.1

func (e *RelayError) IsRetryable() bool

IsRetryable returns true if the error is likely transient and the request should be retried.

func (*RelayError) IsServerError ¶ added in v1.7.1

func (e *RelayError) IsServerError() bool

IsServerError returns true if the error is a 5xx server error.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL