feat: add matcher for /p2p/Qmfoo addresses (#46)

Allows matching multiaddrs that just contain a peer id without and
routing information.

Author: achingbrain

src/index.ts

@@ -69,6 +69,23 @@ export interface MultiaddrMatcher {
   exactMatch(ma: Multiaddr): boolean
 }
 
+/**
+ * Matches PeerId addresses
+ *
+ * @example
+ *
+ * ```ts
+ * import { multiaddr } from '@multiformats/multiaddr'
+ * import { PEER_ID } from '@multiformats/multiaddr-matcher'
+ *
+ * PEER_ID.matches(multiaddr('/p2p/Qmfoo')) // true
+ * PEER_ID.matches(multiaddr('/ipfs/Qmfoo')) // true
+ * ```
+ */
+const _PEER_ID = peerId()
+
+export const PEER_ID = fmt(_PEER_ID)
+
 /**
  * DNS matchers
  */

test/index.spec.ts

@@ -354,6 +354,22 @@ describe('multiaddr matcher', () => {
     '/ip4/0.0.0.0/udp/80/http'
   ]
 
+  const exactPeer = [
+    '/p2p/12D3KooWQF6Q3i1QkziJQ9mkNNcyFD8GPQz6R6oEvT75wgsVXm4v',
+    '/p2p/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64',
+    '/ipfs/12D3KooWQF6Q3i1QkziJQ9mkNNcyFD8GPQz6R6oEvT75wgsVXm4v',
+    '/ipfs/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64'
+  ]
+
+  const goodPeer = [
+    ...exactPeer
+  ]
+
+  const badPeer = [
+    '/ip4/0.0.0.0/udp/80/http',
+    '/memory/0xDEADBEEF'
+  ]
+
   function assertMatches (p: MultiaddrMatcher, ...tests: string[][]): void {
     tests.forEach((test) => {
       test.forEach((testcase) => {
@@ -474,4 +490,10 @@ describe('multiaddr matcher', () => {
     assertExactMatches(mafmt.Memory, exactMemory)
     assertMismatches(mafmt.Memory, badMemory)
   })
+
+  it('PeerID addresses', () => {
+    assertMatches(mafmt.PEER_ID, goodPeer)
+    assertExactMatches(mafmt.PEER_ID, exactPeer)
+    assertMismatches(mafmt.PEER_ID, badPeer)
+  })
 })