p2p

Documentation

Index

• Constants
• func GetNodeID(privKey crypto.PrivKey) (peer.ID, error)
• func ParseMultiAddrSlice(addrStrings []string) ([]*peer.AddrInfo, error)
• func PeerIDsFromAddrInfos(addrInfos []*peer.AddrInfo) []peer.ID
• func UnmarshalPrivateKey(data []byte) (crypto.PrivKey, error)
• type Node
  • func NewNode(ctx context.Context, options NodeOptions, done chan bool) (*Node, error)
  • func (n Node) Close() error
  • func (n Node) ConnectToPeers(ctx context.Context, peerAddrInfos []*peer.AddrInfo) error
  • func (n Node) GetMultiAddress() ([]ma.Multiaddr, error)
• type NodeOptions

Constants

const (
	PreSharedNetworkKeyLengthBytes = 32
)

Functions

func GetNodeID

func GetNodeID(privKey crypto.PrivKey) (peer.ID, error)

GetNodeID returns the node ID with the given private key.

func ParseMultiAddrSlice

func ParseMultiAddrSlice(addrStrings []string) ([]*peer.AddrInfo, error)

ParseMultiAddrSlice parses a slice of multiaddrs strings into a slice of addr info Requires a valid multiaddr string *and* a valid peer ID.

func PeerIDsFromAddrInfos

func PeerIDsFromAddrInfos(addrInfos []*peer.AddrInfo) []peer.ID

PeerIDsFromAddrInfos returns a slice of peer IDs from the given slice of peer.AddrInfo.

func UnmarshalPrivateKey

func UnmarshalPrivateKey(data []byte) (crypto.PrivKey, error)

UnmarshalPrivateKey unmarshals a private key from bytes

Types

type Node

type Node struct {
	Host     host.Host
	PeerList []peer.ID
	// contains filtered or unexported fields
}

func NewNode

func NewNode(ctx context.Context, options NodeOptions, done chan bool) (*Node, error)

func (Node) Close

func (n Node) Close() error

Close cleans up and stops the node

func (Node) ConnectToPeers

func (n Node) ConnectToPeers(ctx context.Context, peerAddrInfos []*peer.AddrInfo) error

func (Node) GetMultiAddress

func (n Node) GetMultiAddress() ([]ma.Multiaddr, error)

type NodeOptions

type NodeOptions struct {
	Port              uint16
	NetworkPrivateKey pnet.PSK       // Shared secret for private network
	NodePrivateKey    crypto.PrivKey // Private key for current node
	PeerList          []peer.ID      // Allowlist of peers to connect to
	EchoRequiredPeers int
}