libp2p 2.3.0 → 2.3.1-339b7df88

package/src/address-manager.ts

@@ -13,19 +13,24 @@ export interface AddressManagerInit {
   announceFilter?: AddressFilter
 
   /**
-   * list of multiaddrs string representation to listen
+   * A list of string multiaddrs to listen on
    */
   listen?: string[]
 
   /**
-   * list of multiaddrs string representation to announce
+   * A list of string multiaddrs to use instead of those reported by transports
    */
   announce?: string[]
 
   /**
-   * list of multiaddrs string representation to never announce
+   * A list of string multiaddrs string to never announce
    */
   noAnnounce?: string[]
+
+  /**
+   * A list of string multiaddrs to add to the list of announced addresses
+   */
+  appendAnnounce?: string[]
 }
 
 export interface AddressManagerComponents {
@@ -73,6 +78,13 @@ const CODEC_IP4 = 0x04
 const CODEC_IP6 = 0x29
 const CODEC_DNS4 = 0x36
 const CODEC_DNS6 = 0x37
+const CODEC_TCP = 0x06
+const CODEC_UDP = 0x0111
+
+interface PublicAddressMapping {
+  externalIp: string
+  externalPort: number
+}
 
 export class AddressManager implements AddressManagerInterface {
   private readonly log: Logger
@@ -80,11 +92,11 @@ export class AddressManager implements AddressManagerInterface {
   // this is an array to allow for duplicates, e.g. multiples of `/ip4/0.0.0.0/tcp/0`
   private readonly listen: string[]
   private readonly announce: Set<string>
+  private readonly appendAnnounce: Set<string>
   private readonly observed: Map<string, ObservedAddressMetadata>
   private readonly announceFilter: AddressFilter
   private readonly ipDomainMappings: Map<string, string>
-
-  private readonly where: Error
+  private readonly publicAddressMappings: Map<string, PublicAddressMapping[]>
 
   /**
    * Responsible for managing the peer addresses.
@@ -93,14 +105,16 @@ export class AddressManager implements AddressManagerInterface {
    * while the announce addresses will be used for the peer addresses' to other peers in the network.
    */
   constructor (components: AddressManagerComponents, init: AddressManagerInit = {}) {
-    const { listen = [], announce = [] } = init
+    const { listen = [], announce = [], appendAnnounce = [] } = init
 
     this.components = components
     this.log = components.logger.forComponent('libp2p:address-manager')
     this.listen = listen.map(ma => ma.toString())
     this.announce = new Set(announce.map(ma => ma.toString()))
+    this.appendAnnounce = new Set(appendAnnounce.map(ma => ma.toString()))
     this.observed = new Map()
     this.ipDomainMappings = new Map()
+    this.publicAddressMappings = new Map()
     this.announceFilter = init.announceFilter ?? defaultAddressFilter
 
     // this method gets called repeatedly on startup when transports start listening so
@@ -115,8 +129,6 @@ export class AddressManager implements AddressManagerInterface {
     components.events.addEventListener('transport:close', () => {
       this._updatePeerStoreAddresses()
     })
-
-    this.where = new Error('where')
   }
 
   readonly [Symbol.toStringTag] = '@libp2p/address-manager'
@@ -124,13 +136,8 @@ export class AddressManager implements AddressManagerInterface {
   _updatePeerStoreAddresses (): void {
     // if announce addresses have been configured, ensure they make it into our peer
     // record for things like identify
-    const addrs = this.getAnnounceAddrs()
-      .concat(this.components.transportManager.getAddrs())
-      .concat(
-        [...this.observed.entries()]
-          .filter(([_, metadata]) => metadata.confident)
-          .map(([str]) => multiaddr(str))
-      ).map(ma => {
+    const addrs = this.getAddresses()
+      .map(ma => {
         // strip our peer id if it is present
         if (ma.getPeerId() === this.components.peerId.toString()) {
           return ma.decapsulate(`/p2p/${this.components.peerId.toString()}`)
@@ -159,6 +166,13 @@ export class AddressManager implements AddressManagerInterface {
     return Array.from(this.announce).map((a) => multiaddr(a))
   }
 
+  /**
+   * Get peer announcing multiaddrs
+   */
+  getAppendAnnounceAddrs (): Multiaddr[] {
+    return Array.from(this.appendAnnounce).map((a) => multiaddr(a))
+  }
+
   /**
    * Get observed multiaddrs
    */
@@ -218,19 +232,62 @@ export class AddressManager implements AddressManagerInterface {
       multiaddrs = this.components.transportManager.getAddrs()
     }
 
-    // add observed addresses we are confident in
     multiaddrs = multiaddrs
       .concat(
+        // add additional announce addresses
+        ...this.getAppendAnnounceAddrs(),
+
+        // add observed addresses we are confident in
         Array.from(this.observed)
           .filter(([ma, metadata]) => metadata.confident)
           .map(([ma]) => multiaddr(ma))
       )
 
-    const mappedMultiaddrs: Multiaddr[] = []
+    // add public addresses
+    const ipMappedMultiaddrs: Multiaddr[] = []
+    multiaddrs.forEach(ma => {
+      const tuples = ma.stringTuples()
+      let tuple: string | undefined
+
+      // see if the internal host/port/protocol tuple has been mapped externally
+      if ((tuples[0][0] === CODEC_IP4 || tuples[0][0] === CODEC_IP6) && tuples[1][0] === CODEC_TCP) {
+        tuple = `${tuples[0][1]}-${tuples[1][1]}-tcp`
+      } else if ((tuples[0][0] === CODEC_IP4 || tuples[0][0] === CODEC_IP6) && tuples[1][0] === CODEC_UDP) {
+        tuple = `${tuples[0][1]}-${tuples[1][1]}-udp`
+      }
+
+      if (tuple == null) {
+        return
+      }
+
+      const mappings = this.publicAddressMappings.get(tuple)
+
+      if (mappings == null) {
+        return
+      }
+
+      mappings.forEach(mapping => {
+        tuples[0][1] = mapping.externalIp
+        tuples[1][1] = `${mapping.externalPort}`
+
+        ipMappedMultiaddrs.push(
+          multiaddr(`/${
+            tuples.map(tuple => {
+              return [
+                protocols(tuple[0]).name,
+                tuple[1]
+              ].join('/')
+            }).join('/')
+          }`)
+        )
+      })
+    })
+    multiaddrs = multiaddrs.concat(ipMappedMultiaddrs)
 
     // add ip->domain mappings
+    const dnsMappedMultiaddrs: Multiaddr[] = []
     for (const ma of multiaddrs) {
-      const tuples = [...ma.stringTuples()]
+      const tuples = ma.stringTuples()
       let mappedIp = false
 
       for (const [ip, domain] of this.ipDomainMappings.entries()) {
@@ -254,7 +311,7 @@ export class AddressManager implements AddressManagerInterface {
       }
 
       if (mappedIp) {
-        mappedMultiaddrs.push(
+        dnsMappedMultiaddrs.push(
           multiaddr(`/${
             tuples.map(tuple => {
               return [
@@ -266,8 +323,7 @@ export class AddressManager implements AddressManagerInterface {
         )
       }
     }
-
-    multiaddrs = multiaddrs.concat(mappedMultiaddrs)
+    multiaddrs = multiaddrs.concat(dnsMappedMultiaddrs)
 
     // dedupe multiaddrs
     const addrSet = new Set<string>()
@@ -305,15 +361,46 @@ export class AddressManager implements AddressManagerInterface {
 
   addDNSMapping (domain: string, addresses: string[]): void {
     addresses.forEach(ip => {
+      this.log('add DNS mapping %s to %s', ip, domain)
       this.ipDomainMappings.set(ip, domain)
     })
+    this._updatePeerStoreAddresses()
   }
 
   removeDNSMapping (domain: string): void {
     for (const [key, value] of this.ipDomainMappings.entries()) {
       if (value === domain) {
+        this.log('remove DNS mapping for %s', domain)
         this.ipDomainMappings.delete(key)
       }
     }
+    this._updatePeerStoreAddresses()
+  }
+
+  addPublicAddressMapping (internalIp: string, internalPort: number, externalIp: string, externalPort: number = internalPort, protocol: 'tcp' | 'udp' = 'tcp'): void {
+    const key = `${internalIp}-${internalPort}-${protocol}`
+    const mappings = this.publicAddressMappings.get(key) ?? []
+    mappings.push({
+      externalIp,
+      externalPort
+    })
+
+    this.publicAddressMappings.set(key, mappings)
+    this._updatePeerStoreAddresses()
+  }
+
+  removePublicAddressMapping (internalIp: string, internalPort: number, externalIp: string, externalPort: number = internalPort, protocol: 'tcp' | 'udp' = 'tcp'): void {
+    const key = `${internalIp}-${internalPort}-${protocol}`
+    const mappings = (this.publicAddressMappings.get(key) ?? []).filter(mapping => {
+      return mapping.externalIp !== externalIp && mapping.externalPort !== externalPort
+    })
+
+    if (mappings.length === 0) {
+      this.publicAddressMappings.delete(key)
+    } else {
+      this.publicAddressMappings.set(key, mappings)
+    }
+
+    this._updatePeerStoreAddresses()
   }
 }

package/src/config/connection-gater.browser.ts

@@ -1,19 +1,33 @@
 import { isPrivateIp } from '@libp2p/utils/private-ip'
+import { WebSockets } from '@multiformats/multiaddr-matcher'
 import type { ConnectionGater } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+const CODEC_IP4 = 0x04
+const CODEC_IP6 = 0x29
+
 /**
- * Returns a connection gater that disallows dialling private addresses by
- * default. Browsers are severely limited in their resource usage so don't
- * waste time trying to dial undiallable addresses.
+ * Returns a connection gater that disallows dialling private addresses or
+ * insecure websockets by default.
+ *
+ * Browsers are severely limited in their resource usage so don't waste time
+ * trying to dial undiallable addresses, and they also print verbose error
+ * messages when making connections over insecure transports which causes
+ * confusion.
  */
 export function connectionGater (gater: ConnectionGater = {}): ConnectionGater {
   return {
     denyDialPeer: async () => false,
     denyDialMultiaddr: async (multiaddr: Multiaddr) => {
+      // do not connect to insecure websockets by default
+      if (WebSockets.matches(multiaddr)) {
+        return false
+      }
+
       const tuples = multiaddr.stringTuples()
 
-      if (tuples[0][0] === 4 || tuples[0][0] === 41) {
+      // do not connect to private addresses by default
+      if (tuples[0][0] === CODEC_IP4 || tuples[0][0] === CODEC_IP6) {
         return Boolean(isPrivateIp(`${tuples[0][1]}`))
       }
 

package/src/connection-manager/dial-queue.ts

@@ -1,11 +1,11 @@
 /* eslint-disable max-depth */
 import { TimeoutError, DialError, setMaxListeners, AbortError } from '@libp2p/interface'
 import { PeerMap } from '@libp2p/peer-collections'
-import { PriorityQueue, type PriorityQueueJobOptions } from '@libp2p/utils/priority-queue'
-import { type Multiaddr, type Resolver, resolvers, multiaddr } from '@multiformats/multiaddr'
+import { PriorityQueue } from '@libp2p/utils/priority-queue'
+import { resolvers, multiaddr } from '@multiformats/multiaddr'
 import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers'
 import { Circuit } from '@multiformats/multiaddr-matcher'
-import { type ClearableSignal, anySignal } from 'any-signal'
+import { anySignal } from 'any-signal'
 import { CustomProgressEvent } from 'progress-events'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { DialDeniedError, NoValidAddressesError } from '../errors.js'
@@ -23,7 +23,9 @@ import { resolveMultiaddrs } from './utils.js'
 import { DEFAULT_DIAL_PRIORITY } from './index.js'
 import type { AddressSorter, ComponentLogger, Logger, Connection, ConnectionGater, Metrics, PeerId, Address, PeerStore, PeerRouting, IsDialableOptions, OpenConnectionProgressEvents } from '@libp2p/interface'
 import type { OpenConnectionOptions, TransportManager } from '@libp2p/interface-internal'
+import type { PriorityQueueJobOptions } from '@libp2p/utils/priority-queue'
 import type { DNS } from '@multiformats/dns'
+import type { Multiaddr, Resolver } from '@multiformats/multiaddr'
 import type { ProgressOptions } from 'progress-events'
 
 export interface PendingDialTarget {
@@ -204,7 +206,12 @@ export class DialQueue {
       options?.onProgress?.(new CustomProgressEvent('dial-queue:start-dial'))
       // create abort conditions - need to do this before `calculateMultiaddrs` as
       // we may be about to resolve a dns addr which can time out
-      const signal = this.createDialAbortController(options?.signal)
+      const signal = anySignal([
+        this.shutDownController.signal,
+        options.signal
+      ])
+      setMaxListeners(Infinity, signal)
+
       let addrsToDial: Address[]
 
       try {
@@ -299,25 +306,11 @@ export class DialQueue {
       peerId,
       priority: options.priority ?? DEFAULT_DIAL_PRIORITY,
       multiaddrs: new Set(multiaddrs.map(ma => ma.toString())),
-      signal: options.signal,
+      signal: options.signal ?? AbortSignal.timeout(this.dialTimeout),
       onProgress: options.onProgress
     })
   }
 
-  private createDialAbortController (userSignal?: AbortSignal): ClearableSignal {
-    // let any signal abort the dial
-    const signal = anySignal([
-      AbortSignal.timeout(this.dialTimeout),
-      this.shutDownController.signal,
-      userSignal
-    ])
-
-    // This emitter gets listened to a lot
-    setMaxListeners(Infinity, signal)
-
-    return signal
-  }
-
   // eslint-disable-next-line complexity
   private async calculateMultiaddrs (peerId?: PeerId, multiaddrs: Set<string> = new Set<string>(), options: OpenConnectionOptions = {}): Promise<Address[]> {
     const addrs: Address[] = [...multiaddrs].map(ma => ({

package/src/version.ts

@@ -1,2 +1,2 @@
-export const version = '2.3.0'
-export const name = 'libp2p'
+export const version = '2.3.1-339b7df88'
+export const name = 'js-libp2p'

package/LICENSE

@@ -1,4 +0,0 @@
-This project is dual licensed under MIT and Apache-2.0.
-
-MIT: https://www.opensource.org/licenses/mit
-Apache-2.0: https://www.apache.org/licenses/license-2.0

package/dist/typedoc-urls.json

@@ -1,19 +0,0 @@
-{
-  "AddressFilter": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.AddressFilter.html",
-  "AddressManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.AddressManagerInit.html",
-  "ConnectionManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.ConnectionManagerInit.html",
-  "ConnectionMonitorInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.ConnectionMonitorInit.html",
-  "Libp2pInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.Libp2pInit.html",
-  ".:Libp2pInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.Libp2pInit.html",
-  "TransportManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/libp2p.index.TransportManagerInit.html",
-  "Libp2pOptions": "https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html",
-  ".:Libp2pOptions": "https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html",
-  "ServiceFactoryMap": "https://libp2p.github.io/js-libp2p/types/libp2p.index.ServiceFactoryMap.html",
-  ".:ServiceFactoryMap": "https://libp2p.github.io/js-libp2p/types/libp2p.index.ServiceFactoryMap.html",
-  "createLibp2p": "https://libp2p.github.io/js-libp2p/functions/libp2p.index.createLibp2p.html",
-  ".:createLibp2p": "https://libp2p.github.io/js-libp2p/functions/libp2p.index.createLibp2p.html",
-  "name": "https://libp2p.github.io/js-libp2p/variables/libp2p.version.name.html",
-  "./version:name": "https://libp2p.github.io/js-libp2p/variables/libp2p.version.name.html",
-  "version": "https://libp2p.github.io/js-libp2p/variables/libp2p.version.version.html",
-  "./version:version": "https://libp2p.github.io/js-libp2p/variables/libp2p.version.version.html"
-}