api

Documentation

Index

• func ConnectionID(conn Connection) string
• func DecidedAPIData(msgs ...*specqbft.SignedMessage) (interface{}, error)
• func HandleDecidedQuery(logger *zap.Logger, qbftStorage qbftstorage.QBFTStore, nm *NetworkMessage)
• func HandleErrorQuery(logger *zap.Logger, nm *NetworkMessage)
• func HandleUnknownQuery(logger *zap.Logger, nm *NetworkMessage)
• type Broadcaster
• type Conn
• type Connection
• type DutyRole
• type Message
  • func NewDecidedAPIMsg(msgs ...*specqbft.SignedMessage) Message
• type MessageFilter
• type MessageType
• type NetworkMessage
• type QueryMessageHandler
• type WSClient
  • func NewWSClient(ctx context.Context, logger *zap.Logger) *WSClient
  • func (client *WSClient) MessageCount() int
  • func (client *WSClient) StartQuery(addr, path string) error
  • func (client *WSClient) StartStream(addr, path string) error
• type WebSocketServer
  • func NewWsServer(ctx context.Context, logger *zap.Logger, handler QueryMessageHandler, ...) WebSocketServer

Functions

func ConnectionID

func ConnectionID(conn Connection) string

ConnectionID calculates the id of the given Connection

func DecidedAPIData

func DecidedAPIData(msgs ...*specqbft.SignedMessage) (interface{}, error)

DecidedAPIData creates a new message from the given message

func HandleDecidedQuery

func HandleDecidedQuery(logger *zap.Logger, qbftStorage qbftstorage.QBFTStore, nm *NetworkMessage)

HandleDecidedQuery handles TypeDecided queries.

func HandleErrorQuery

func HandleErrorQuery(logger *zap.Logger, nm *NetworkMessage)

HandleErrorQuery handles TypeError queries.

func HandleUnknownQuery

func HandleUnknownQuery(logger *zap.Logger, nm *NetworkMessage)

HandleUnknownQuery handles unknown queries.

Types

type Broadcaster

type Broadcaster interface {
	FromFeed(feed *event.Feed) error
	Broadcast(msg Message) error
	Register(conn broadcasted) bool
	Deregister(conn broadcasted) bool
}

Broadcaster is an interface broadcasting stream message across all available connections

type Conn

type Conn interface {
	ID() string
	ReadNext() []byte
	Send(msg []byte)
	WriteLoop()
	ReadLoop()
	Close() error
	RemoteAddr() net.Addr
}

Conn is a wrapper interface for websocket connections

type Connection

type Connection interface {
	Close() error
	RemoteAddr() net.Addr
}

Connection is an interface to abstract the actual websocket connection implementation

type DutyRole

type DutyRole string

DutyRole is the role of the duty

const (
	// RoleAttester is an enum for attester role
	RoleAttester DutyRole = "ATTESTER"
	// RoleAggregator is an enum for aggregator role
	RoleAggregator DutyRole = "AGGREGATOR"
	// RoleProposer is an enum for proposer role
	RoleProposer DutyRole = "PROPOSER"
)

type Message

type Message struct {
	// Type is the type of message
	Type MessageType `json:"type"`
	// Filter
	Filter MessageFilter `json:"filter"`
	// Values holds the results, optional as it's relevant for response
	Data interface{} `json:"data,omitempty"`
}

Message represents an exporter message

func NewDecidedAPIMsg

func NewDecidedAPIMsg(msgs ...*specqbft.SignedMessage) Message

NewDecidedAPIMsg creates a new message from the given message TODO: avoid converting to v0 once explorer is upgraded

type MessageFilter

type MessageFilter struct {
	// From is the starting index of the desired data
	From uint64 `json:"from"`
	// To is the ending index of the desired data
	To uint64 `json:"to"`
	// Role is the duty type enum, optional as it's relevant for IBFT data
	Role DutyRole `json:"role,omitempty"`
	// PublicKey is optional, used for fetching decided messages or information about specific validator/operator
	PublicKey string `json:"publicKey,omitempty"`
}

MessageFilter is a criteria for query in request messages and projection in responses

type MessageType

type MessageType string

MessageType is the type of message being sent

const (
	// TypeValidator is an enum for validator type messages
	TypeValidator MessageType = "validator"
	// TypeOperator is an enum for operator type messages
	TypeOperator MessageType = "operator"
	// TypeDecided is an enum for ibft type messages
	TypeDecided MessageType = "decided"
	// TypeError is an enum for error type messages
	TypeError MessageType = "error"
)

type NetworkMessage

type NetworkMessage struct {
	Msg  Message
	Err  error
	Conn Connection
}

NetworkMessage wraps an actual message with more information

type QueryMessageHandler

type QueryMessageHandler func(nm *NetworkMessage)

QueryMessageHandler handles the given message

type WSClient

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

WSClient represents a client connection to be used in tests

func NewWSClient

func NewWSClient(ctx context.Context, logger *zap.Logger) *WSClient

NewWSClient creates a new instance of ws client

func (*WSClient) MessageCount

func (client *WSClient) MessageCount() int

MessageCount returns the count of incoming messages

func (*WSClient) StartQuery

func (client *WSClient) StartQuery(addr, path string) error

StartQuery initiates query requests

func (*WSClient) StartStream

func (client *WSClient) StartStream(addr, path string) error

StartStream initiates stream

type WebSocketServer

type WebSocketServer interface {
	Start(addr string) error
	BroadcastFeed() *event.Feed
	UseQueryHandler(handler QueryMessageHandler)
}

WebSocketServer is responsible for managing all

func NewWsServer

func NewWsServer(ctx context.Context, logger *zap.Logger, handler QueryMessageHandler, mux *http.ServeMux, withPing bool) WebSocketServer

NewWsServer creates a new instance