Module Mina_net2.Multiaddr

A "multiaddr" is libp2p's extensible encoding for network addresses.

They generally look like paths, and are read left-to-right. Each protocol type defines how to decode its address format, and everything leftover is encapsulated inside that protocol.

Some example multiaddrs:

type t
val compare : t -> t -> int
include Core.Bin_prot.Binable.S with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : ( int -> t ) Bin_prot.Read.reader
val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
val to_string : t -> string
val of_string : string -> t
val to_peer : t -> Network_peer.Peer.t option
val of_peer : Network_peer.Peer.t -> t
val valid_as_peer : t -> bool

can a multiaddr plausibly be used as a Peer.t? a syntactic check only; a return value of true does not guarantee that the multiaddress can be used as a peer by libp2p

val of_file_contents : string -> t list