@libp2p/webtransport 4.0.19-e1c01370b → 4.0.19-f0d2b52d0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ # @libp2p/webtransport
2
+
1
3
  [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
2
4
  [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
3
5
  [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,8 +9,29 @@
7
9
 
8
10
  # About
9
11
 
12
+ <!--
13
+
14
+ !IMPORTANT!
15
+
16
+ Everything in this README between "# About" and "# Install" is automatically
17
+ generated and will be overwritten the next time the doc generator is run.
18
+
19
+ To make changes to this section, please update the @packageDocumentation section
20
+ of src/index.js or src/index.ts
21
+
22
+ To experiment with formatting, please run "npm run docs" from the root of this
23
+ repo and examine the changes made.
24
+
25
+ -->
26
+
10
27
  A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on [WebTransport](https://www.w3.org/TR/webtransport/).
11
28
 
29
+ > ⚠️ **Note**
30
+ >
31
+ > This WebTransport implementation currently only allows dialing to other nodes. It does not yet allow listening for incoming dials. This feature requires QUIC support to land in Node JS first.
32
+ >
33
+ > QUIC support in Node JS is actively being worked on. You can keep an eye on the progress by watching the [related issues on the Node JS issue tracker](https://github.com/nodejs/node/labels/quic)
34
+
12
35
  ## Example
13
36
 
14
37
  ```TypeScript
@@ -13,12 +13,12 @@
13
13
  *
14
14
  * @example
15
15
  *
16
- * ```js
17
- * import { createLibp2pNode } from 'libp2p'
16
+ * ```TypeScript
17
+ * import { createLibp2p } from 'libp2p'
18
18
  * import { webTransport } from '@libp2p/webtransport'
19
- * import { noise } from 'libp2p-noise'
19
+ * import { noise } from '@chainsafe/libp2p-noise'
20
20
  *
21
- * const node = await createLibp2pNode({
21
+ * const node = await createLibp2p({
22
22
  * transports: [
23
23
  * webTransport()
24
24
  * ],
package/dist/src/index.js CHANGED
@@ -13,12 +13,12 @@
13
13
  *
14
14
  * @example
15
15
  *
16
- * ```js
17
- * import { createLibp2pNode } from 'libp2p'
16
+ * ```TypeScript
17
+ * import { createLibp2p } from 'libp2p'
18
18
  * import { webTransport } from '@libp2p/webtransport'
19
- * import { noise } from 'libp2p-noise'
19
+ * import { noise } from '@chainsafe/libp2p-noise'
20
20
  *
21
- * const node = await createLibp2pNode({
21
+ * const node = await createLibp2p({
22
22
  * transports: [
23
23
  * webTransport()
24
24
  * ],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/webtransport",
3
- "version": "4.0.19-e1c01370b",
3
+ "version": "4.0.19-f0d2b52d0",
4
4
  "description": "JavaScript implementation of the WebTransport module that libp2p uses and that implements the interface-transport spec",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport#readme",
@@ -43,6 +43,7 @@
43
43
  "clean": "aegir clean",
44
44
  "lint": "aegir lint",
45
45
  "dep-check": "aegir dep-check",
46
+ "doc-check": "aegir doc-check",
46
47
  "build": "aegir build",
47
48
  "test": "aegir test -t browser -t webworker",
48
49
  "test:chrome": "aegir test -t browser --cov",
@@ -50,20 +51,20 @@
50
51
  },
51
52
  "dependencies": {
52
53
  "@chainsafe/libp2p-noise": "^15.0.0",
53
- "@libp2p/interface": "1.1.3-e1c01370b",
54
- "@libp2p/peer-id": "4.0.6-e1c01370b",
54
+ "@libp2p/interface": "1.1.3-f0d2b52d0",
55
+ "@libp2p/peer-id": "4.0.6-f0d2b52d0",
55
56
  "@multiformats/multiaddr": "^12.1.14",
56
57
  "@multiformats/multiaddr-matcher": "^1.1.2",
57
58
  "it-stream-types": "^2.0.1",
58
- "multiformats": "^13.0.1",
59
+ "multiformats": "^13.1.0",
59
60
  "uint8arraylist": "^2.4.8",
60
- "uint8arrays": "^5.0.1"
61
+ "uint8arrays": "^5.0.2"
61
62
  },
62
63
  "devDependencies": {
63
- "@libp2p/logger": "4.0.6-e1c01370b",
64
- "@libp2p/peer-id-factory": "4.0.6-e1c01370b",
65
- "aegir": "^42.2.3",
66
- "libp2p": "1.2.3-e1c01370b",
64
+ "@libp2p/logger": "4.0.6-f0d2b52d0",
65
+ "@libp2p/peer-id-factory": "4.0.6-f0d2b52d0",
66
+ "aegir": "^42.2.4",
67
+ "libp2p": "1.2.3-f0d2b52d0",
67
68
  "p-defer": "^4.0.0"
68
69
  },
69
70
  "browser": {
package/src/index.ts CHANGED
@@ -13,12 +13,12 @@
13
13
  *
14
14
  * @example
15
15
  *
16
- * ```js
17
- * import { createLibp2pNode } from 'libp2p'
16
+ * ```TypeScript
17
+ * import { createLibp2p } from 'libp2p'
18
18
  * import { webTransport } from '@libp2p/webtransport'
19
- * import { noise } from 'libp2p-noise'
19
+ * import { noise } from '@chainsafe/libp2p-noise'
20
20
  *
21
- * const node = await createLibp2pNode({
21
+ * const node = await createLibp2p({
22
22
  * transports: [
23
23
  * webTransport()
24
24
  * ],