request

Documentation

Index

• Constants
• func EncodeMoneysocketRequest(msg MoneysocketRequest, toEncode map[string]interface{}) error
• func FromText(payload []byte) (base.MoneysocketMessage, base.MessageType, error)
• type BaseMoneySocketRequest
  • func DecodeRequest(request []byte) (b BaseMoneySocketRequest, err error)
  • func NewBaseMoneySocketRequest(requestType base.MessageType) BaseMoneySocketRequest
  • func (b BaseMoneySocketRequest) MessageClass() base.MessageClass
  • func (b BaseMoneySocketRequest) MessageType() base.MessageType
  • func (b BaseMoneySocketRequest) RequestName() string
  • func (b BaseMoneySocketRequest) UUID() string
• type Invoice
  • func DecodeRequestInvoice(payload []byte) (r Invoice, err error)
  • func NewRequestInvoice(msats int64) Invoice
  • func (r Invoice) ToJSON() ([]byte, error)
• type MoneysocketRequest
• type OpinionInvoice
  • func DecodeRequestOpinionInvoice(payload []byte) (r OpinionInvoice, err error)
  • func NewRequestOpinionInvoice(itemID, requestUUID string) OpinionInvoice
  • func (r OpinionInvoice) ToJSON() ([]byte, error)
• type Pay
  • func DecodeRequestPay(payload []byte) (r Pay, err error)
  • func NewRequestPay(bolt11 string) Pay
  • func (r Pay) ToJSON() ([]byte, error)
• type PingRequest
  • func DecodePing(payload []byte) (PingRequest, error)
  • func NewPingRequest() PingRequest
  • func (p PingRequest) ToJSON() ([]byte, error)
• type Provider
  • func DecodeRequestProvider(payload []byte) (Provider, error)
  • func NewRequestProvider() Provider
  • func (rp Provider) ToJSON() ([]byte, error)
• type Rendezvous
  • func DecodeRendezvousRequest(payload []byte) (r Rendezvous, err error)
  • func NewRendezvousRequest(id string) Rendezvous
  • func (r Rendezvous) MustBeClearText() bool
  • func (r Rendezvous) ToJSON() ([]byte, error)

Constants

const (
	UUIDKey = "request_uuid"
	NameKey = "request_name"
)

Functions

func EncodeMoneysocketRequest

func EncodeMoneysocketRequest(msg MoneysocketRequest, toEncode map[string]interface{}) error

create a moneysocket request

func FromText

func FromText(payload []byte) (base.MoneysocketMessage, base.MessageType, error)

handling it this way is idiotic.

Types

type BaseMoneySocketRequest

type BaseMoneySocketRequest struct {
	base.MoneysocketMessage
	BaseUUID    string
	RequestType base.MessageType
}

func DecodeRequest

func DecodeRequest(request []byte) (b BaseMoneySocketRequest, err error)

func NewBaseMoneySocketRequest

func NewBaseMoneySocketRequest(requestType base.MessageType) BaseMoneySocketRequest

generate a new base moneysocket request. Should only be used by other message classes

func (BaseMoneySocketRequest) MessageClass

func (b BaseMoneySocketRequest) MessageClass() base.MessageClass

func (BaseMoneySocketRequest) MessageType

func (b BaseMoneySocketRequest) MessageType() base.MessageType

get the message type

func (BaseMoneySocketRequest) RequestName

func (b BaseMoneySocketRequest) RequestName() string

func (BaseMoneySocketRequest) UUID

func (b BaseMoneySocketRequest) UUID() string

type Invoice

type Invoice struct {
	BaseMoneySocketRequest
	Msats int64
}

func DecodeRequestInvoice

func DecodeRequestInvoice(payload []byte) (r Invoice, err error)

turn a byte slice into a request invoice, return an error if not possible

func NewRequestInvoice

func NewRequestInvoice(msats int64) Invoice

func (Invoice) ToJSON

func (r Invoice) ToJSON() ([]byte, error)

type MoneysocketRequest

type MoneysocketRequest interface {
	base.MoneysocketMessage
	UUID() string
	RequestName() string
	MessageType() base.MessageType
}

type OpinionInvoice

type OpinionInvoice struct {
	BaseMoneySocketRequest
	ItemID string
}

func DecodeRequestOpinionInvoice

func DecodeRequestOpinionInvoice(payload []byte) (r OpinionInvoice, err error)

func NewRequestOpinionInvoice

func NewRequestOpinionInvoice(itemID, requestUUID string) OpinionInvoice

func (OpinionInvoice) ToJSON

func (r OpinionInvoice) ToJSON() ([]byte, error)

type Pay

type Pay struct {
	BaseMoneySocketRequest
	Bolt11 string
}

func DecodeRequestPay

func DecodeRequestPay(payload []byte) (r Pay, err error)

func NewRequestPay

func NewRequestPay(bolt11 string) Pay

create a new request pay with a given bolt 11 bolt 11 is not validated client (moneysocket) side

func (Pay) ToJSON

func (r Pay) ToJSON() ([]byte, error)

type PingRequest

type PingRequest struct {
	BaseMoneySocketRequest
}

func DecodePing

func DecodePing(payload []byte) (PingRequest, error)

func NewPingRequest

func NewPingRequest() PingRequest

func (PingRequest) ToJSON

func (p PingRequest) ToJSON() ([]byte, error)

type Provider

type Provider struct {
	BaseMoneySocketRequest
}

func DecodeRequestProvider

func DecodeRequestProvider(payload []byte) (Provider, error)

decode a request provider from json

func NewRequestProvider

func NewRequestProvider() Provider

func (Provider) ToJSON

func (rp Provider) ToJSON() ([]byte, error)

encode a request provider to json

type Rendezvous

type Rendezvous struct {
	BaseMoneySocketRequest
	// the id of the rendezvous we're requesting (normally derived  from the shared seed)
	RendezvousID string
}

func DecodeRendezvousRequest

func DecodeRendezvousRequest(payload []byte) (r Rendezvous, err error)

func NewRendezvousRequest

func NewRendezvousRequest(id string) Rendezvous

request the server start a rendezvous w/ a given rendezvous id

func (Rendezvous) MustBeClearText

func (r Rendezvous) MustBeClearText() bool

func (Rendezvous) ToJSON

func (r Rendezvous) ToJSON() ([]byte, error)