Merge branch 'libp2p:main' into feat/track-protocol-stream-open-close-counters

Author: Nkovaturient

.github/workflows/main.yml

@@ -40,6 +40,7 @@ jobs:
       - run: npm run --if-present lint
       - run: npm run --if-present dep-check
       - run: npm run --if-present docs:no-publish
+      - run: git diff --exit-code
       - run: npm run --if-present doc-check
       - run: npm run --if-present spell-check
 

.gitignore

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

.release-please-manifest.json

@@ -1,51 +1,51 @@
 {
-  "packages/config": "1.1.25",
-  "packages/connection-encrypter-plaintext": "3.0.13",
-  "packages/connection-encrypter-tls": "3.0.13",
-  "packages/crypto": "5.1.13",
-  "packages/floodsub": "11.0.14",
-  "packages/gossipsub": "15.0.15",
-  "packages/interface": "3.1.0",
-  "packages/interface-compliance-tests": "7.0.14",
-  "packages/interface-internal": "3.0.13",
-  "packages/interop": "14.0.15",
-  "packages/kad-dht": "16.1.6",
-  "packages/keychain": "6.0.10",
-  "packages/libp2p": "3.1.6",
-  "packages/libp2p-daemon": "6.0.15",
-  "packages/libp2p-daemon-client": "10.0.15",
-  "packages/libp2p-daemon-protocol": "8.0.3",
-  "packages/libp2p-daemon-server": "9.0.15",
-  "packages/logger": "6.2.2",
-  "packages/metrics-opentelemetry": "2.0.14",
-  "packages/metrics-prometheus": "5.0.14",
-  "packages/metrics-simple": "2.0.10",
-  "packages/multistream-select": "7.0.13",
-  "packages/peer-collections": "7.0.13",
-  "packages/peer-discovery-bootstrap": "12.0.14",
-  "packages/peer-discovery-mdns": "12.0.14",
-  "packages/peer-id": "6.0.4",
-  "packages/peer-record": "9.0.5",
-  "packages/peer-store": "12.0.13",
-  "packages/pnet": "3.0.14",
-  "packages/protocol-autonat": "3.0.13",
-  "packages/protocol-autonat-v2": "2.0.13",
-  "packages/protocol-dcutr": "3.0.13",
-  "packages/protocol-echo": "3.0.14",
-  "packages/protocol-fetch": "4.0.13",
-  "packages/protocol-identify": "4.0.13",
-  "packages/protocol-perf": "5.0.14",
-  "packages/protocol-ping": "3.0.13",
-  "packages/record": "4.0.9",
-  "packages/stream-multiplexer-mplex": "12.0.14",
-  "packages/transport-circuit-relay-v2": "4.1.6",
-  "packages/transport-memory": "2.0.13",
-  "packages/transport-tcp": "11.0.13",
-  "packages/transport-webrtc": "6.0.14",
-  "packages/transport-websockets": "10.1.6",
-  "packages/transport-webtransport": "6.0.15",
-  "packages/upnp-nat": "4.0.13",
-  "packages/utils": "7.0.13",
-  "packages/integration-tests": "1.1.6",
-  "interop": "1.0.15"
+  "packages/config": "1.1.26",
+  "packages/connection-encrypter-plaintext": "3.0.14",
+  "packages/connection-encrypter-tls": "3.0.14",
+  "packages/crypto": "5.1.14",
+  "packages/floodsub": "11.0.15",
+  "packages/gossipsub": "15.0.16",
+  "packages/interface": "3.1.1",
+  "packages/interface-compliance-tests": "7.0.15",
+  "packages/interface-internal": "3.0.14",
+  "packages/interop": "14.0.16",
+  "packages/kad-dht": "16.1.7",
+  "packages/keychain": "6.0.11",
+  "packages/libp2p": "3.1.7",
+  "packages/libp2p-daemon": "6.0.16",
+  "packages/libp2p-daemon-client": "10.0.16",
+  "packages/libp2p-daemon-protocol": "8.0.4",
+  "packages/libp2p-daemon-server": "9.0.16",
+  "packages/logger": "6.2.3",
+  "packages/metrics-opentelemetry": "2.0.15",
+  "packages/metrics-prometheus": "5.0.15",
+  "packages/metrics-simple": "2.0.11",
+  "packages/multistream-select": "7.0.14",
+  "packages/peer-collections": "7.0.14",
+  "packages/peer-discovery-bootstrap": "12.0.15",
+  "packages/peer-discovery-mdns": "12.0.15",
+  "packages/peer-id": "6.0.5",
+  "packages/peer-record": "9.0.6",
+  "packages/peer-store": "12.0.14",
+  "packages/pnet": "3.0.15",
+  "packages/protocol-autonat": "3.0.14",
+  "packages/protocol-autonat-v2": "2.0.14",
+  "packages/protocol-dcutr": "3.0.14",
+  "packages/protocol-echo": "3.0.15",
+  "packages/protocol-fetch": "4.0.14",
+  "packages/protocol-identify": "4.0.14",
+  "packages/protocol-perf": "5.0.15",
+  "packages/protocol-ping": "3.0.14",
+  "packages/record": "4.0.10",
+  "packages/stream-multiplexer-mplex": "12.0.15",
+  "packages/transport-circuit-relay-v2": "4.1.7",
+  "packages/transport-memory": "2.0.14",
+  "packages/transport-tcp": "11.0.14",
+  "packages/transport-webrtc": "6.0.15",
+  "packages/transport-websockets": "10.1.7",
+  "packages/transport-webtransport": "6.0.16",
+  "packages/upnp-nat": "4.0.14",
+  "packages/utils": "7.0.14",
+  "packages/integration-tests": "1.1.7",
+  "interop": "1.0.16"
 }

README.md

@@ -36,6 +36,9 @@ We are in the process of writing better documentation, blog posts, tutorials and
 - [docs.libp2p.io](https://docs.libp2p.io)
 - [Specification (WIP)](https://github.com/libp2p/specs)
 - [Discussion Forums](https://discuss.libp2p.io)
+- [ProtoSchool: Introduction to libp2p](https://proto.school/introduction-to-libp2p)
+- [libp2p Connectivity Matrix](https://connectivity.libp2p.io/)
+- [Universal Connectivity Demo](https://github.com/libp2p/universal-connectivity)
 - Talks
   - [`libp2p <3 ethereum` at DEVCON2](https://archive.devcon.org/archive/watch/2/libp2p-devp2p-ipfs-and-ethereum-networking/)
 - Articles
@@ -184,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

@@ -18,6 +18,7 @@ Welcome to libp2p! This guide will walk you through setting up a fully functiona
     - [Browser](#browser)
   - [React Native](#react-native)
   - [What is next](#what-is-next)
+    - [Additional Resources](#additional-resources)
 
 ## Install
 
@@ -54,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
 
@@ -114,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>
 
@@ -153,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'
@@ -329,7 +330,13 @@ Libp2p can be used in React Native applications. However, there are some limitat
 
 There are a lot of other concepts within `libp2p`, that are not covered in this guide. For additional configuration options we recommend checking out the [Configuration Readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md) and the [examples repo](https://github.com/libp2p/js-libp2p-examples). If you have any problems getting started, or if anything isn't clear, please let us know by submitting an issue!
 
+### Additional Resources
 
-[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
+- [ProtoSchool: Introduction to libp2p](https://proto.school/introduction-to-libp2p) — Interactive tutorial covering libp2p fundamentals
+- [libp2p Concepts](https://docs.libp2p.io/concepts/introduction/overview/) — Overview of core concepts and architecture
+- [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/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