Merge branch 'main' into feat/add-unix

Author: achingbrain

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.4.1](https://github.com/multiformats/js-multiaddr-matcher/compare/v1.4.0...v1.4.1) (2024-11-04)
+
+### Dependencies
+
+* **dev:** bump aegir from 44.1.4 to 45.0.1 ([#40](https://github.com/multiformats/js-multiaddr-matcher/issues/40)) ([443cd68](https://github.com/multiformats/js-multiaddr-matcher/commit/443cd6841c6623c6e2dc0dc7a83108f1d3dc4a0d))
+
 ## [1.4.0](https://github.com/multiformats/js-multiaddr-matcher/compare/v1.3.0...v1.4.0) (2024-10-28)
 
 ### Features

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiformats/multiaddr-matcher",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Match different multiaddr formats",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/multiformats/js-multiaddr-matcher#readme",
@@ -166,6 +166,6 @@
     "multiformats": "^13.0.0"
   },
   "devDependencies": {
-    "aegir": "^44.1.1"
+    "aegir": "^45.0.1"
   }
 }

src/index.ts

@@ -461,6 +461,23 @@ const _HTTPS = or(
  */
 export const HTTPS = fmt(_HTTPS)
 
+const _Memory = or(
+  and(literal('memory'), string(), optional(peerId()))
+)
+
+/**
+ * Matches Memory addresses
+ *
+ * @example
+ *
+ * ```ts
+ * import { Memory } from '@multiformats/multiaddr-matcher'
+ *
+ * Memory.matches(multiaddr('/memory/0xDEADBEEF')) // true
+ * ```
+ */
+export const Memory = fmt(_Memory)
+
 const _Unix = or(
   and(literal('unix'), string(), optional(peerId()))
 )

test/index.spec.ts

@@ -309,6 +309,20 @@ describe('multiaddr matcher', () => {
     '/ip4/0.0.0.0/udp/80/http'
   ]
 
+  const exactMemory = [
+    '/memory/0xDEADBEEF',
+    '/memory/0xDEADBEEF/p2p/12D3KooWQF6Q3i1QkziJQ9mkNNcyFD8GPQz6R6oEvT75wgsVXm4v'
+  ]
+
+  const goodMemory = [
+    ...exactMemory,
+    '/memory/0xDEADBEEF/webrtc/p2p/12D3KooWQF6Q3i1QkziJQ9mkNNcyFD8GPQz6R6oEvT75wgsVXm4v'
+  ]
+
+  const badMemory = [
+    '/ip4/0.0.0.0/udp/80/http'
+  ]
+
   const exactUnix = [
     '/unix/%2Fpath%2Fto%2Funix.socket',
     '/unix/%2Fpath%2Fto%2Funix.socket/p2p/12D3KooWQF6Q3i1QkziJQ9mkNNcyFD8GPQz6R6oEvT75wgsVXm4v'
@@ -430,6 +444,12 @@ describe('multiaddr matcher', () => {
     assertMismatches(mafmt.HTTPS, badHTTPS)
   })
 
+  it('Memory addresses', () => {
+    assertMatches(mafmt.Memory, goodMemory)
+    assertExactMatches(mafmt.Memory, exactMemory)
+    assertMismatches(mafmt.Memory, badMemory)
+  })
+
   it('Unix addresses', () => {
     assertMatches(mafmt.Unix, goodUnix)
     assertExactMatches(mafmt.Unix, exactUnix)