docs: repair broken links (#3411)

Links can be checked in the future by using https://lychee.cli.rs/
lychee -q '**/*.md' '**/*.ts'

Author: tabcat

.gitignore

@@ -10,3 +10,4 @@ yarn.lock
 interop/*-image.json
 .tmp-compiled-docs
 tsconfig-doc-check.aegir.json
+.lycheecache

README.md

@@ -187,8 +187,7 @@ List of packages currently in existence for libp2p
     <a href="https://hoprnet.org/"><img width="150" src="https://github.com/hoprnet/hopr-assets/blob/master/v1/logo/hopr_logo_padded.png?raw=true" alt="HOPR Logo" /></a>
     <a href="https://helia.io/"><img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia (IPFS in JavaScript) logo" width="150" /></a>
     <a href="https://github.com/orbitdb/orbitdb"><img src="https://avatars.githubusercontent.com/u/25079463?s=200&v=4" alt="OrbitDB logo" width="150" /></a>
-    <a href="https://peerbit.org/"><img src="https://peerbit.org/peerbit-logo.png" alt="Peerbit logo" width="150" /></a>
-    <a href="https://blog.topology.gg/"><img src="https://avatars.githubusercontent.com/u/157637200" alt="Topology logo" width="150" /></a>
+    <a href="https://peerbit.org/"><img src="https://www.peerbit.org/content/docs/peerbit-logo.png" alt="Peerbit logo" width="150" /></a>
   </p>
 </div>
 

doc/CONFIGURATION.md

@@ -76,11 +76,11 @@ Some available transports are:
 - [@libp2p/websockets](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets)
 - [@libp2p/webtransport](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport)
 
-If none of the available transports fulfils your needs, you can create a libp2p compatible transport. A libp2p transport just needs to be compliant with the [Transport Interface](https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/transport).
+If none of the available transports fulfils your needs, you can create a libp2p compatible transport. A libp2p transport just needs to be compliant with the [Transport Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/transport.ts).
 
 If you want to know more about libp2p transports, you should read the following content:
 
-- https://docs.libp2p.io/concepts/transports/overview
+- https://libp2p.io/docs/transports-overview/
 - https://github.com/libp2p/specs/tree/master/connections
 
 ### Stream Multiplexing
@@ -93,7 +93,7 @@ Some available stream multiplexers are:
 
 Some transports such as WebRTC and WebTransport come with their own built-in stream multiplexing capabilities.
 
-If none of the available stream multiplexers fulfills your needs, you can create a libp2p compatible stream multiplexer. A libp2p multiplexer just needs to be compliant with the [Stream Muxer Interface](https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/stream-muxer).
+If none of the available stream multiplexers fulfills your needs, you can create a libp2p compatible stream multiplexer. A libp2p multiplexer just needs to be compliant with the [Stream Muxer Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/stream-muxer.ts).
 
 If you want to know more about libp2p stream multiplexing, you should read the following content:
 
@@ -112,13 +112,13 @@ If you configure multiple muxers for use in your application, js-libp2p will cho
 Some available connection encryption protocols:
 
 - [@chainsafe/libp2p-noise](https://github.com/chainsafe/js-libp2p-noise)
-- [@libp2p/plaintext](https://github.com/libp2p/js-libp2p/blob/main/src/packages/connection-encrypter-plaintext/index.ts) (Not for production use)
+- [@libp2p/plaintext](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-plaintext/src/index.ts) (Not for production use)
 
-If none of the available connection encryption mechanisms fulfills your needs, you can create a libp2p compatible one. A libp2p connection encryption protocol just needs to be compliant with the [Connection Encrypter Interface](https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/connection-encrypter).
+If none of the available connection encryption mechanisms fulfills your needs, you can create a libp2p compatible one. A libp2p connection encryption protocol just needs to be compliant with the [Connection Encrypter Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/connection-encrypter.ts).
 
 If you want to know more about libp2p connection encryption, you should read the following content:
 
-- https://docs.libp2p.io/concepts/secure-comms
+- https://libp2p.io/docs/secure-channels-overview/
 - https://github.com/libp2p/specs/tree/master/connections
 
 ### Peer Discovery
@@ -132,7 +132,7 @@ Some available peer discovery modules are:
 - [@libp2p/bootstrap](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap) (typically used together with @libp2p/kad-dht)
 - [@chainsafe/discv5](https://github.com/chainsafe/discv5) ([spec](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md))
 
-If none of the available peer discovery protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer discovery protocol just needs to be compliant with the [Peer Discovery Interface](https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/peer-discovery).
+If none of the available peer discovery protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer discovery protocol just needs to be compliant with the [Peer Discovery Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/peer-discovery.ts).
 
 ### Content Routing
 
@@ -148,7 +148,7 @@ Some available content routing modules are:
 > The `@helia/delegated-routing-v1-http-api-client` module is a client for the [IPFS Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/). It is not a libp2p module, but it can be used in conjunction with libp2p to provide content and peer routing functionality.
 > For most purposes, `@helia/delegated-routing-v1-http-api-client` should be favoured over `@libp2p/delegated-content-routing` for delegated routing, as it is more broadly adopted by the ecosystem and doesn't rely on Kubo specific APIs.
 
-If none of the available content routing protocols fulfil your needs, you can create a libp2p compatible one. A libp2p content routing protocol just needs to be compliant with the [Content Routing Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/content-routing/index.ts).
+If none of the available content routing protocols fulfil your needs, you can create a libp2p compatible one. A libp2p content routing protocol just needs to be compliant with the [Content Routing Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/content-routing.ts).
 
 
 ### Peer Routing
@@ -160,7 +160,7 @@ Some available peer routing modules are:
 - [@libp2p/kad-dht](https://github.com/libp2p/js-libp2p/tree/main/packages/kad-dht)
 - [@helia/delegated-routing-v1-http-api-client](https://github.com/ipfs/helia-delegated-routing-v1-http-api)
 - [@libp2p/delegated-peer-routing](https://github.com/libp2p/js-libp2p-delegated-peer-routing)
-If none of the available peer routing protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer routing protocol just needs to be compliant with the [Peer Routing Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/peer-routing/index.ts).
+If none of the available peer routing protocols fulfills your needs, you can create a libp2p compatible one. A libp2p peer routing protocol just needs to be compliant with the [Peer Routing Interface](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/peer-routing.ts).
 
 > [!NOTE]
 > The `@helia/delegated-routing-v1-http-api-client` module is a client for the [IPFS Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/). It is not a libp2p module, but it can be used in conjunction with libp2p to provide content and peer routing functionality.
@@ -319,7 +319,7 @@ This means that pubsub requires the identify service to be configured in order t
 Potential methods for discovering peers include:
 
 - [Distributed hash tables](#dht)
-- [Local network broadcasts](https://docs.libp2p.io/concepts/discovery-routing/mdns/)
+- [Local network broadcasts](https://libp2p.io/docs/mdns/)
 - [Centralized trackers or rendezvous points](https://docs.libp2p.io/concepts/discovery-routing/rendezvous/)
 - [Lists of bootstrap peers](https://github.com/ipfs/helia/blob/main/packages/helia/src/utils/bootstrappers.ts)
 
@@ -579,7 +579,7 @@ const node = await createLibp2p({
 
 The Connection Manager manages connections to peers in libp2p.  It controls opening closing connections but also pruning connections when certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_connection_manager.html). The configuration values below show the defaults for Connection Manager.
 
-See the [API docs](https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerConfig.html) for a full run list and discussion of all Connection Manager options.
+See the [API docs](https://libp2p.github.io/js-libp2p/modules/_libp2p_interface-internal.html) for a full run list and discussion of all Connection Manager options.
 
 
 ```js

doc/GETTING_STARTED.md

@@ -55,7 +55,7 @@ For more info on enabling ES modules in Node, see [this guide](https://nodejs.or
 
 ### Basic setup
 
-Now that we have libp2p installed, let's configure the minimum needed to get your node running. The only modules libp2p requires are a [**Transport**][transport] and [**Crypto**][crypto] module. However, we recommend that a basic setup should also have a [**Stream Multiplexer**](streamMuxer) configured, which we will explain shortly. Let's start by setting up a Transport.
+Now that we have libp2p installed, let's configure the minimum needed to get your node running. The only modules libp2p requires are a [**Transport**][transport] and [**Crypto**][crypto] module. However, we recommend that a basic setup should also have a [**Stream Multiplexer**][streamMuxer] configured, which we will explain shortly. Let's start by setting up a Transport.
 
 #### Transports
 
@@ -115,7 +115,7 @@ const node = await createLibp2p({
 <details><summary>Read More</summary>
 If you want to know more about libp2p connection encryption, you should read the following content:
 
-- https://docs.libp2p.io/concepts/secure-comms
+- https://libp2p.io/docs/secure-channels-overview/
 - https://github.com/libp2p/specs/tree/master/connections
 </details>
 
@@ -154,7 +154,7 @@ If you want to know more about libp2p stream multiplexing, you should read the f
 
 #### Running Libp2p
 
-Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#start) and [`libp2p.stop()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#stop) methods.
+Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**][streamMuxer] module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#start) and [`libp2p.stop()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#stop) methods.
 
 ```ts
 import { createLibp2p } from 'libp2p'
@@ -337,6 +337,6 @@ There are a lot of other concepts within `libp2p`, that are not covered in this
 - [libp2p Connectivity](https://connectivity.libp2p.io/) — Interoperability matrix across libp2p implementations
 - [Universal Connectivity](https://github.com/libp2p/universal-connectivity) — Demo application showcasing cross-implementation connectivity
 
-[transport]: https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/transport
-[crypto]: https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/crypto
-[streamMuxer]: https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/stream-muxer
+[transport]: https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/transport.ts
+[crypto]: https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/keys.ts
+[streamMuxer]: https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/stream-muxer.ts

doc/METRICS.md

@@ -26,7 +26,7 @@ Although designed to primarily integrate with tools such as [Prometheus](https:/
 
 ### Enable metrics
 
-First enable metrics tracking by supplying a [Metrics](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/metrics/index.ts#L150) implementation:
+First enable metrics tracking by supplying a [Metrics](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/src/metrics.ts) implementation:
 
 ```TypeScript
 import { createLibp2p } from 'libp2p'
@@ -182,7 +182,7 @@ stopTimer()
 
 ## Extracting metrics
 
-Metrics implementations will allow extracting the values for presentation in an external system. For example here is how to use the metrics implementation from `@libp2p/prometheus-metrics` to enable scraping stats to display in [Prometheus](https://prometheus.io/) or a [Graphana](https://grafana.com/) dashboard. For more information, you can view our [Prometheus Metrics Docs](https://libp2p.github.io/js-libp2p/modules/_libp2p_prometheus_metrics.html)
+Metrics implementations will allow extracting the values for presentation in an external system. For example here is how to use the metrics implementation from `@libp2p/prometheus-metrics` to enable scraping stats to display in [Prometheus](https://prometheus.io/) or a [Graphana](https://grafana.com/) dashboard. For more information, you can view our [Prometheus Metrics Docs](https://libp2p.github.io/js-libp2p/modules/_libp2p_prometheus-metrics.html)
 
 
 ```TypeScript

doc/SERVICES.md

@@ -337,7 +337,7 @@ Adding these strings to your service dependencies will cause starting libp2p to
 
 | Dependency | Implementations | Notes |
 | -------- | ------- | ------- |
-| `@libp2p/identify` | `@libp2p/identify` | You should declare this a as a dependency if your service uses the [Registrar](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.Registrar.html) to register a network topology. |
+| `@libp2p/identify` | `@libp2p/identify` | You should declare this a as a dependency if your service uses the [Registrar](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.Registrar.html) to register a network topology. |
 | `@libp2p/identify-push` | `@libp2p/identify` | |
 | `@libp2p/connection-encryption` | `@chainsafe/libp2p-noise`, `@libp2p/tls`, `@libp2p/plaintext` |  |
 | `@libp2p/stream-multiplexing` | `@chainsafe/libp2p-yamux` | |

doc/production/README.md

@@ -46,7 +46,7 @@ Aiming to support these type of nodes to find other peers and content in the net
 
 Currently, delegate nodes must be IPFS nodes as the IPFS HTTP API is leveraged by them to make routing queries.
 
-You can read on how to setup your own set of delegated nodes in [DELEGATE_NODES.md](https://github.com/libp2p/js-libp2p/tree/main/doc/DELEGATE_NODES.md).
+You can read on how to setup your own set of delegated nodes in [DELEGATE_NODES.md](https://github.com/libp2p/js-libp2p/blob/main/doc/production/DELEGATE_NODES.md).
 
 ## Others
 

lychee.toml

@@ -0,0 +1,49 @@
+# https://lychee.cli.rs/
+# Lychee link checker configuration
+# Run with: lychee -q '**/*.md' '**/*.ts'
+
+# Accept 429 (Too Many Requests) - GitHub rate-limits crawlers, it doesn't
+# mean the link is broken
+# 429 = GitHub rate-limits crawlers
+# 403 = npm returns 403 to automated clients
+# 406 = some servers (e.g. bugzilla.mozilla.org) reject crawlers via content negotiation
+accept = [200, 429, 403, 406]
+
+cache = true
+max_cache_age = "1d"
+
+format = "compact"
+
+# URL patterns to skip (regex)
+exclude = [
+  # Protocol-relative URLs like //npmjs.com/package/... in markdown tables
+  # //github.com/... badge URLs cannot be resolved by lychee
+  "^//",
+
+  "mailto://",
+
+  # Localhost and LAN addresses used in test fixtures and example code
+  "^http://localhost",
+  "^http://127\\.0\\.0\\.1",
+  "^https?://192\\.168\\.",
+
+  # Specific example IPs used in test code
+  "^https?://154\\.38\\.162\\.255",
+
+  # pubsub package moved out of this repo
+  "github\\.com/libp2p/js-libp2p/tree/main/packages/pubsub",
+]
+
+# File paths/globs to exclude from scanning
+exclude_path = [
+  # CHANGELOG files are auto-generated and contain GitHub comparison URLs
+  # (e.g. .../compare/libp2p-v3.1.3...libp2p-v3.1.4) that frequently 404
+  # as old tags get cleaned up - not worth maintaining
+  "CHANGELOG\\.md",
+
+  # Migration guides document historical API changes and intentionally
+  # reference archived/superseded repositories (js-libp2p-interfaces etc.)
+  "doc/migrations",
+
+  "node_modules",
+]

packages/crypto/src/pbkdf2.ts

@@ -7,7 +7,7 @@ import { base64 } from 'multiformats/bases/base64'
 /**
  * Maps an IPFS hash name to its @noble/hashes equivalent.
  *
- * See https://github.com/multiformats/multihash/blob/master/hashtable.csv
+ * See https://github.com/multiformats/multicodec/blob/master/table.csv
  *
  * @private
  */

packages/gossipsub/README.md

@@ -1,7 +1,6 @@
 # js-libp2p-gossipsub
 
 [![](https://img.shields.io/badge/made%20by-ChainSafe-blue.svg?style=flat-square)](https://chainsafe.io/)
-[![Travis CI](https://flat.badgen.net/travis/ChainSafe/gossipsub-js)](https://travis-ci.com/ChainSafe/gossipsub-js)
 ![ES Version](https://img.shields.io/badge/ES-2017-yellow)
 ![Node Version](https://img.shields.io/badge/node-10.x-green)