Composable and future-proof network addresses https://github.com/multiformats/multiaddr

Go to file

Overbool c7b4679a01 docs(README): modify readme		2018-09-14 22:13:38 +08:00
.gx	gx publish 1.3.0	2018-06-22 14:36:39 -07:00
.gitignore	switched to codecov	2017-02-25 11:25:18 +01:00
.travis.yml	bump minimum go version to 1.10	2018-06-16 13:35:24 -07:00
LICENSE	MIT license	2014-09-28 15:21:18 -07:00
Makefile	switched to codecov	2017-02-25 11:25:18 +01:00
README.md	docs(README): modify readme	2018-09-14 22:13:38 +08:00
codec.go	remove redundant case	2018-06-22 18:32:03 -07:00
doc.go	Changed jbenet to multiformats	2016-10-20 20:48:40 -04:00
interface.go	Changed jbenet to multiformats	2016-10-20 20:48:40 -04:00
multiaddr.go	simplify variable-length argument handling	2018-06-22 13:29:31 -07:00
multiaddr_test.go	add test case for panic	2018-06-22 13:29:31 -07:00
package.json	gx publish 1.3.0	2018-06-22 14:36:39 -07:00
protocol.go	refactor the protocol definition files	2018-07-18 09:09:29 -07:00
protocols.go	refactor the protocol definition files	2018-07-18 09:09:29 -07:00
transcoders.go	fully validate p2p addresses when decoding from bytes	2018-06-22 13:29:31 -07:00
util.go	faster encapsulation + join	2014-11-05 02:30:53 -08:00
varint.go	refactor the protocol definition files	2018-07-18 09:09:29 -07:00

README.md

go-multiaddr

multiaddr implementation in go

Multiaddr is a standard way to represent addresses that:

Support any standard network protocols.
Self-describe (include protocols).
Have a binary packed format.
Have a nice string representation.
Encapsulate well.

Install
Usage
- Example
Maintainers
Contribute
License

Install

go get github.com/multiformats/go-multiaddr

Usage

Example

Simple

import ma "github.com/multiformats/go-multiaddr"

// construct from a string (err signals parse failure)
m1, err := ma.NewMultiaddr("/ip4/127.0.0.1/udp/1234")

// construct from bytes (err signals parse failure)
m2, err := ma.NewMultiaddrBytes(m1.Bytes())

// true
strings.Equal(m1.String(), "/ip4/127.0.0.1/udp/1234")
strings.Equal(m1.String(), m2.String())
bytes.Equal(m1.Bytes(), m2.Bytes())
m1.Equal(m2)
m2.Equal(m1)

Protocols

// get the multiaddr protocol description objects
m1.Protocols()
// []Protocol{
//   Protocol{ Code: 4, Name: 'ip4', Size: 32},
//   Protocol{ Code: 17, Name: 'udp', Size: 16},
// }

En/decapsulate

import ma "github.com/multiformats/go-multiaddr"

m, err := ma.NewMultiaddr("/ip4/127.0.0.1/udp/1234")
// <Multiaddr /ip4/127.0.0.1/udp/1234>

sctpMA, err := ma.NewMultiaddr("/sctp/5678")

m.Encapsulate(sctpMA)
// <Multiaddr /ip4/127.0.0.1/udp/1234/sctp/5678>

udpMA, err := ma.NewMultiaddr("/udp/1234")

m.Decapsulate(udpMA) // up to + inc last occurrence of subaddr
// <Multiaddr /ip4/127.0.0.1>

Tunneling

Multiaddr allows expressing tunnels very nicely.

printer, _ := ma.NewMultiaddr("/ip4/192.168.0.13/tcp/80")
proxy, _ := ma.NewMultiaddr("/ip4/10.20.30.40/tcp/443")
printerOverProxy := proxy.Encapsulate(printer)
// /ip4/10.20.30.40/tcp/443/ip4/192.168.0.13/tcp/80

proxyAgain := printerOverProxy.Decapsulate(printer)
// /ip4/10.20.30.40/tcp/443

Maintainers

Captain: @whyrusleeping.

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.