peer

Documentation

Index

• Constants
• type ConnectionInfo
• type Shorthand
  • func (s Shorthand) GetConnectionInfo() (*ConnectionInfo, error)
  • func (s Shorthand) IsValid() bool

Constants

const ConnectionInfoType = "nimona.io/peer.ConnectionInfo"

const (
	ErrInvalidShorthand = errors.Error("invalid shorthand")
)

Types

type ConnectionInfo

type ConnectionInfo struct {
	Metadata      object.Metadata   `nimona:"@metadata:m,type=nimona.io/peer.ConnectionInfo"`
	Version       int64             `nimona:"version:i"`
	PublicKey     crypto.PublicKey  `nimona:"publicKey:s"`
	Addresses     []string          `nimona:"addresses:as"`
	Relays        []*ConnectionInfo `nimona:"relays:am"`
	ObjectFormats []string          `nimona:"objectFormats:as"`
}

type Shorthand

type Shorthand string

Shorthand has the form of `<public-key>@<address>`. They are mostly used for configuration and bootstrapping.

func (Shorthand) GetConnectionInfo

func (s Shorthand) GetConnectionInfo() (*ConnectionInfo, error)

func (Shorthand) IsValid

func (s Shorthand) IsValid() bool