sse

Documentation

Index

• Constants
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithRelay(relayURL string) Option
  • func WithSSEClientOptions(opts ...func(c *sse.Client)) Option
  • func WithTopics(topics ...topics.EventType) Option
• type SSEClient
  • func New(opts ...Option) (*SSEClient, error)
  • func (c *SSEClient) Subscribe(stream string) (chan dto.Result, error)
  • func (c *SSEClient) Unsubscribe()

Constants

const (
	DataEndpoint = "/relay/v1/data/events/realtime"
)

Types

type Option

type Option func(*settings)

func WithContext

func WithContext(ctx context.Context) Option

WithContext is used to provide a specific external context to the client subscription.

func WithRelay

func WithRelay(relayURL string) Option

WithRelay is used to provide the relay to connect to.

func WithSSEClientOptions

func WithSSEClientOptions(opts ...func(c *sse.Client)) Option

WithSSEClientOptions is used to customize SSE Client.

func WithTopics

func WithTopics(topics ...topics.EventType) Option

WithTopics is used to provide which topics to listen to.

type SSEClient

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

SSEClient encapsulates sse.Client and stores the topic to listen to on the Flashbots Relayer.

func New

func New(opts ...Option) (*SSEClient, error)

New creates an SSE client listening to the SSE endpoint on the provided relay. It stores the topics to listen to later on.

func (*SSEClient) Subscribe

func (c *SSEClient) Subscribe(stream string) (chan dto.Result, error)

func (*SSEClient) Unsubscribe

func (c *SSEClient) Unsubscribe()