feat!: streams as EventTargets (#3218)

- Converts streams from streaming iterables (e.g. `{ source, sink }`) to `EventTarget`s that have a `send` method and emit `message` events.
- Consolidates:
  - Stream reading/writing/closing into `AbstractMessageStream`
  - MultiaddrConnection reading/writing/closing into `AbstractMultiaddrConnection`
  - Stream multiplexing into `AbstractStreamMultiplexer`

Fixes #3226

BREAKING CHANGE:
  - Streams are now EventTargets, not streaming iterables
  - Stream handlers accept `stream, connection`, not `{ stream, connection }`

Author: achingbrain

.github/dictionary.txt

@@ -14,6 +14,12 @@ additionals
 SECG
 Certicom
 RSAES
+dialback
+chacha
+peerStore
+xxhandshake
+zerolen
+connmanager
 reprovide
 reprovider
 reproviding

interop/node-version.json

@@ -9,8 +9,7 @@
       "onlyDial": true
     },
     "webrtc",
-    "webrtc-direct",
-    "quic-v1"
+    "webrtc-direct"
   ],
   "secureChannels": ["noise", "tls"],
   "muxers": ["yamux", "mplex"]

interop/package.json

@@ -11,9 +11,8 @@
     "dep-check": "aegir dep-check"
   },
   "devDependencies": {
-    "@chainsafe/libp2p-noise": "^16.1.3",
-    "@chainsafe/libp2p-quic": "^1.1.1",
-    "@chainsafe/libp2p-yamux": "^7.0.1",
+    "@libp2p/noise": "^16.1.3",
+    "@libp2p/yamux": "^7.0.1",
     "@libp2p/circuit-relay-v2": "^3.2.14",
     "@libp2p/identify": "^3.0.32",
     "@libp2p/interface": "^2.10.2",

interop/test/dialer.spec.ts

@@ -5,7 +5,7 @@ import { multiaddr } from '@multiformats/multiaddr'
 import { getLibp2p } from './fixtures/get-libp2p.js'
 import { redisProxy } from './fixtures/redis-proxy.js'
 import type { Libp2p } from '@libp2p/interface'
-import type { PingService } from '@libp2p/ping'
+import type { Ping } from '@libp2p/ping'
 
 const isDialer: boolean = process.env.is_dialer === 'true'
 const timeoutMs: number = parseInt(process.env.test_timeout_secs ?? '180') * 1000
@@ -17,7 +17,7 @@ describe('ping test (dialer)', function () {
 
   // make the default timeout longer than the listener timeout
   this.timeout(timeoutMs + 30_000)
-  let node: Libp2p<{ ping: PingService }>
+  let node: Libp2p<{ ping: Ping }>
 
   beforeEach(async () => {
     node = await getLibp2p()

interop/test/fixtures/get-libp2p.ts

@@ -1,17 +1,17 @@
 /* eslint-disable complexity */
 
-import { noise } from '@chainsafe/libp2p-noise'
-import { quic } from '@chainsafe/libp2p-quic'
-import { yamux } from '@chainsafe/libp2p-yamux'
+// import { quic } from '@chainsafe/libp2p-quic'
 import { circuitRelayTransport } from '@libp2p/circuit-relay-v2'
 import { identify } from '@libp2p/identify'
 import { mplex } from '@libp2p/mplex'
+import { noise } from '@libp2p/noise'
 import { ping } from '@libp2p/ping'
 import { tcp } from '@libp2p/tcp'
 import { tls } from '@libp2p/tls'
 import { webRTC, webRTCDirect } from '@libp2p/webrtc'
 import { webSockets } from '@libp2p/websockets'
 import { webTransport } from '@libp2p/webtransport'
+import { yamux } from '@libp2p/yamux'
 import { createLibp2p } from 'libp2p'
 import type { Identify } from '@libp2p/identify'
 import type { Libp2p } from '@libp2p/interface'
@@ -83,12 +83,13 @@ export async function getLibp2p (): Promise<Libp2p<{ ping: PingService }>> {
         listen: isDialer ? [] : [`/ip4/${IP}/tcp/0/wss`]
       }
       break
-    case 'quic-v1':
-      options.transports = [quic()]
-      options.addresses = {
-        listen: isDialer ? [] : [`/ip4/${IP}/udp/0/quic-v1`]
-      }
-      break
+    // TODO: re-enable quic after v3 release
+    // case 'quic-v1':
+    //   options.transports = [quic()]
+    //   options.addresses = {
+    //     listen: isDialer ? [] : [`/ip4/${IP}/udp/0/quic-v1`]
+    //   }
+    //   break
     default:
       throw new Error(`Unknown transport: ${TRANSPORT ?? '???'}`)
   }
@@ -98,7 +99,8 @@ export async function getLibp2p (): Promise<Libp2p<{ ping: PingService }>> {
   switch (TRANSPORT) {
     case 'webtransport':
     case 'webrtc-direct':
-    case 'quic-v1':
+    // TODO: re-enable quic after v3 release
+    // case 'quic-v1':
       skipSecureChannel = true
       skipMuxer = true
       break
@@ -122,7 +124,7 @@ export async function getLibp2p (): Promise<Libp2p<{ ping: PingService }>> {
         options.connectionEncrypters = [tls()]
         break
       default:
-        throw new Error(`Unknown secure channel: ${SECURE_CHANNEL ?? ''}`)
+        throw new Error(`Unknown secure channel: ${SECURE_CHANNEL ?? ''} for transport ${TRANSPORT ?? ''}`)
     }
   }
 

interop/test/fixtures/relay.ts

@@ -1,8 +1,8 @@
-import { noise } from '@chainsafe/libp2p-noise'
-import { yamux } from '@chainsafe/libp2p-yamux'
 import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
 import { identify } from '@libp2p/identify'
+import { noise } from '@libp2p/noise'
 import { webSockets } from '@libp2p/websockets'
+import { yamux } from '@libp2p/yamux'
 import { createLibp2p } from 'libp2p'
 import type { Libp2p } from '@libp2p/interface'
 

interop/test/listener.spec.ts

@@ -5,7 +5,7 @@ import { multiaddr } from '@multiformats/multiaddr'
 import { getLibp2p } from './fixtures/get-libp2p.js'
 import { redisProxy } from './fixtures/redis-proxy.js'
 import type { Libp2p } from '@libp2p/interface'
-import type { PingService } from '@libp2p/ping'
+import type { Ping } from '@libp2p/ping'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
 const isDialer: boolean = process.env.is_dialer === 'true'
@@ -18,7 +18,7 @@ describe('ping test (listener)', function () {
 
   // make the default timeout longer than the listener timeout
   this.timeout(timeoutMs + 30_000)
-  let node: Libp2p<{ ping: PingService }>
+  let node: Libp2p<{ ping: Ping }>
 
   beforeEach(async () => {
     node = await getLibp2p()

packages/connection-encrypter-noise/.aegir.js

@@ -0,0 +1,7 @@
+
+/** @type {import('aegir').PartialOptions} */
+export default {
+  docs: {
+    entryPoint: "src/index.ts"
+  }
+}

packages/connection-encrypter-noise/README.md

@@ -0,0 +1,95 @@
+# @chainsafe/libp2p-noise
+
+![npm](https://img.shields.io/npm/v/@chainsafe/libp2p-noise)
+[![](https://img.shields.io/github/actions/workflow/status/ChainSafe/js-libp2p-noise/js-test-and-release.yml?branch=master)](https://github.com/ChainSafe/js-libp2p-noise/actions)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/)
+![](https://img.shields.io/github/issues-raw/ChainSafe/js-libp2p-noise)
+[![License Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![](https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D16.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/browsers-last%202%20versions%2C%20not%20ie%20%3C%3D11-orange)
+[![Twitter](https://img.shields.io/twitter/follow/ChainSafeth.svg?label=Twitter)](https://twitter.com/ChainSafeth)
+[![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord\&logo=discord)](https://discord.gg/Q6A3YA2)
+
+> Noise libp2p handshake for js-libp2p
+
+# About
+
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.
+
+## Usage
+
+Install with `yarn add @chainsafe/libp2p-noise` or `npm i @chainsafe/libp2p-noise`.
+
+Example of using default noise configuration and passing it to the libp2p config:
+
+```ts
+import {createLibp2p} from "libp2p"
+import {noise} from "@libp2p/noise"
+
+//custom noise configuration, pass it instead of `noise()`
+//x25519 private key
+const n = noise({ staticNoiseKey });
+
+const libp2p = await createLibp2p({
+  connectionEncrypters: [noise()],
+  //... other options
+})
+```
+
+See the [NoiseInit](https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/noise.ts#L22-L30) interface for noise configuration options.
+
+## API
+
+This module exposes an implementation of the [ConnectionEncrypter](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ConnectionEncrypter.html) interface.
+
+## Bring your own crypto
+
+You can provide a custom crypto implementation (instead of the default, based on [@noble](https://paulmillr.com/noble/)) by adding a `crypto` field to the init argument passed to the `Noise` factory.
+
+The implementation must conform to the `ICryptoInterface`, defined in <https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/crypto.ts>
+
+# Install
+
+```console
+$ npm i @chainsafe/libp2p-noise
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make its exports available as `ChainsafeLibp2pNoise` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@chainsafe/libp2p-noise/dist/index.min.js"></script>
+```
+
+# API Docs
+
+- <https://ChainSafe.github.io/js-libp2p-noise>
+
+# License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+# Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.