@libp2p/websockets 8.0.15 → 8.0.16-2122a713d
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 +31 -20
- package/dist/src/index.d.ts +14 -20
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +14 -20
- package/dist/src/index.js.map +1 -1
- package/package.json +8 -7
- package/src/index.ts +14 -20
- package/dist/typedoc-urls.json +0 -16
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# @libp2p/websockets
|
|
2
|
+
|
|
1
3
|
[](http://libp2p.io/)
|
|
2
4
|
[](https://discuss.libp2p.io)
|
|
3
5
|
[](https://codecov.io/gh/libp2p/js-libp2p)
|
|
@@ -7,13 +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 [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API).
|
|
11
28
|
|
|
12
29
|
## Example
|
|
13
30
|
|
|
14
|
-
```
|
|
15
|
-
import {
|
|
16
|
-
import { webSockets } from '@libp2p/
|
|
31
|
+
```TypeScript
|
|
32
|
+
import { createLibp2p } from 'libp2p'
|
|
33
|
+
import { webSockets } from '@libp2p/websockets'
|
|
34
|
+
import { multiaddr } from '@multiformats/multiaddr'
|
|
17
35
|
|
|
18
36
|
const node = await createLibp2p({
|
|
19
37
|
transports: [
|
|
@@ -22,7 +40,9 @@ const node = await createLibp2p({
|
|
|
22
40
|
//... other config
|
|
23
41
|
})
|
|
24
42
|
await node.start()
|
|
25
|
-
|
|
43
|
+
|
|
44
|
+
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
|
|
45
|
+
await node.dial(ma)
|
|
26
46
|
```
|
|
27
47
|
|
|
28
48
|
## Filters
|
|
@@ -42,28 +62,19 @@ The available filters are:
|
|
|
42
62
|
- `filters.dnsWsOrWss`
|
|
43
63
|
- Returns all DNS based addresses, both with `ws` or `wss`.
|
|
44
64
|
|
|
45
|
-
## Example
|
|
65
|
+
## Example - Allow dialing insecure WebSockets
|
|
46
66
|
|
|
47
|
-
```
|
|
48
|
-
import {
|
|
49
|
-
import {
|
|
67
|
+
```TypeScript
|
|
68
|
+
import { createLibp2p } from 'libp2p'
|
|
69
|
+
import { webSockets } from '@libp2p/websockets'
|
|
50
70
|
import filters from '@libp2p/websockets/filters'
|
|
51
|
-
import { mplex } from '@libp2p/mplex'
|
|
52
|
-
import { noise } from '@libp2p/noise'
|
|
53
71
|
|
|
54
|
-
const
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
websockets({
|
|
72
|
+
const node = await createLibp2p({
|
|
73
|
+
transports: [
|
|
74
|
+
webSockets({
|
|
58
75
|
// connect to all sockets, even insecure ones
|
|
59
76
|
filter: filters.all
|
|
60
77
|
})
|
|
61
|
-
],
|
|
62
|
-
streamMuxers: [
|
|
63
|
-
mplex()
|
|
64
|
-
],
|
|
65
|
-
connectionEncryption: [
|
|
66
|
-
noise()
|
|
67
78
|
]
|
|
68
79
|
})
|
|
69
80
|
```
|
package/dist/src/index.d.ts
CHANGED
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
*
|
|
6
6
|
* @example
|
|
7
7
|
*
|
|
8
|
-
* ```
|
|
9
|
-
* import {
|
|
10
|
-
* import { webSockets } from '@libp2p/
|
|
8
|
+
* ```TypeScript
|
|
9
|
+
* import { createLibp2p } from 'libp2p'
|
|
10
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
11
|
+
* import { multiaddr } from '@multiformats/multiaddr'
|
|
11
12
|
*
|
|
12
13
|
* const node = await createLibp2p({
|
|
13
14
|
* transports: [
|
|
@@ -16,7 +17,9 @@
|
|
|
16
17
|
* //... other config
|
|
17
18
|
* })
|
|
18
19
|
* await node.start()
|
|
19
|
-
*
|
|
20
|
+
*
|
|
21
|
+
* const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
|
|
22
|
+
* await node.dial(ma)
|
|
20
23
|
* ```
|
|
21
24
|
*
|
|
22
25
|
* ## Filters
|
|
@@ -36,28 +39,19 @@
|
|
|
36
39
|
* - `filters.dnsWsOrWss`
|
|
37
40
|
* - Returns all DNS based addresses, both with `ws` or `wss`.
|
|
38
41
|
*
|
|
39
|
-
* @example
|
|
42
|
+
* @example Allow dialing insecure WebSockets
|
|
40
43
|
*
|
|
41
|
-
* ```
|
|
42
|
-
* import {
|
|
43
|
-
* import {
|
|
44
|
+
* ```TypeScript
|
|
45
|
+
* import { createLibp2p } from 'libp2p'
|
|
46
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
44
47
|
* import filters from '@libp2p/websockets/filters'
|
|
45
|
-
* import { mplex } from '@libp2p/mplex'
|
|
46
|
-
* import { noise } from '@libp2p/noise'
|
|
47
48
|
*
|
|
48
|
-
* const
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* websockets({
|
|
49
|
+
* const node = await createLibp2p({
|
|
50
|
+
* transports: [
|
|
51
|
+
* webSockets({
|
|
52
52
|
* // connect to all sockets, even insecure ones
|
|
53
53
|
* filter: filters.all
|
|
54
54
|
* })
|
|
55
|
-
* ],
|
|
56
|
-
* streamMuxers: [
|
|
57
|
-
* mplex()
|
|
58
|
-
* ],
|
|
59
|
-
* connectionEncryption: [
|
|
60
|
-
* noise()
|
|
61
55
|
* ]
|
|
62
56
|
* })
|
|
63
57
|
* ```
|
package/dist/src/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;;AAGH,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,eAAe,EAAgF,KAAK,YAAY,EAAE,KAAK,eAAe,EAAgC,MAAM,mBAAmB,CAAA;AAE7N,OAAO,EAAW,KAAK,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAO7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAElC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,IAAI,CAAA;AAEvC,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,gBAAgB;IACpE,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,eAAe,CAAA;CACxB;AA0HD,wBAAgB,UAAU,CAAE,IAAI,GAAE,cAAmB,GAAG,CAAC,UAAU,EAAE,oBAAoB,KAAK,SAAS,CAItG"}
|
package/dist/src/index.js
CHANGED
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
*
|
|
6
6
|
* @example
|
|
7
7
|
*
|
|
8
|
-
* ```
|
|
9
|
-
* import {
|
|
10
|
-
* import { webSockets } from '@libp2p/
|
|
8
|
+
* ```TypeScript
|
|
9
|
+
* import { createLibp2p } from 'libp2p'
|
|
10
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
11
|
+
* import { multiaddr } from '@multiformats/multiaddr'
|
|
11
12
|
*
|
|
12
13
|
* const node = await createLibp2p({
|
|
13
14
|
* transports: [
|
|
@@ -16,7 +17,9 @@
|
|
|
16
17
|
* //... other config
|
|
17
18
|
* })
|
|
18
19
|
* await node.start()
|
|
19
|
-
*
|
|
20
|
+
*
|
|
21
|
+
* const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
|
|
22
|
+
* await node.dial(ma)
|
|
20
23
|
* ```
|
|
21
24
|
*
|
|
22
25
|
* ## Filters
|
|
@@ -36,28 +39,19 @@
|
|
|
36
39
|
* - `filters.dnsWsOrWss`
|
|
37
40
|
* - Returns all DNS based addresses, both with `ws` or `wss`.
|
|
38
41
|
*
|
|
39
|
-
* @example
|
|
42
|
+
* @example Allow dialing insecure WebSockets
|
|
40
43
|
*
|
|
41
|
-
* ```
|
|
42
|
-
* import {
|
|
43
|
-
* import {
|
|
44
|
+
* ```TypeScript
|
|
45
|
+
* import { createLibp2p } from 'libp2p'
|
|
46
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
44
47
|
* import filters from '@libp2p/websockets/filters'
|
|
45
|
-
* import { mplex } from '@libp2p/mplex'
|
|
46
|
-
* import { noise } from '@libp2p/noise'
|
|
47
48
|
*
|
|
48
|
-
* const
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* websockets({
|
|
49
|
+
* const node = await createLibp2p({
|
|
50
|
+
* transports: [
|
|
51
|
+
* webSockets({
|
|
52
52
|
* // connect to all sockets, even insecure ones
|
|
53
53
|
* filter: filters.all
|
|
54
54
|
* })
|
|
55
|
-
* ],
|
|
56
|
-
* streamMuxers: [
|
|
57
|
-
* mplex()
|
|
58
|
-
* ],
|
|
59
|
-
* connectionEncryption: [
|
|
60
|
-
* noise()
|
|
61
55
|
* ]
|
|
62
56
|
* })
|
|
63
57
|
* ```
|
package/dist/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAwC,eAAe,EAAsI,MAAM,mBAAmB,CAAA;AAC7N,OAAO,EAAE,cAAc,IAAI,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,EAAE,OAAO,EAAyB,MAAM,cAAc,CAAA;AAC7D,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAgBpD,MAAM,UAAU;IACG,GAAG,CAAQ;IACX,IAAI,CAAiB;IACrB,MAAM,CAAiB;IAExC,YAAa,UAAgC,EAAE,IAAqB;QAClE,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAA;QAC9D,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAEQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,oBAAoB,CAAA;IAE3C,CAAC,eAAe,CAAC,GAAG,IAAI,CAAA;IAEjC,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,OAAoB;QAC7C,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QAC1B,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAEzD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAC9D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,EAAa,EAAE,OAAqB;QAClD,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE,CAAC;YACtC,MAAM,IAAI,UAAU,EAAE,CAAA;QACxB,CAAC;QACD,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;QAC5B,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAEjD,MAAM,YAAY,GAAG,MAAM,EAAE,CAAA;QAC7B,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAC/C,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YAC9C,oEAAoE;YACpE,kCAAkC;YAClC,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,wBAAwB,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,uBAAuB,CAAC,CAAA;YAC3F,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAA;YACxC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QAEF,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;YAEjE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YAC5B,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,wCAAwC;QACxC,IAAI,OAAO,CAAA;QACX,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,OAAO,GAAG,GAAG,EAAE;gBACb,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;gBACxB,SAAS,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;gBACjD,CAAC,CAAC,CAAA;YACJ,CAAC,CAAA;YAED,mBAAmB;YACnB,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE,CAAC;gBACtC,OAAO,EAAE,CAAC;gBAAC,OAAM;YACnB,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;QAC1E,CAAC;gBAAS,CAAC;YACT,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YACxD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;QAC5B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAE,OAA8B;QAC5C,OAAO,cAAc,CAAC;YACpB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,EAAE;YACD,GAAG,IAAI,CAAC,IAAI;YACZ,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAE,UAAuB;QAC7B,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QAElE,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACtC,CAAC;QAED,UAAU;QACV,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAChC,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;CACF;AAED,MAAM,UAAU,UAAU,CAAE,OAAuB,EAAE;IACnD,OAAO,CAAC,UAAU,EAAE,EAAE;QACpB,OAAO,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IACzC,CAAC,CAAA;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/websockets",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.16-2122a713d",
|
|
4
4
|
"description": "JavaScript implementation of the WebSockets 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-websockets#readme",
|
|
@@ -63,6 +63,7 @@
|
|
|
63
63
|
"clean": "aegir clean",
|
|
64
64
|
"lint": "aegir lint",
|
|
65
65
|
"dep-check": "aegir dep-check",
|
|
66
|
+
"doc-check": "aegir doc-check",
|
|
66
67
|
"build": "aegir build",
|
|
67
68
|
"test": "aegir test",
|
|
68
69
|
"test:chrome": "aegir test -t browser -f ./dist/test/browser.js --cov",
|
|
@@ -73,8 +74,8 @@
|
|
|
73
74
|
"test:electron-main": "aegir test -t electron-main -f ./dist/test/node.js --cov"
|
|
74
75
|
},
|
|
75
76
|
"dependencies": {
|
|
76
|
-
"@libp2p/interface": "
|
|
77
|
-
"@libp2p/utils": "
|
|
77
|
+
"@libp2p/interface": "1.1.4-2122a713d",
|
|
78
|
+
"@libp2p/utils": "5.2.6-2122a713d",
|
|
78
79
|
"@multiformats/mafmt": "^12.1.6",
|
|
79
80
|
"@multiformats/multiaddr": "^12.1.14",
|
|
80
81
|
"@multiformats/multiaddr-to-uri": "^10.0.1",
|
|
@@ -85,9 +86,9 @@
|
|
|
85
86
|
"ws": "^8.16.0"
|
|
86
87
|
},
|
|
87
88
|
"devDependencies": {
|
|
88
|
-
"@libp2p/interface-compliance-tests": "
|
|
89
|
-
"@libp2p/logger": "
|
|
90
|
-
"aegir": "^42.2.
|
|
89
|
+
"@libp2p/interface-compliance-tests": "5.3.2-2122a713d",
|
|
90
|
+
"@libp2p/logger": "4.0.7-2122a713d",
|
|
91
|
+
"aegir": "^42.2.4",
|
|
91
92
|
"is-loopback-addr": "^2.0.2",
|
|
92
93
|
"it-all": "^3.0.4",
|
|
93
94
|
"it-drain": "^3.0.5",
|
|
@@ -96,7 +97,7 @@
|
|
|
96
97
|
"it-stream-types": "^2.0.1",
|
|
97
98
|
"p-wait-for": "^5.0.2",
|
|
98
99
|
"uint8arraylist": "^2.4.8",
|
|
99
|
-
"uint8arrays": "^5.0.
|
|
100
|
+
"uint8arrays": "^5.0.2"
|
|
100
101
|
},
|
|
101
102
|
"browser": {
|
|
102
103
|
"./dist/src/listener.js": "./dist/src/listener.browser.js"
|
package/src/index.ts
CHANGED
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
*
|
|
6
6
|
* @example
|
|
7
7
|
*
|
|
8
|
-
* ```
|
|
9
|
-
* import {
|
|
10
|
-
* import { webSockets } from '@libp2p/
|
|
8
|
+
* ```TypeScript
|
|
9
|
+
* import { createLibp2p } from 'libp2p'
|
|
10
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
11
|
+
* import { multiaddr } from '@multiformats/multiaddr'
|
|
11
12
|
*
|
|
12
13
|
* const node = await createLibp2p({
|
|
13
14
|
* transports: [
|
|
@@ -16,7 +17,9 @@
|
|
|
16
17
|
* //... other config
|
|
17
18
|
* })
|
|
18
19
|
* await node.start()
|
|
19
|
-
*
|
|
20
|
+
*
|
|
21
|
+
* const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
|
|
22
|
+
* await node.dial(ma)
|
|
20
23
|
* ```
|
|
21
24
|
*
|
|
22
25
|
* ## Filters
|
|
@@ -36,28 +39,19 @@
|
|
|
36
39
|
* - `filters.dnsWsOrWss`
|
|
37
40
|
* - Returns all DNS based addresses, both with `ws` or `wss`.
|
|
38
41
|
*
|
|
39
|
-
* @example
|
|
42
|
+
* @example Allow dialing insecure WebSockets
|
|
40
43
|
*
|
|
41
|
-
* ```
|
|
42
|
-
* import {
|
|
43
|
-
* import {
|
|
44
|
+
* ```TypeScript
|
|
45
|
+
* import { createLibp2p } from 'libp2p'
|
|
46
|
+
* import { webSockets } from '@libp2p/websockets'
|
|
44
47
|
* import filters from '@libp2p/websockets/filters'
|
|
45
|
-
* import { mplex } from '@libp2p/mplex'
|
|
46
|
-
* import { noise } from '@libp2p/noise'
|
|
47
48
|
*
|
|
48
|
-
* const
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* websockets({
|
|
49
|
+
* const node = await createLibp2p({
|
|
50
|
+
* transports: [
|
|
51
|
+
* webSockets({
|
|
52
52
|
* // connect to all sockets, even insecure ones
|
|
53
53
|
* filter: filters.all
|
|
54
54
|
* })
|
|
55
|
-
* ],
|
|
56
|
-
* streamMuxers: [
|
|
57
|
-
* mplex()
|
|
58
|
-
* ],
|
|
59
|
-
* connectionEncryption: [
|
|
60
|
-
* noise()
|
|
61
55
|
* ]
|
|
62
56
|
* })
|
|
63
57
|
* ```
|
package/dist/typedoc-urls.json
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"all": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.all.html",
|
|
3
|
-
"./filters:all": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.all.html",
|
|
4
|
-
"dnsWsOrWss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.dnsWsOrWss.html",
|
|
5
|
-
"./filters:dnsWsOrWss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.dnsWsOrWss.html",
|
|
6
|
-
"dnsWss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.dnsWss.html",
|
|
7
|
-
"./filters:dnsWss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.dnsWss.html",
|
|
8
|
-
"wss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.wss.html",
|
|
9
|
-
"./filters:wss": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.filters.wss.html",
|
|
10
|
-
"WebSocketsComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_websockets.index.WebSocketsComponents.html",
|
|
11
|
-
".:WebSocketsComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_websockets.index.WebSocketsComponents.html",
|
|
12
|
-
"WebSocketsInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_websockets.index.WebSocketsInit.html",
|
|
13
|
-
".:WebSocketsInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_websockets.index.WebSocketsInit.html",
|
|
14
|
-
"webSockets": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.index.webSockets.html",
|
|
15
|
-
".:webSockets": "https://libp2p.github.io/js-libp2p/functions/_libp2p_websockets.index.webSockets.html"
|
|
16
|
-
}
|