libp2p

type AnnounceOptions struct {
	// Rendezvous is the pre-shared key to use as a rendezvous point for the DHT.
	Rendezvous string
	// AnnounceTTL is the TTL to use for the discovery service.
	AnnounceTTL time.Duration
	// HostOptions are options for configuring the host. These can be left
	// empty if using a pre-created host.
	HostOptions HostOptions
	// Method is the method to announce.
	Method string
	// Host is a pre-started host to use for announcing.
	Host host.Host
}

type Announcer interface {
	// AnnounceToDHT should announce the join protocol to the DHT,
	// such that it can be used by a libp2p transport.JoinRoundTripper.
	AnnounceToDHT(ctx context.Context, opts AnnounceOptions) error
	// LeaveDHT should remove the join protocol from the DHT for the
	// given rendezvous string.
	LeaveDHT(ctx context.Context, rendezvous string) error
}

type DiscoveryHost interface {
	Host

	// DHT is the underlying libp2p DHT.
	DHT() *dht.IpfsDHT
	// Announce announces the host to the DHT for the given rendezvous string.
	Announce(ctx context.Context, rendezvous string, ttl time.Duration)
}

type Host interface {
	// ID returns the peer ID of the host as a raw string.
	ID() string
	// Host is the underlying libp2p host.
	Host() host.Host
	// AddAddrs adds the given addresses to the host's peerstore.
	AddAddrs(addrs []multiaddr.Multiaddr, id peer.ID, ttl time.Duration) error
	// SignAddrs creates an envelope for this host's peer ID and addresses.
	SignAddrs(seq uint64) (*record.Envelope, error)
	// ConsumePeerRecord consumes a peer record and adds it to the peerstore.
	ConsumePeerRecord(rec *record.Envelope, ttl time.Duration) error
	// RPCListener creates and returns a new net.Listener listening for RPC connections.
	// This should only ever be called once per host. The host will be closed when the
	// listener is closed.
	RPCListener() net.Listener
	// Close closes the host and its DHT.
	Close() error
}

type HostOptions struct {
	// Key is the key to use for identification. If left empty, an ephemeral
	// key is generated.
	Key crypto.PrivateKey
	// BootstrapPeers is a list of bootstrap peers to use for the DHT when
	// creating a discovery host. If empty or nil, the default bootstrap
	// peers will be used.
	BootstrapPeers []multiaddr.Multiaddr
	// Options are options for configuring the libp2p host.
	Options []config.Option
	// LocalAddrs is a list of local addresses to announce the host with.
	// If empty or nil, the default local addresses will be used.
	LocalAddrs []multiaddr.Multiaddr
	// ConnectTimeout is the timeout for connecting to peers when bootstrapping.
	ConnectTimeout time.Duration
	// UncertifiedPeerstore uses an uncertified peerstore for the host.
	// This is useful for testing or when using the host to dial pre-trusted
	// peers.
	UncertifiedPeerstore bool
	// NoFallbackDefaults disables the use of fallback defaults when creating
	// the host. This is useful for testing.
	NoFallbackDefaults bool
}

type RoundTripOptions struct {
	// Multiaddrs are the multiaddrs to dial. These are mutually exclusive with
	// Rendezvous.
	Multiaddrs []multiaddr.Multiaddr
	// Rendezvous is a rendezvous point on the DHT.
	Rendezvous string
	// HostOptions are options for configuring the host. These can be left
	// empty if using a pre-created host.
	HostOptions HostOptions
	// Method is the method to try to execute.
	Method string
	// Host is a pre-started host to use for the round trip
	Host Host
	// Credentials are gRPC DialOptions to use for the gRPC connection.
	Credentials []grpc.DialOption
}

type TransportOptions struct {
	// Rendezvous is the pre-shared string to use as a rendezvous point for the DHT.
	Rendezvous string
	// HostOptions are options for configuring the host. These can be left
	// empty if using a pre-created host.
	HostOptions HostOptions
	// Host is a pre-started host to use for the transport.
	Host Host
	// Credentials are the credentials to use for the transport.
	Credentials []grpc.DialOption
}

type UDPRelay struct {
	UDPRelayOptions
	// contains filtered or unexported fields
}

type UDPRelayOptions struct {
	// PrivateKey is the private key to use for the host.
	// This is required.
	PrivateKey crypto.PrivateKey
	// RemotePubKey is the public key of the remote node to negotiate a UDP relay with.
	RemotePubKey crypto.PublicKey
	// Relay are options for the relay
	Relay relay.UDPOptions
	// Host are options for configuring the host
	Host HostOptions
}

type UncertifiedPeerstore struct {
	peerstore.Peerstore
}