pen

package

v0.0.0-...-fa704fd Latest Latest Go to latest Published: Mar 3, 2022 License: BSD-3-Clause Imports: 9 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

Repository

github.com/penguintop/penguin

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pen exposes the data structure and operations necessary on the pen.Address type which used in the handshake protocol, address-book and hive protocol.

Index ¶

Variables
type Address
- func NewAddress(signer crypto.Signer, underlay ma.Multiaddr, overlay penguin.Address, ...) (*Address, error)
- func ParseAddress(underlay, overlay, signature []byte, networkID uint64) (*Address, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrInvalidAddress = errors.New("invalid address")

Functions ¶

This section is empty.

Types ¶

type Address ¶

type Address struct {
	Underlay  ma.Multiaddr
	Overlay   penguin.Address
	Signature []byte
}

Address represents the pen address in penguin. It consists of a peers underlay (physical) address, overlay (topology) address and signature. Signature is used to verify the `Overlay/Underlay` pair, as it is based on `underlay|networkID`, signed with the public key of Overlay address

func NewAddress ¶

func NewAddress(signer crypto.Signer, underlay ma.Multiaddr, overlay penguin.Address, networkID uint64) (*Address, error)

func ParseAddress ¶

func ParseAddress(underlay, overlay, signature []byte, networkID uint64) (*Address, error)

func (*Address) Equal ¶

func (a *Address) Equal(b *Address) bool

func (*Address) MarshalJSON ¶

func (a *Address) MarshalJSON() ([]byte, error)

func (*Address) ShortString ¶

func (a *Address) ShortString() string

ShortString returns shortened versions of pen address in a format: [Overlay, Underlay] It can be used for logging

func (*Address) String ¶

func (a *Address) String() string

func (*Address) UnmarshalJSON ¶

func (a *Address) UnmarshalJSON(b []byte) error

Source Files ¶

View all Source files

address.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL