wsclient

Documentation

Index

• type AggregateSubscriptionArgs
• type NFTEventsSubscriptionArgs
• type PairEventsSubscriptionArgs
• type PriceUpdateSubscriptionArgs
• type SubscriptionAuth
• type SubscriptionConfig
• type SubscriptionOptions
• type SubscriptionPayload
• type SubscriptionPayloadExtensions
• type WSClient
  • func New(apiKey string) WSClient
  • func (ws *WSClient) Close() error
  • func (ws *WSClient) SubscribeToAggregates(args AggregateSubscriptionArgs) (*chan *AggregateBatchUpdate, *chan struct{}, error)
  • func (ws *WSClient) SubscribeToNFTEvents(args NFTEventsSubscriptionArgs) (*chan *NFTEvent, *chan struct{}, error)
  • func (ws *WSClient) SubscribeToPairEvents(args PairEventsSubscriptionArgs) (*chan *Event, *chan struct{}, error)
  • func (ws *WSClient) SubscribeToPriceUpdates(args PriceUpdateSubscriptionArgs) (*chan *PriceUpdate, *chan struct{}, error)
• type WSMsg

Types

type AggregateSubscriptionArgs

type AggregateSubscriptionArgs struct {
	Id string
	SubscriptionOptions
}

type NFTEventsSubscriptionArgs

type NFTEventsSubscriptionArgs struct {
	Address   string
	NetworkId int
	SubscriptionOptions
}

type PairEventsSubscriptionArgs

type PairEventsSubscriptionArgs struct {
	Id string
	SubscriptionOptions
}

type PriceUpdateSubscriptionArgs

type PriceUpdateSubscriptionArgs struct {
	Address   string
	NetworkId int
	SubscriptionOptions
}

type SubscriptionAuth

type SubscriptionAuth struct {
	Host          string `json:"host"`
	Authorization string `json:"Authorization"`
}

type SubscriptionConfig

type SubscriptionConfig struct {
	Id      string              `json:"id"`
	Payload SubscriptionPayload `json:"payload"`
	Type    string              `json:"type"`
}

type SubscriptionOptions

type SubscriptionOptions struct {
	SubscriptionId string
	Query          string
}

type SubscriptionPayload

type SubscriptionPayload struct {
	Data       string                        `json:"data"`
	Extensions SubscriptionPayloadExtensions `json:"extensions"`
}

type SubscriptionPayloadExtensions

type SubscriptionPayloadExtensions struct {
	Authorization SubscriptionAuth `json:"authorization"`
}

type WSClient

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

func New

func New(apiKey string) WSClient

func (*WSClient) Close

func (ws *WSClient) Close() error

func (*WSClient) SubscribeToAggregates

func (ws *WSClient) SubscribeToAggregates(
	args AggregateSubscriptionArgs,
) (*chan *AggregateBatchUpdate, *chan struct{}, error)

func (*WSClient) SubscribeToNFTEvents

func (ws *WSClient) SubscribeToNFTEvents(
	args NFTEventsSubscriptionArgs,
) (*chan *NFTEvent, *chan struct{}, error)

func (*WSClient) SubscribeToPairEvents

func (ws *WSClient) SubscribeToPairEvents(
	args PairEventsSubscriptionArgs,
) (*chan *Event, *chan struct{}, error)

func (*WSClient) SubscribeToPriceUpdates

func (ws *WSClient) SubscribeToPriceUpdates(
	args PriceUpdateSubscriptionArgs,
) (*chan *PriceUpdate, *chan struct{}, error)

type WSMsg

type WSMsg struct {
	Id      string          `json:"id"`
	Type    string          `json:"type"`
	Payload json.RawMessage `json:"payload"`
}