websockets

Documentation

Index

• type ErrorMessageJSON
• type ErrorResponseJSON
• type JsonrpcMessage
• type PubSubAPI
  • func NewAPI(clientCtx context.Context) *PubSubAPI
• type Server
  • func NewServer(clientCtx context.Context, wsAddr string) *Server
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Start()
• type SubscriptionNotification
• type SubscriptionResponseJSON
• type SubscriptionResult

Types

type ErrorMessageJSON

type ErrorMessageJSON struct {
	Code    *big.Int `json:"code"`
	Message string   `json:"message"`
}

type ErrorResponseJSON

type ErrorResponseJSON struct {
	Jsonrpc string            `json:"jsonrpc"`
	Error   *ErrorMessageJSON `json:"error"`
	ID      *big.Int          `json:"id"`
}

type JsonrpcMessage

type JsonrpcMessage struct {
	Version string          `json:"jsonrpc,omitempty"`
	ID      json.RawMessage `json:"id,omitempty"`
	Method  string          `json:"method,omitempty"`
	Params  json.RawMessage `json:"params,omitempty"`
	Error   *jsonError      `json:"error,omitempty"`
	Result  json.RawMessage `json:"result,omitempty"`
}

type PubSubAPI

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

PubSubAPI is the eth_ prefixed set of APIs in the Web3 JSON-RPC spec

func NewAPI

func NewAPI(clientCtx context.Context) *PubSubAPI

NewAPI creates an instance of the ethereum PubSub API.

type Server

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

Server defines a server that handles Ethereum websockets.

func NewServer

func NewServer(clientCtx context.Context, wsAddr string) *Server

NewServer creates a new websocket server instance.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Start

func (s *Server) Start()

Start runs the websocket server

type SubscriptionNotification

type SubscriptionNotification struct {
	Jsonrpc string              `json:"jsonrpc"`
	Method  string              `json:"method"`
	Params  *SubscriptionResult `json:"params"`
}

type SubscriptionResponseJSON

type SubscriptionResponseJSON struct {
	Jsonrpc string      `json:"jsonrpc"`
	Result  interface{} `json:"result"`
	ID      float64     `json:"id"`
}

type SubscriptionResult

type SubscriptionResult struct {
	Subscription rpc.ID      `json:"subscription"`
	Result       interface{} `json:"result"`
}