Categorygithub.com/nymo-net/nymo
modulepackage
0.0.1
Repository: https://github.com/nymo-net/nymo.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
38
Dependents
0
Files
1.7k SLOC

# README

Nymo Network Core

Go Reference

This repository contains a vanilla implementation of the open-standard Nymo network protocol in Go as a library.

A simple UPnP-IGD port-forwarding functionality is also implemented for the convenience of the user.

Implementation

To use this Nymo core library, implement Database and related interfaces. Read documentation for more information on how to use this library.

License

All files under this repository are marked with BSD Zero Clause License.

# Packages

No description provided by the author

# Functions

ConvertAddrToStr returns the string version of an encoded Nymo user address.
DefaultConfig returns a copy of default config for itemized modification.
GenerateUser generates a new Nymo user.
NewAddress converts the string version of an address into the internal representation.
NewAddressFromBytes converts the encoded address into the internal representation.
OpenSupernode opens a supernode (a relay node).
OpenUser opens a user generated by GenerateUser, where the userKey argument should be exactly what GenerateUser returned.
Version returns the current version of Nymo core.

# Structs

Address represents the address of a Nymo user.
Config statically configures several parameters of Nymo core.
Message contains a decrypted message (sent to the user).
No description provided by the author

# Interfaces

Database needs to be implemented by any frontend for user/database related actions.
PeerEnumerate is a helper object for Nymo core to iterate through known peer URLs.
PeerHandle is a helper object for Nymo core to handle a peer connection.