Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.69 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.69 KB
Raw

NymSocketManager

Go Reference

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.