autorelay

Documentation

Index

• Variables
• func Filter(addrs []ma.Multiaddr) []ma.Multiaddr
• type AutoRelay
  • func NewAutoRelay(bhost *basic.BasicHost, opts ...Option) (*AutoRelay, error)
  • func (r *AutoRelay) Close() error
• type AutoRelayHost
  • func NewAutoRelayHost(h host.Host, ar *AutoRelay) *AutoRelayHost
  • func (h *AutoRelayHost) Close() error
• type Option
  • func WithBackoff(d time.Duration) Option
  • func WithBootDelay(d time.Duration) Option
  • func WithCircuitV1Support() Option
  • func WithDefaultStaticRelays() Option
  • func WithMaxAttempts(n int) Option
  • func WithMaxCandidates(n int) Option
  • func WithMinCandidates(n int) Option
  • func WithNumRelays(n int) Option
  • func WithPeerSource(peerChan <-chan peer.AddrInfo) Option
  • func WithStaticRelays(static []peer.AddrInfo) Option

Variables

var DefaultRelays = []string{
	"/ip4/147.75.80.110/tcp/4001/p2p/QmbFgm5zan8P6eWWmeyfncR5feYEMPbht5b1FW1C37aQ7y",
	"/ip4/147.75.80.110/udp/4001/quic/p2p/QmbFgm5zan8P6eWWmeyfncR5feYEMPbht5b1FW1C37aQ7y",
	"/ip4/147.75.195.153/tcp/4001/p2p/QmW9m57aiBDHAkKj9nmFSEn7ZqrcF1fZS4bipsTCHburei",
	"/ip4/147.75.195.153/udp/4001/quic/p2p/QmW9m57aiBDHAkKj9nmFSEn7ZqrcF1fZS4bipsTCHburei",
	"/ip4/147.75.70.221/tcp/4001/p2p/Qme8g49gm3q4Acp7xWBKg3nAa9fxZ1YmyDJdyGgoG6LsXh",
	"/ip4/147.75.70.221/udp/4001/quic/p2p/Qme8g49gm3q4Acp7xWBKg3nAa9fxZ1YmyDJdyGgoG6LsXh",
}

DefaultRelays are the known PL-operated v1 relays; will be decommissioned in 2022.

Functions

func Filter

func Filter(addrs []ma.Multiaddr) []ma.Multiaddr

Filter filters out all relay addresses.

Types

type AutoRelay

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

func NewAutoRelay

func NewAutoRelay(bhost *basic.BasicHost, opts ...Option) (*AutoRelay, error)

func (*AutoRelay) Close

func (r *AutoRelay) Close() error

type AutoRelayHost

type AutoRelayHost struct {
	host.Host
	// contains filtered or unexported fields
}

func NewAutoRelayHost

func NewAutoRelayHost(h host.Host, ar *AutoRelay) *AutoRelayHost

func (*AutoRelayHost) Close

func (h *AutoRelayHost) Close() error

type Option

type Option func(*config) error

func WithBackoff

func WithBackoff(d time.Duration) Option

WithBackoff sets the time we wait after failing to obtain a reservation with a candidate.

func WithBootDelay

func WithBootDelay(d time.Duration) Option

WithBootDelay set the boot delay for finding relays. We won't attempt any reservation if we've have less than a minimum number of candidates. This prevents us to connect to the "first best" relay, and allows us to carefully select the relay. However, in case we haven't found enough relays after the boot delay, we use what we have.

func WithCircuitV1Support

func WithCircuitV1Support() Option

WithCircuitV1Support enables support for circuit v1 relays.

func WithDefaultStaticRelays

func WithDefaultStaticRelays() Option

func WithMaxAttempts

func WithMaxAttempts(n int) Option

WithMaxAttempts sets the number of times we attempt to obtain a reservation with a candidate. If we still fail to obtain a reservation, this candidate is dropped.

func WithMaxCandidates

func WithMaxCandidates(n int) Option

WithMaxCandidates sets the number of relay candidates that we buffer.

func WithMinCandidates

func WithMinCandidates(n int) Option

WithMinCandidates sets the minimum number of relay candidates we collect before to get a reservation with any of them (unless we've been running for longer than the boot delay). This is to make sure that we don't just randomly connect to the first candidate that we discover.

func WithNumRelays

func WithNumRelays(n int) Option

WithNumRelays sets the number of relays we strive to obtain reservations with.

func WithPeerSource

func WithPeerSource(peerChan <-chan peer.AddrInfo) Option

func WithStaticRelays

func WithStaticRelays(static []peer.AddrInfo) Option