@libp2p/utils 6.7.2-a02cb0461 → 6.7.2-da78fa851

package/src/multiaddr/is-network-address.ts

@@ -1,30 +1,15 @@
-import { CODE_IP4, CODE_IP6, CODE_IP6ZONE, CODE_DNS, CODE_DNS4, CODE_DNS6, CODE_DNSADDR } from '@multiformats/multiaddr'
+import { getNetConfig } from './get-net-config.ts'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
-const NETWORK_CODECS = [
-  CODE_IP4,
-  CODE_IP6,
-  CODE_DNS,
-  CODE_DNS4,
-  CODE_DNS6,
-  CODE_DNSADDR
-]
-
 /**
  * Check if a given multiaddr is a network address
  */
 export function isNetworkAddress (ma: Multiaddr): boolean {
   try {
-    for (const { code } of ma.getComponents()) {
-      if (code === CODE_IP6ZONE) {
-        continue
-      }
+    getNetConfig(ma)
 
-      return NETWORK_CODECS.includes(code)
-    }
+    return true
   } catch {
-
+    return false
   }
-
-  return false
 }

package/src/multiaddr/is-private.ts

@@ -1,5 +1,5 @@
 import { isPrivateIp } from '../private-ip.js'
-import { isIpBased } from './is-ip-based.js'
+import { getNetConfig } from './get-net-config.ts'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
 /**
@@ -7,21 +7,16 @@ import type { Multiaddr } from '@multiformats/multiaddr'
  */
 export function isPrivate (ma: Multiaddr): boolean {
   try {
-    if (!isIpBased(ma)) {
-      // not an IP based multiaddr, cannot be private
-      return false
-    }
-
-    const [[, value]] = ma.stringTuples()
+    const config = getNetConfig(ma)
 
-    if (value == null) {
-      return false
+    switch (config.type) {
+      case 'ip4':
+      case 'ip6':
+        return isPrivateIp(config.host) ?? false
+      default:
+        return config.host === 'localhost'
     }
-
-    return isPrivateIp(value) ?? false
   } catch {
-
+    return false
   }
-
-  return true
 }

package/src/multiaddr/utils.ts

@@ -0,0 +1,46 @@
+import { CODE_IP4, CODE_IP6, CODE_IP6ZONE, multiaddr } from '@multiformats/multiaddr'
+import type { NetConfig } from './get-net-config.ts'
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+export function getIpFromMultiaddr (ma: Multiaddr): string | undefined {
+  const components = ma.getComponents()
+  let index = 0
+
+  if (components[0]?.code === CODE_IP6ZONE) {
+    index++
+  }
+
+  if (components[index]?.code !== CODE_IP4 && components[index]?.code !== CODE_IP6) {
+    return
+  }
+
+  return components[index]?.value
+}
+
+export function netConfigToMultiaddr (config: NetConfig, port?: number | string, host?: string): Multiaddr {
+  const parts: Array<string | number> = [
+    config.type,
+    host ?? config.host
+  ]
+
+  if (config.protocol != null) {
+    const p = port ?? config.port
+
+    if (p != null) {
+      parts.push(
+        config.protocol,
+        p
+      )
+    }
+  }
+
+  if (config.type === 'ip6' && config.zone != null) {
+    parts.unshift('ip6zone', config.zone)
+  }
+
+  if (config.cidr != null) {
+    parts.push('ipcidr', config.cidr)
+  }
+
+  return multiaddr(`/${parts.join('/')}`)
+}

package/src/stream-utils.ts

@@ -6,8 +6,7 @@ import { raceSignal } from 'race-signal'
 import * as varint from 'uint8-varint'
 import { Uint8ArrayList } from 'uint8arraylist'
 import { UnexpectedEOFError } from './errors.js'
-import type { MessageStream, MultiaddrConnection, Stream } from '@libp2p/interface'
-import type { AbortOptions } from '@multiformats/multiaddr'
+import type { MessageStream, MultiaddrConnection, Stream, AbortOptions } from '@libp2p/interface'
 import type { Duplex, Source, Transform, Sink } from 'it-stream-types'
 
 const DEFAULT_MAX_BUFFER_SIZE = 4_194_304
@@ -51,14 +50,6 @@ export interface ByteStreamOpts {
    * @default 4_194_304
    */
   maxBufferSize?: number
-
-  /**
-   * If true, prevent message events propagating after they have been received,
-   *
-   * This is useful for when there are be other observers of messages and the
-   * caller does not wish to them to receive anything
-   */
-  stopPropagation?: boolean
 }
 
 export interface ReadBytesOptions extends AbortOptions {
@@ -133,10 +124,6 @@ export function byteStream <T extends MessageStream> (stream: T, opts?: ByteStre
   }
 
   const byteStreamOnMessageListener = (evt: StreamMessageEvent): void => {
-    if (opts?.stopPropagation === true) {
-      // evt.stopImmediatePropagation()
-    }
-
     readBuffer.append(evt.data)
 
     if (readBuffer.byteLength > maxBufferSize) {
@@ -178,6 +165,7 @@ export function byteStream <T extends MessageStream> (stream: T, opts?: ByteStre
         }
 
         if (readBuffer.byteLength < options.bytes) {
+          stream.log.error('closed after reading %d/%d bytes', readBuffer.byteLength, options.bytes)
           throw new UnexpectedEOFError(`Unexpected EOF - stream closed after reading ${readBuffer.byteLength}/${options.bytes} bytes`)
         }
       }
@@ -211,6 +199,7 @@ export function byteStream <T extends MessageStream> (stream: T, opts?: ByteStre
 
       if (readBuffer.byteLength < toRead) {
         if (isEOF(stream)) {
+          stream.log.error('closed while reading %d/%d bytes', readBuffer.byteLength, toRead)
           throw new UnexpectedEOFError(`Unexpected EOF - stream closed while reading ${readBuffer.byteLength}/${toRead} bytes`)
         }
 
@@ -353,10 +342,12 @@ export function lpStream <T extends MessageStream> (stream: T, opts: Partial<Len
       })
 
       if (buf == null) {
+        stream.log.error('tried to read %d bytes but the stream closed', dataLength)
         throw new UnexpectedEOFError(`Unexpected EOF - tried to read ${dataLength} bytes but the stream closed`)
       }
 
       if (buf.byteLength !== dataLength) {
+        stream.log.error('read %d/%d bytes before the stream closed', buf.byteLength, dataLength)
         throw new UnexpectedEOFError(`Unexpected EOF - read ${buf.byteLength}/${dataLength} bytes before the stream closed`)
       }
 

package/dist/src/multiaddr/is-ip-based.d.ts

@@ -1,6 +0,0 @@
-import type { Multiaddr } from '@multiformats/multiaddr';
-/**
- * Check if a given multiaddr is IP-based
- */
-export declare function isIpBased(ma: Multiaddr): boolean;
-//# sourceMappingURL=is-ip-based.d.ts.map

package/dist/src/multiaddr/is-ip-based.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-ip-based.d.ts","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,wBAAgB,SAAS,CAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAcjD"}

package/dist/src/multiaddr/is-ip-based.js

@@ -1,18 +0,0 @@
-import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr';
-/**
- * Check if a given multiaddr is IP-based
- */
-export function isIpBased(ma) {
-    try {
-        for (const { code } of ma.getComponents()) {
-            if (code === CODE_IP6ZONE) {
-                continue;
-            }
-            return code === CODE_IP4 || code === CODE_IP6;
-        }
-    }
-    catch {
-    }
-    return false;
-}
-//# sourceMappingURL=is-ip-based.js.map

package/dist/src/multiaddr/is-ip-based.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-ip-based.js","sourceRoot":"","sources":["../../../src/multiaddr/is-ip-based.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAG1E;;GAEG;AACH,MAAM,UAAU,SAAS,CAAE,EAAa;IACtC,IAAI,CAAC;QACH,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1B,SAAQ;YACV,CAAC;YAED,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,QAAQ,CAAA;QAC/C,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;IAET,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}

package/src/multiaddr/is-ip-based.ts

@@ -1,21 +0,0 @@
-import { CODE_IP4, CODE_IP6, CODE_IP6ZONE } from '@multiformats/multiaddr'
-import type { Multiaddr } from '@multiformats/multiaddr'
-
-/**
- * Check if a given multiaddr is IP-based
- */
-export function isIpBased (ma: Multiaddr): boolean {
-  try {
-    for (const { code } of ma.getComponents()) {
-      if (code === CODE_IP6ZONE) {
-        continue
-      }
-
-      return code === CODE_IP4 || code === CODE_IP6
-    }
-  } catch {
-
-  }
-
-  return false
-}