nut17

Documentation

Index

• Constants
• type ErrorResponse
• type InfoSetting
• type NotificationParams
• type RequestParams
• type Result
• type SubscriptionKind
  • func StringToKind(kind string) SubscriptionKind
  • func (kind SubscriptionKind) String() string
• type SupportedMethod
• type WsError
  • func NewWsError(code int, message string, id int) WsError
  • func (e WsError) Error() string
  • func (e *WsError) UnmarshalJSON(data []byte) error
• type WsNotification
  • func (n *WsNotification) UnmarshalJSON(data []byte) error
• type WsRequest
• type WsResponse
  • func (r *WsResponse) UnmarshalJSON(data []byte) error

Constants

const (
	JSONRPC_2   = "2.0"
	OK          = "OK"
	SUBSCRIBE   = "subscribe"
	UNSUBSCRIBE = "unsubscribe"
)

Types

type ErrorResponse

type ErrorResponse struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type InfoSetting

type InfoSetting struct {
	Supported []SupportedMethod `json:"supported"`
}

type NotificationParams

type NotificationParams struct {
	SubId   string          `json:"subId"`
	Payload json.RawMessage `json:"payload"`
}

type RequestParams

type RequestParams struct {
	Kind    string   `json:"kind"`
	SubId   string   `json:"subId"`
	Filters []string `json:"filters"`
}

type Result

type Result struct {
	Status string `json:"status"`
	SubId  string `json:"subId"`
}

type SubscriptionKind

type SubscriptionKind int

const (
	Bolt11MintQuote SubscriptionKind = iota
	Bolt11MeltQuote
	ProofState
	Unknown
)

func StringToKind

func StringToKind(kind string) SubscriptionKind

func (SubscriptionKind) String

func (kind SubscriptionKind) String() string

type SupportedMethod

type SupportedMethod struct {
	Method   string   `json:"method"`
	Unit     string   `json:"unit"`
	Commands []string `json:"commands"`
}

type WsError

type WsError struct {
	JsonRPC     string        `json:"jsonrpc"`
	ErrResponse ErrorResponse `json:"error"`
	Id          int           `json:"id"`
}

func NewWsError

func NewWsError(code int, message string, id int) WsError

func (WsError) Error

func (e WsError) Error() string

func (*WsError) UnmarshalJSON

func (e *WsError) UnmarshalJSON(data []byte) error

type WsNotification

type WsNotification struct {
	JsonRPC string             `json:"jsonrpc"`
	Method  string             `json:"method"`
	Params  NotificationParams `json:"params"`
}

func (*WsNotification) UnmarshalJSON

func (n *WsNotification) UnmarshalJSON(data []byte) error

type WsRequest

type WsRequest struct {
	JsonRPC string        `json:"jsonrpc"`
	Method  string        `json:"method"`
	Params  RequestParams `json:"params"`
	Id      int           `json:"id"`
}

type WsResponse

type WsResponse struct {
	JsonRPC string `json:"jsonrpc"`
	Result  Result `json:"result"`
	Id      int    `json:"id"`
}

func (*WsResponse) UnmarshalJSON

func (r *WsResponse) UnmarshalJSON(data []byte) error