nymsocketmanager

README

NymSocketManager

This Go module handles the connection to the Nym Mixnet let you focus on the rest of your application.

Note that this module needs a running nym-client to connect to the mixnet! It can be downloaded here or built according the instructions here. Instructions for initiating and running a nym-client can be found here.

Installation

NymSocketManager is available using the standard go get command.

Install it by running:

go get -u github.com/notrustverify/nymsocketmanager

Usage

The module can be imported as following:

import NymSocketManager "github.com/notrustverify/nymsocketmanager"

You can thenow instantiate the NymSocketManager or the SocketManager.

Example

Examples on how to use both NymSocketManager and SocketManager can be found in the examples folder.
You can also check our Nostr-Nym proxy in Go: NostrNym.

Future improvements

The following could be improved regarding this module:

• Improve type documentation
• Write more tests
• Use the WS library for websocket connections. This module currently uses the Gorilla Websocket library, which is unmaintained at the current time of writing (05.2023).

License

This code is released under the GPLv3+ license.

Documentation

Index

• Constants
• type NymError
  • func (NymError) Name() string
  • func (NymError) NewEmpty() NymMessage
  • func (n NymError) String() string
• type NymMessage
  • func NewNymReceived(message string, senderTag string) NymMessage
  • func NewNymReply(senderTag string, message string) NymMessage
  • func NewNymSend(message string, recipient string) NymMessage
  • func NewNymSendAnonymous(message string, recipient string, nbReplySurbs uint) NymMessage
  • func NewSelfAddressReply(address string) NymMessage
  • func NewSelfAddressRequest() NymMessage
• type NymMessageCommon
• type NymReceived
  • func (NymReceived) Name() string
  • func (NymReceived) NewEmpty() NymMessage
  • func (n NymReceived) String() string
• type NymReply
  • func (NymReply) Name() string
  • func (n NymReply) NewEmpty() NymMessage
  • func (n NymReply) String() string
• type NymSelfAddressReply
  • func (NymSelfAddressReply) Name() string
  • func (s NymSelfAddressReply) NewEmpty() NymMessage
  • func (n NymSelfAddressReply) String() string
• type NymSelfAddressRequest
  • func (NymSelfAddressRequest) Name() string
  • func (NymSelfAddressRequest) NewEmpty() NymMessage
  • func (NymSelfAddressRequest) String() string
• type NymSend
  • func (NymSend) Name() string
  • func (NymSend) NewEmpty() NymMessage
  • func (n NymSend) String() string
• type NymSendAnonymous
  • func (NymSendAnonymous) Name() string
  • func (NymSendAnonymous) NewEmpty() NymMessage
  • func (n NymSendAnonymous) String() string
• type NymSocketManager
  • func NewNymSocketManager(connectionURI string, messageHandler func(NymReceived, func(NymMessage) error), ...) (*NymSocketManager, error)
  • func (n *NymSocketManager) GetConnectedGateway() string
  • func (n *NymSocketManager) GetNymClientId() string
  • func (n *NymSocketManager) IsRunning() bool
  • func (n *NymSocketManager) Send(msg NymMessage) error
  • func (n *NymSocketManager) Start() (chan struct{}, error)
  • func (n *NymSocketManager) Stop()
• type SocketListener
  • func NewSocketListener(socket *websocket.Conn, messageHandler func([]byte), toCallWhenClosed func(), ...) (*SocketListener, chan struct{}, error)
  • func (s *SocketListener) Listen()
• type SocketManager
  • func NewSocketManager(connectionURI string, messageHandler func([]byte, func([]byte) error), ...) (*SocketManager, error)
  • func (s *SocketManager) IsRunning() bool
  • func (s *SocketManager) Send(message []byte) error
  • func (s *SocketManager) Start() (chan struct{}, error)
  • func (s *SocketManager) Stop()

Constants

const ComponentField = "component"

const NymErrorType = "error"

const NymReceivedType = "received"

const NymReplyType = "reply"

const NymSelfAddressReplyType = "selfAddress"

const NymSelfAddressType = "selfAddress"

const NymSendAnonymousType = "sendAnonymous"

const NymSendType = "send"

Types

type NymError

type NymError struct {
	NymMessageCommon

	Message string `json:"message"`
}

func (NymError) Name

func (NymError) Name() string

func (NymError) NewEmpty

func (NymError) NewEmpty() NymMessage

func (NymError) String

func (n NymError) String() string

type NymMessage

type NymMessage interface {
	NewEmpty() NymMessage
	Name() string // Type of message
	String() string
}

Message defines the type of message that can be exchanged

func NewNymReceived

func NewNymReceived(message string, senderTag string) NymMessage

func NewNymReply

func NewNymReply(senderTag string, message string) NymMessage

func NewNymSend

func NewNymSend(message string, recipient string) NymMessage

func NewNymSendAnonymous

func NewNymSendAnonymous(message string, recipient string, nbReplySurbs uint) NymMessage

func NewSelfAddressReply

func NewSelfAddressReply(address string) NymMessage

func NewSelfAddressRequest

func NewSelfAddressRequest() NymMessage

type NymMessageCommon

type NymMessageCommon struct {
	Type string `json:"type"`
}

type NymReceived

type NymReceived struct {
	NymMessageCommon

	Message   string `json:"message"`
	SenderTag string `json:"senderTag"`
}

func (NymReceived) Name

func (NymReceived) Name() string

func (NymReceived) NewEmpty

func (NymReceived) NewEmpty() NymMessage

func (NymReceived) String

func (n NymReceived) String() string

type NymReply

type NymReply struct {
	NymMessageCommon

	Message   string `json:"message"`
	SenderTag string `json:"senderTag"`
}

func (NymReply) Name

func (NymReply) Name() string

func (NymReply) NewEmpty

func (n NymReply) NewEmpty() NymMessage

func (NymReply) String

func (n NymReply) String() string

type NymSelfAddressReply

type NymSelfAddressReply struct {
	NymMessageCommon

	Address string `json:"address"`
}

func (NymSelfAddressReply) Name

func (NymSelfAddressReply) Name() string

func (NymSelfAddressReply) NewEmpty

func (s NymSelfAddressReply) NewEmpty() NymMessage

func (NymSelfAddressReply) String

func (n NymSelfAddressReply) String() string

type NymSelfAddressRequest

type NymSelfAddressRequest struct {
	NymMessageCommon
}

func (NymSelfAddressRequest) Name

func (NymSelfAddressRequest) Name() string

func (NymSelfAddressRequest) NewEmpty

func (NymSelfAddressRequest) NewEmpty() NymMessage

func (NymSelfAddressRequest) String

func (NymSelfAddressRequest) String() string

type NymSend

type NymSend struct {
	NymMessageCommon

	Message   string `json:"message"`
	Recipient string `json:"recipient"`
}

func (NymSend) Name

func (NymSend) Name() string

func (NymSend) NewEmpty

func (NymSend) NewEmpty() NymMessage

func (NymSend) String

func (n NymSend) String() string

type NymSendAnonymous

type NymSendAnonymous struct {
	NymMessageCommon

	Message    string `json:"message"`
	Recipient  string `json:"recipient"`
	ReplySurbs uint   `json:"replySurbs"`
}

func (NymSendAnonymous) Name

func (NymSendAnonymous) Name() string

func (NymSendAnonymous) NewEmpty

func (NymSendAnonymous) NewEmpty() NymMessage

func (NymSendAnonymous) String

func (n NymSendAnonymous) String() string

type NymSocketManager

type NymSocketManager struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewNymSocketManager

func NewNymSocketManager(connectionURI string, messageHandler func(NymReceived, func(NymMessage) error), parentLogger *zerolog.Logger) (*NymSocketManager, error)

func (*NymSocketManager) GetConnectedGateway

func (n *NymSocketManager) GetConnectedGateway() string

func (*NymSocketManager) GetNymClientId

func (n *NymSocketManager) GetNymClientId() string

func (*NymSocketManager) IsRunning

func (n *NymSocketManager) IsRunning() bool

func (*NymSocketManager) Send

func (n *NymSocketManager) Send(msg NymMessage) error

Send a message to the underlying connection

func (*NymSocketManager) Start

func (n *NymSocketManager) Start() (chan struct{}, error)

func (*NymSocketManager) Stop

func (n *NymSocketManager) Stop()

type SocketListener

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

func NewSocketListener

func NewSocketListener(socket *websocket.Conn, messageHandler func([]byte), toCallWhenClosed func(), parentLogger *zerolog.Logger) (*SocketListener, chan struct{}, error)

func (*SocketListener) Listen

func (s *SocketListener) Listen()

type SocketManager

type SocketManager struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewSocketManager

func NewSocketManager(connectionURI string, messageHandler func([]byte, func([]byte) error), parentLogger *zerolog.Logger) (*SocketManager, error)

func (*SocketManager) IsRunning

func (s *SocketManager) IsRunning() bool

func (*SocketManager) Send

func (s *SocketManager) Send(message []byte) error

func (*SocketManager) Start

func (s *SocketManager) Start() (chan struct{}, error)

func (*SocketManager) Stop

func (s *SocketManager) Stop()