https://github.com/notrustverify/nymsocketmanager
https://github.com/notrustverify/nymsocketmanager
golang nym privacy sdk
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/notrustverify/nymsocketmanager
- Owner: notrustverify
- License: gpl-3.0
- Created: 2023-05-16T07:31:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-07T16:41:22.000Z (almost 2 years ago)
- Last Synced: 2024-11-19T07:38:33.514Z (6 months ago)
- Topics: golang, nym, privacy, sdk
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
- awesome-nym - NymSocketManager - a golang module to facilitate the communication with the Mixnet  (🔨Tools)
README
# NymSocketManager
[](https://pkg.go.dev/notrustverify/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](https://nymtech.net/download-nym-components/) or built according the instructions [here](https://nymtech.net/docs/binaries/building-nym.html). Instructions for initiating and running a nym-client can be found [here](https://nymtech.net/docs/clients/websocket-client.html).
## Installation
NymSocketManager is available using the standard `go get` command.
Install it by running:
```bash
go get -u github.com/notrustverify/nymsocketmanager
```
## Usage
The module can be imported as following:
```go
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](https://github.com/notrustverify/nymsocketmanager) folder.
You can also check our Nostr-Nym proxy in Go: [NostrNym](https://github.com/notrustverify/nostr-nym).
## Future improvements
The following could be improved regarding this module:
* Improve type documentation
* Write more tests
* Use the [WS library](https://pkg.go.dev/github.com/gobwas/ws) for websocket connections. This module currently uses the [Gorilla Websocket library](https://pkg.go.dev/github.com/gorilla/websocket), which is unmaintained at the current time of writing (05.2023).
## License
This code is released under the GPLv3+ license.