libp2p 2.3.1-4a85eb033 → 2.3.1-6ab85ea68

package/src/address-manager.ts

@@ -1,3 +1,4 @@
+import { isIPv4 } from '@chainsafe/is-ip'
 import { peerIdFromString } from '@libp2p/peer-id'
 import { debounce } from '@libp2p/utils/debounce'
 import { multiaddr, protocols } from '@multiformats/multiaddr'
@@ -5,6 +6,10 @@ import type { ComponentLogger, Libp2pEvents, Logger, TypedEventTarget, PeerId, P
 import type { AddressManager as AddressManagerInterface, TransportManager } from '@libp2p/interface-internal'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+export const defaultValues = {
+  maxObservedAddresses: 10
+}
+
 export interface AddressManagerInit {
   /**
    * Pass an function in this field to override the list of addresses
@@ -31,6 +36,11 @@ export interface AddressManagerInit {
    * A list of string multiaddrs to add to the list of announced addresses
    */
   appendAnnounce?: string[]
+
+  /**
+   * Limits the number of observed addresses we will store
+   */
+  maxObservedAddresses?: number
 }
 
 export interface AddressManagerComponents {
@@ -86,6 +96,11 @@ interface PublicAddressMapping {
   externalPort: number
 }
 
+interface DNSMapping {
+  domain: string
+  confident: boolean
+}
+
 export class AddressManager implements AddressManagerInterface {
   private readonly log: Logger
   private readonly components: AddressManagerComponents
@@ -95,8 +110,9 @@ export class AddressManager implements AddressManagerInterface {
   private readonly appendAnnounce: Set<string>
   private readonly observed: Map<string, ObservedAddressMetadata>
   private readonly announceFilter: AddressFilter
-  private readonly ipDomainMappings: Map<string, string>
+  private readonly ipDomainMappings: Map<string, DNSMapping>
   private readonly publicAddressMappings: Map<string, PublicAddressMapping[]>
+  private readonly maxObservedAddresses: number
 
   /**
    * Responsible for managing the peer addresses.
@@ -116,6 +132,7 @@ export class AddressManager implements AddressManagerInterface {
     this.ipDomainMappings = new Map()
     this.publicAddressMappings = new Map()
     this.announceFilter = init.announceFilter ?? defaultAddressFilter
+    this.maxObservedAddresses = init.maxObservedAddresses ?? defaultValues.maxObservedAddresses
 
     // this method gets called repeatedly on startup when transports start listening so
     // debounce it so we don't cause multiple self:peer:update events to be emitted
@@ -149,7 +166,9 @@ export class AddressManager implements AddressManagerInterface {
     this.components.peerStore.patch(this.components.peerId, {
       multiaddrs: addrs
     })
-      .catch(err => { this.log.error('error updating addresses', err) })
+      .catch(err => {
+        this.log.error('error updating addresses', err)
+      })
   }
 
   /**
@@ -184,6 +203,10 @@ export class AddressManager implements AddressManagerInterface {
    * Add peer observed addresses
    */
   addObservedAddr (addr: Multiaddr): void {
+    if (this.observed.size === this.maxObservedAddresses) {
+      return
+    }
+
     addr = stripPeerId(addr, this.components.peerId)
     const addrString = addr.toString()
 
@@ -266,7 +289,8 @@ export class AddressManager implements AddressManagerInterface {
         return
       }
 
-      mappings.forEach(mapping => {
+      for (const mapping of mappings) {
+        tuples[0][0] = isIPv4(mapping.externalIp) ? CODEC_IP4 : CODEC_IP6
         tuples[0][1] = mapping.externalIp
         tuples[1][1] = `${mapping.externalPort}`
 
@@ -280,7 +304,7 @@ export class AddressManager implements AddressManagerInterface {
             }).join('/')
           }`)
         )
-      })
+      }
     })
     multiaddrs = multiaddrs.concat(ipMappedMultiaddrs)
 
@@ -290,7 +314,11 @@ export class AddressManager implements AddressManagerInterface {
       const tuples = ma.stringTuples()
       let mappedIp = false
 
-      for (const [ip, domain] of this.ipDomainMappings.entries()) {
+      for (const [ip, mapping] of this.ipDomainMappings.entries()) {
+        if (!mapping.confident) {
+          continue
+        }
+
         for (let i = 0; i < tuples.length; i++) {
           if (tuples[i][1] !== ip) {
             continue
@@ -298,13 +326,13 @@ export class AddressManager implements AddressManagerInterface {
 
           if (tuples[i][0] === CODEC_IP4) {
             tuples[i][0] = CODEC_DNS4
-            tuples[i][1] = domain
+            tuples[i][1] = mapping.domain
             mappedIp = true
           }
 
           if (tuples[i][0] === CODEC_IP6) {
             tuples[i][0] = CODEC_DNS6
-            tuples[i][1] = domain
+            tuples[i][1] = mapping.domain
             mappedIp = true
           }
         }
@@ -362,14 +390,23 @@ 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)
+
+      // check ip/public ip mappings to see if we think we are contactable
+      const confident = [...this.publicAddressMappings.entries()].some(([key, mappings]) => {
+        return mappings.some(mapping => mapping.externalIp === ip)
+      })
+
+      this.ipDomainMappings.set(ip, {
+        domain,
+        confident
+      })
     })
     this._updatePeerStoreAddresses()
   }
 
   removeDNSMapping (domain: string): void {
-    for (const [key, value] of this.ipDomainMappings.entries()) {
-      if (value === domain) {
+    for (const [key, mapping] of this.ipDomainMappings.entries()) {
+      if (mapping.domain === domain) {
         this.log('remove DNS mapping for %s', domain)
         this.ipDomainMappings.delete(key)
       }
@@ -386,6 +423,17 @@ export class AddressManager implements AddressManagerInterface {
     })
 
     this.publicAddressMappings.set(key, mappings)
+
+    // update domain mappings to indicate we are now confident that any matching
+    // ip/domain combination can now be resolved externally
+    for (const [key, mapping] of this.ipDomainMappings.entries()) {
+      if (key === externalIp) {
+        mapping.confident = true
+
+        this.ipDomainMappings.set(key, mapping)
+      }
+    }
+
     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.1-4a85eb033'
-export const name = 'libp2p'
+export const version = '2.3.1-6ab85ea68'
+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