feat: allow /ipfs to come as part of multiaddrs

multiformats · Aug 29, 2017 · 3f192ba · 3f192ba
1 parent 8a05396
commit 3f192ba
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 14 deletions.
diff --git a/src/index.js b/src/index.js
@@ -14,34 +14,64 @@ const _DNS = or(
 )
 
 const IP = or(base('ip4'), base('ip6'))
-const TCP = and(IP, base('tcp'))
-const UDP = and(IP, base('udp'))
-const UTP = and(UDP, base('utp'))
 
-const DNS = or(
+const _UDP = and(IP, base('udp'))
+const UDP = or(
+ and(_UDP, base('ipfs')),
+ _UDP
+)
+
+const _UTP = and(UDP, base('utp'))
+const UTP = or(
+ and(_UTP, base('ipfs')),
+ _UTP
+)
+
+const _TCP = and(IP, base('tcp'))
+const TCP = or(
+ and(_TCP, base('ipfs')),
+ _TCP
+)
+
+const __DNS = or(
  and(_DNS, base('tcp')),
  _DNS
 )
 
-const WebSockets = or(
+const DNS = or(
+ and(__DNS, base('ipfs')),
+ __DNS
+)
+
+const _WebSockets = or(
  and(TCP, base('ws')),
  and(DNS, base('ws'))
 )
 
-const WebSocketsSecure = or(
+const WebSockets = or(
+ and(_WebSockets, base('ipfs')),
+ _WebSockets
+)
+
+const _WebSocketsSecure = or(
  and(TCP, base('wss')),
  and(DNS, base('wss'))
 )
 
+const WebSocketsSecure = or(
+ and(_WebSocketsSecure, base('ipfs')),
+ _WebSocketsSecure
+)
+
 const HTTP = or(
  and(TCP, base('http')),
  and(DNS),
  and(DNS, base('http'))
 )
 
 const WebRTCStar = or(
- and(base('libp2p-webrtc-star'), WebSockets, base('ipfs')),
- and(base('libp2p-webrtc-star'), WebSocketsSecure, base('ipfs'))
+ and(base('libp2p-webrtc-star'), _WebSockets, base('ipfs')),
+ and(base('libp2p-webrtc-star'), _WebSocketsSecure, base('ipfs'))
 )
 
 const WebRTCDirect = and(base('libp2p-webrtc-direct'), HTTP)
@@ -57,7 +87,7 @@ const Reliable = or(
 )
 
 let _IPFS = or(
- and(Reliable, base('ipfs')),
+ Reliable,
  WebRTCStar,
  base('ipfs')
 )

diff --git a/test/index.spec.js b/test/index.spec.js
@@ -20,6 +20,20 @@ describe('multiaddr validation', function () {
  '/ip4/127.0.0.1'
  ]
 
+ const goodDnsIPFS = [
+ '/dns/ipfs.io/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns4/ipfs.io/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns4/libp2p.io/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns6/protocol.ai/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns4/protocol.ai/tcp/80/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns6/protocol.ai/tcp/80/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/dns/protocol.ai/tcp/80/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
+ ]
+
+ const badDnsIPFS = [
+ '/ip4/127.0.0.1/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
+ ]
+
  const goodIP = [
  '/ip4/0.0.0.0',
  '/ip6/fc00::'
@@ -32,7 +46,9 @@ describe('multiaddr validation', function () {
 
  const goodTCP = [
  '/ip4/0.0.7.6/tcp/1234',
- '/ip6/::/tcp/0'
+ '/ip6/::/tcp/0',
+ '/ip4/0.0.7.6/tcp/1234/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip6/::/tcp/0/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
  ]
 
  const badTCP = [
@@ -42,7 +58,9 @@ describe('multiaddr validation', function () {
 
  const goodUDP = [
  '/ip4/0.0.7.6/udp/1234',
- '/ip6/::/udp/0'
+ '/ip6/::/udp/0',
+ '/ip4/0.0.7.6/udp/1234/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip6/::/udp/0/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
  ]
 
  const badUDP = [
@@ -52,7 +70,9 @@ describe('multiaddr validation', function () {
 
  const goodUTP = [
  '/ip4/1.2.3.4/udp/3456/utp',
- '/ip6/::/udp/0/utp'
+ '/ip6/::/udp/0/utp',
+ '/ip4/1.2.3.4/udp/3456/utp/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip6/::/udp/0/utp/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
  ]
 
  const badUTP = [
@@ -63,13 +83,19 @@ describe('multiaddr validation', function () {
  const goodWS = [
  '/dns/ipfs.io/ws',
  '/ip4/1.2.3.4/tcp/3456/ws',
- '/ip6/::/tcp/0/ws'
+ '/ip6/::/tcp/0/ws',
+ '/dns/ipfs.io/ws/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip4/1.2.3.4/tcp/3456/ws/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip6/::/tcp/0/ws/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
  ]
 
  const goodWSS = [
  '/dns/ipfs.io/wss',
  '/ip4/1.2.3.4/tcp/3456/wss',
- '/ip6/::/tcp/0/wss'
+ '/ip6/::/tcp/0/wss',
+ '/dns/ipfs.io/wss/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip4/1.2.3.4/tcp/3456/wss/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4',
+ '/ip6/::/tcp/0/wss/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4'
  ]
 
  const goodWebRTCStar = [
@@ -147,6 +173,11 @@ describe('multiaddr validation', function () {
  assertMismatches(mafmt.DNS, badDNS, badIP, goodTCP)
  })
 
+ it('DNS IPFS validation', function () {
+ assertMatches(mafmt.DNS, goodDnsIPFS)
+ assertMismatches(mafmt.DNS, badDnsIPFS, badDNS, badIP, goodTCP)
+ })
+
  it('IP validation', function () {
  assertMatches(mafmt.IP, goodIP)
  assertMismatches(mafmt.IP, badIP, goodTCP)