relay

Documentation

Index

• Variables
• type Client
  • func NewClient(namespace string, config Config, networkName string) (*Client, error)
  • func (c *Client) GetBids(ctx context.Context, params url.Values) ([]*mevrelay.BidTrace, error)
  • func (c *Client) GetProposerPayloadDelivered(ctx context.Context, params url.Values) ([]*mevrelay.ProposerPayloadDelivered, error)
  • func (c *Client) GetValidatorRegistrations(ctx context.Context, pubkey string) (*mevrelay.ValidatorRegistration, error)
  • func (c *Client) Name() string
  • func (c *Client) URL() string
• type Config
  • func (c *Config) Validate() error
• type Metrics
  • func GetMetrics(namespace string) *Metrics
  • func (m *Metrics) IncAPIFailures(relay, endpoint, network string)
  • func (m *Metrics) IncAPIRequests(relay, endpoint, network string)
  • func (m *Metrics) IncBidsReceived(relay, network string, count int)
  • func (m *Metrics) IncProposerPayloadDelivered(relay, network string, count int)
  • func (m *Metrics) IncValidatorRegistrationsReceived(relay, network string, count int)

Variables

var ErrRateLimited = errors.New("rate limited")

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

var (
	GetBidsEndpoint = "get_bids"
)

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

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

func (*Client) GetValidatorRegistrations

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

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

func (*Metrics) IncValidatorRegistrationsReceived

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