History

RichΛrd 40359f9c1b go-waku integration (#2247 ) * Adding wakunode module * Adding wakuv2 fleet files * Add waku fleets to update-fleet-config script * Adding config items for waku v2 * Conditionally start waku v2 node depending on config * Adapting common code to use go-waku * Setting log level to info * update dependencies * update fleet config to use WakuNodes instead of BootNodes * send and receive messages * use hash returned when publishing a message * add waku store protocol * trigger signal after receiving store messages * exclude linting rule SA1019 to check deprecated packages		2021-06-16 16:19:45 -04:00
..
net	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
.gitignore	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
.travis.yml	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
LICENSE	Add rendezvous implementation for discovery interface	2018-07-25 15:10:57 +03:00
Makefile	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
README.md	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
codec.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
codecov.yml	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
component.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
doc.go	Add rendezvous implementation for discovery interface	2018-07-25 15:10:57 +03:00
filter.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
go.mod	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
go.sum	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
interface.go	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
multiaddr.go	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
package.json	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
protocol.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
protocols.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
transcoders.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04:00
util.go	migrate to go 1.12 and go modules	2019-06-12 13:12:00 +02:00
varint.go	go-waku integration (#2247 )	2021-06-16 16:19:45 -04: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

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.