locators

package

v0.0.0-...-97b9ebb Latest Latest Go to latest Published: Aug 25, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package locators represents node identities, it's hash function representing in Multihash format: https://multiformats.io/multihash/

This section is empty.

This section is empty.

This section is empty.

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

ErrUnsupportedVersion error if binary versio is not supported

func (e *ErrUnsupportedVersion) Error() string

func (e *ErrUnsupportedVersion) Version() []byte

Version which is not supported

type Node struct {
	ID      mh.Multihash
	PubKey  []byte
	PrivKey []byte
}

Node core identities

func FromKeys(pub, priv []byte) (*Node, error)

FromKeys creates new Node struct from public and private keys by generating node id as multihash of SHA1 of public key

func (n *Node) GoString() string

GoString returns debug information for `%#v` format option

func (n *Node) MarshalBinary() ([]byte, error)

MarshalBinary is a binary encoding implementation

func (n *Node) String() string

func (n *Node) UnmarshalBinary(data []byte) error

UnmarshalBinary is a binary decoding implementation

type UnsupportedHashError struct {
	// Name of hash algorithm
	Name string
}

UnsupportedHashError if hashing algorithm specified is not supported

func (e *UnsupportedHashError) Error() string