ws2

Documentation

Index

• Variables
• type AccountResult
• type Client
  • func New(rpcURL string, logger Logger, maxConnections int, maxSubscriptions int) *Client
  • func (c *Client) AccountSubscribe(ctx context.Context, account string, commitment rpc.CommitmentType) error
  • func (c *Client) AccountSubscribeWithOpts(ctx context.Context, account string, commitment rpc.CommitmentType, ...) error
  • func (c *Client) Close()
  • func (c *Client) Connect(ctx context.Context) (err error)
  • func (c *Client) ConnectWithOptions(ctx context.Context, opt *Options) (err error)
  • func (c *Client) GetSubscriptions() map[uint64]struct{}
  • func (c *Client) Messages() <-chan MessageWS
• type Connection
  • func NewConnection(conn *websocket.Conn, maxSubscriptions int, logger Logger) *Connection
  • func (c *Connection) Close()
  • func (c *Connection) ID() uint64
  • func (c *Connection) Subscribe(params []interface{}, conf map[string]interface{}, subscriptionMethod string, ...) (reqID uint64, err error)
• type Logger
• type MessageError
• type MessageWS
• type Options
• type SubscriptionMeta

Variables

var DefaultHandshakeTimeout = 45 * time.Second

var ErrReachedMaxConnectionsLimit = fmt.Errorf("reached max connections limit")

var ErrReachedMaxSubscriptionsLimit = fmt.Errorf("reached max subscriptions limit")

var ErrReachedMaxSubscriptionsPerClientLimit = fmt.Errorf("reached max subscriptions per client limit")

Types

type AccountResult

type AccountResult struct {
	Context struct {
		Slot uint64
	} `json:"context"`
	Value struct {
		rpc.Account
	} `json:"value"`
}

type Client

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

func New

func New(rpcURL string, logger Logger, maxConnections int, maxSubscriptions int) *Client

func (*Client) AccountSubscribe

func (c *Client) AccountSubscribe(
	ctx context.Context,
	account string,
	commitment rpc.CommitmentType,
) error

AccountSubscribe subscribes to an account to receive notifications when the lamports or data for a given account public key changes.

func (*Client) AccountSubscribeWithOpts

func (c *Client) AccountSubscribeWithOpts(
	ctx context.Context,
	account string,
	commitment rpc.CommitmentType,
	encoding solana.EncodingType,
) error

AccountSubscribe subscribes to an account to receive notifications when the lamports or data for a given account public key changes.

func (*Client) Close

func (c *Client) Close()

func (*Client) Connect

func (c *Client) Connect(ctx context.Context) (err error)

Connect creates a new websocket client connecting to the provided endpoint.

func (*Client) ConnectWithOptions

func (c *Client) ConnectWithOptions(ctx context.Context, opt *Options) (err error)

ConnectWithOptions creates a new websocket client connecting to the provided endpoint with a http header if available The http header can be helpful to pass basic authentication params as prescribed ref https://github.com/gorilla/websocket/issues/209

func (*Client) GetSubscriptions

func (c *Client) GetSubscriptions() map[uint64]struct{}

func (*Client) Messages

func (c *Client) Messages() <-chan MessageWS

type Connection

type Connection struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

func NewConnection

func NewConnection(conn *websocket.Conn, maxSubscriptions int, logger Logger) *Connection

func (*Connection) Close

func (c *Connection) Close()

func (*Connection) ID

func (c *Connection) ID() uint64

func (*Connection) Subscribe

func (c *Connection) Subscribe(
	params []interface{},
	conf map[string]interface{},
	subscriptionMethod string,
	unsubscribeMethod string,
	decoderFunc decoderFunc,
) (reqID uint64, err error)

type Logger

type Logger interface {
	Info(...interface{})
	Error(...interface{})
	Infof(string, ...interface{})
	Errorf(string, ...interface{})
}

type MessageError

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

type MessageWS

type MessageWS struct {
	Account            string
	SubscriptionID     uint64
	Data               []byte
	ConnectionID       uint64
	SubscriptionMethod string
	Encoding           solana.EncodingType
}

type Options

type Options struct {
	HttpHeader       http.Header
	HandshakeTimeout time.Duration
}

type SubscriptionMeta

type SubscriptionMeta struct {
	Account            string
	UnsubscribeMethod  string
	SubscriptionMethod string
	Encoding           solana.EncodingType
}