mafmt

README

multiaddr format

A validation checker for multiaddrs. Some basic validators for common address types are provided, but creating your own combinations is easy.

Usage:

a, _ := ma.NewMultiaddr("/ip4/5.2.67.3/tcp/1708")
TCP.Matches(a) // returns true

Making your own validators is easy, for example, the Reliable multiaddr is defined as follows:

// Define IP as either ipv4 or ipv6
var IP = Or(Base(ma.P_IP4), Base(ma.P_IP6))

// Define TCP as 'tcp' on top of either ipv4 or ipv6
var TCP = And(IP, Base(ma.P_TCP))

// Define UDP as 'udp' on top of either ipv4 or ipv6
var UDP = And(IP, Base(ma.P_UDP))

// Define UTP as 'utp' on top of udp (on top of ipv4 or ipv6)
var UTP = And(UDP, Base(ma.P_UTP))

// Now define a Reliable transport as either tcp or utp
var Reliable = Or(TCP, UTP)

// From here, we can easily define multiaddrs for protocols that can run on top
// of any 'reliable' transport (such as ipfs)

NOTE: the above patterns are already implemented in package

Documentation

Index

• Variables
• type Base
  • func (p Base) Matches(a ma.Multiaddr) bool
  • func (p Base) String() string
• type Pattern
  • func And(ps ...Pattern) Pattern
  • func Or(ps ...Pattern) Pattern

Variables

var IP = Or(Base(ma.P_IP4), Base(ma.P_IP6))

Define IP as either ipv4 or ipv6

var IPFS = And(Reliable, Base(ma.P_IPFS))

IPFS can run over any reliable underlying transport protocol

var QUIC = And(UDP, Base(ma.P_QUIC))

Define QUIC as 'quic' on top of udp (on top of ipv4 or ipv6)

var Reliable = Or(TCP, UTP, QUIC)

Now define a Reliable transport as either tcp or utp or quic

var TCP = And(IP, Base(ma.P_TCP))

Define TCP as 'tcp' on top of either ipv4 or ipv6

var UDP = And(IP, Base(ma.P_UDP))

Define UDP as 'udp' on top of either ipv4 or ipv6

var UTP = And(UDP, Base(ma.P_UTP))

Define UTP as 'utp' on top of udp (on top of ipv4 or ipv6)

var Unreliable = Or(UDP)

Define unreliable transport as udp

Types

type Base

type Base int

func (Base) Matches

func (p Base) Matches(a ma.Multiaddr) bool

func (Base) String

func (p Base) String() string

type Pattern

type Pattern interface {
	Matches(ma.Multiaddr) bool

	String() string
	// contains filtered or unexported methods
}

func And

func And(ps ...Pattern) Pattern

func Or

func Or(ps ...Pattern) Pattern