waku-org
/
go-multiaddr
mirror of https://github.com/waku-org/go-multiaddr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Composable and future-proof network addresses https://github.com/multiformats/multiaddr
124 Commits 1 Branch 0 Tags 1.1 MiB
Go 100%
Go to file
mwnx 7bf24dca81 Fix CodeToVarint []byte size 
We were missing a logarithm... CodeToVarint would previously allocate
more bytes than necessary (exponentially) for the varint slice. This bug
was silent but deserves to be fixed nonetheless.
 		2018-06-16 19:53:08 +02:00
.gx gx publish 1.2.7 2018-06-08 20:23:07 -07:00
.gitignore switched to codecov 2017-02-25 11:25:18 +01:00
.travis.yml Merge pull request #54 from Stebalien/fix/table 2017-07-30 19:56:20 -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 Edit Badges 2016-12-26 15:18:42 -05:00
codec.go add Transocoder functionality 2016-10-14 11:48:19 -04: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 remove debugging code 2017-09-20 18:19:29 -07:00
multiaddr_test.go Add test for Bytes() 2017-10-22 17:18:59 +01:00
package.json gx publish 1.2.7 2018-06-08 20:23:07 -07:00
protocols.go Fix CodeToVarint []byte size 2018-06-16 19:53:08 +02:00
transcoders.go Fix ipv6 parser error message ("ip4" → "ip6") 2018-06-16 19:53:08 +02:00
util.go faster encapsulation + join 2014-11-05 02:30:53 -08:00

README.md

go-multiaddr

Travis CI codecov.io

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.

Table of Contents

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

m.Encapsulate(ma.NewMultiaddr("/sctp/5678"))
// <Multiaddr /ip4/127.0.0.1/udp/1234/sctp/5678>
m.Decapsulate(ma.NewMultiaddr("/udp")) // 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.

License

MIT © 2014 Juan Batiz-Benet