@libp2p/websockets 4.0.1 → 5.0.0
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 +29 -32
- package/dist/src/index.d.ts +2 -24
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +6 -1
- package/dist/src/index.js.map +1 -1
- package/package.json +4 -4
- package/src/index.ts +7 -1
package/README.md
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
# @libp2p/websockets <!-- omit in toc -->
|
|
2
2
|
|
|
3
3
|
[](http://libp2p.io/)
|
|
4
|
-
[](http://webchat.freenode.net/?channels=%23libp2p)
|
|
5
4
|
[](https://discuss.libp2p.io)
|
|
6
5
|
[](https://codecov.io/gh/libp2p/js-libp2p-websockets)
|
|
7
|
-
[](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml)
|
|
8
7
|
|
|
9
8
|
> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec
|
|
10
9
|
|
|
11
10
|
## Table of contents <!-- omit in toc -->
|
|
12
11
|
|
|
13
12
|
- [Install](#install)
|
|
14
|
-
- [Description](#description)
|
|
15
13
|
- [Usage](#usage)
|
|
16
14
|
- [Constructor properties](#constructor-properties)
|
|
17
15
|
- [Libp2p Usage Example](#libp2p-usage-example)
|
|
@@ -30,10 +28,6 @@ $ npm i @libp2p/websockets
|
|
|
30
28
|
[](https://github.com/libp2p/interface-transport)
|
|
31
29
|
[](https://github.com/libp2p/interface-connection)
|
|
32
30
|
|
|
33
|
-
## Description
|
|
34
|
-
|
|
35
|
-
`libp2p-websockets` is the WebSockets implementation compatible with libp2p.
|
|
36
|
-
|
|
37
31
|
## Usage
|
|
38
32
|
|
|
39
33
|
```sh
|
|
@@ -43,14 +37,17 @@ $ npm i @libp2p/websockets
|
|
|
43
37
|
### Constructor properties
|
|
44
38
|
|
|
45
39
|
```js
|
|
46
|
-
import {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
40
|
+
import { createLibp2pNode } from 'libp2p'
|
|
41
|
+
import { webSockets } from '@libp2p/webrtc-direct'
|
|
42
|
+
|
|
43
|
+
const node = await createLibp2p({
|
|
44
|
+
transports: [
|
|
45
|
+
webSockets()
|
|
46
|
+
]
|
|
47
|
+
//... other config
|
|
48
|
+
})
|
|
49
|
+
await node.start()
|
|
50
|
+
await node.dial('/ip4/127.0.0.1/tcp/9090/ws')
|
|
54
51
|
```
|
|
55
52
|
|
|
56
53
|
| Name | Type | Description | Default |
|
|
@@ -72,26 +69,26 @@ The available filters are:
|
|
|
72
69
|
## Libp2p Usage Example
|
|
73
70
|
|
|
74
71
|
```js
|
|
75
|
-
import
|
|
76
|
-
import {
|
|
77
|
-
import filters from 'libp2p
|
|
78
|
-
import {
|
|
79
|
-
import {
|
|
72
|
+
import { createLibp2pNode } from 'libp2p'
|
|
73
|
+
import { websockets } from '@libp2p/websockets'
|
|
74
|
+
import filters from '@libp2p/websockets/filters'
|
|
75
|
+
import { mplex } from '@libp2p/mplex'
|
|
76
|
+
import { noise } from '@libp2p/noise'
|
|
80
77
|
|
|
81
78
|
const transportKey = Websockets.prototype[Symbol.toStringTag]
|
|
82
79
|
const node = await Libp2p.create({
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
80
|
+
transport: [
|
|
81
|
+
websockets({
|
|
82
|
+
// connect to all sockets, even insecure ones
|
|
83
|
+
filters: filters.all
|
|
84
|
+
})
|
|
85
|
+
],
|
|
86
|
+
streamMuxers: [
|
|
87
|
+
mplex()
|
|
88
|
+
],
|
|
89
|
+
connectionEncryption: [
|
|
90
|
+
noise()
|
|
91
|
+
]
|
|
95
92
|
})
|
|
96
93
|
```
|
|
97
94
|
|
package/dist/src/index.d.ts
CHANGED
|
@@ -1,10 +1,7 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { WebSocketOptions } from 'it-ws/client';
|
|
3
|
-
import { Transport, MultiaddrFilter
|
|
4
|
-
import type { Connection } from '@libp2p/interface-connection';
|
|
3
|
+
import { Transport, MultiaddrFilter } from '@libp2p/interface-transport';
|
|
5
4
|
import type { AbortOptions } from '@libp2p/interfaces';
|
|
6
|
-
import type { Multiaddr } from '@multiformats/multiaddr';
|
|
7
|
-
import type { DuplexWebSocket } from 'it-ws/duplex';
|
|
8
5
|
import type { ClientOptions } from 'ws';
|
|
9
6
|
import type { Server } from 'http';
|
|
10
7
|
export interface WebSocketsInit extends AbortOptions, WebSocketOptions {
|
|
@@ -12,24 +9,5 @@ export interface WebSocketsInit extends AbortOptions, WebSocketOptions {
|
|
|
12
9
|
websocket?: ClientOptions;
|
|
13
10
|
server?: Server;
|
|
14
11
|
}
|
|
15
|
-
export declare
|
|
16
|
-
private readonly init?;
|
|
17
|
-
constructor(init?: WebSocketsInit);
|
|
18
|
-
get [Symbol.toStringTag](): string;
|
|
19
|
-
get [symbol](): true;
|
|
20
|
-
dial(ma: Multiaddr, options: DialOptions): Promise<Connection>;
|
|
21
|
-
_connect(ma: Multiaddr, options: AbortOptions): Promise<DuplexWebSocket>;
|
|
22
|
-
/**
|
|
23
|
-
* Creates a Websockets listener. The provided `handler` function will be called
|
|
24
|
-
* anytime a new incoming Connection has been successfully upgraded via
|
|
25
|
-
* `upgrader.upgradeInbound`
|
|
26
|
-
*/
|
|
27
|
-
createListener(options: CreateListenerOptions): import("@libp2p/interface-transport").Listener;
|
|
28
|
-
/**
|
|
29
|
-
* Takes a list of `Multiaddr`s and returns only valid Websockets addresses.
|
|
30
|
-
* By default, in a browser environment only DNS+WSS multiaddr is accepted,
|
|
31
|
-
* while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.
|
|
32
|
-
*/
|
|
33
|
-
filter(multiaddrs: Multiaddr[]): Multiaddr[];
|
|
34
|
-
}
|
|
12
|
+
export declare function webSockets(init?: WebSocketsInit): (components?: any) => Transport;
|
|
35
13
|
//# sourceMappingURL=index.d.ts.map
|
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,OAAO,EAAW,gBAAgB,EAAE,MAAM,cAAc,CAAA;AASxD,OAAO,EAAE,SAAS,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAW,gBAAgB,EAAE,MAAM,cAAc,CAAA;AASxD,OAAO,EAAE,SAAS,EAAE,eAAe,EAA8C,MAAM,6BAA6B,CAAA;AAEpH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,IAAI,CAAA;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAIlC,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;AAuHD,wBAAgB,UAAU,CAAE,IAAI,GAAE,cAAmB,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,KAAK,SAAS,CAItF"}
|
package/dist/src/index.js
CHANGED
|
@@ -9,7 +9,7 @@ import { socketToMaConn } from './socket-to-conn.js';
|
|
|
9
9
|
import * as filters from './filters.js';
|
|
10
10
|
import { symbol } from '@libp2p/interface-transport';
|
|
11
11
|
const log = logger('libp2p:websockets');
|
|
12
|
-
|
|
12
|
+
class WebSockets {
|
|
13
13
|
constructor(init) {
|
|
14
14
|
this.init = init;
|
|
15
15
|
}
|
|
@@ -103,4 +103,9 @@ export class WebSockets {
|
|
|
103
103
|
return filters.all(multiaddrs);
|
|
104
104
|
}
|
|
105
105
|
}
|
|
106
|
+
export function webSockets(init = {}) {
|
|
107
|
+
return () => {
|
|
108
|
+
return new WebSockets(init);
|
|
109
|
+
};
|
|
110
|
+
}
|
|
106
111
|
//# sourceMappingURL=index.js.map
|
package/dist/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,cAAc,IAAI,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,EAA8B,MAAM,EAAsC,MAAM,6BAA6B,CAAA;AAQpH,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAQvC,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,cAAc,IAAI,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AACvC,OAAO,EAA8B,MAAM,EAAsC,MAAM,6BAA6B,CAAA;AAQpH,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAQvC,MAAM,UAAU;IAGd,YAAa,IAAqB;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,oBAAoB,CAAA;IAC7B,CAAC;IAED,IAAI,CAAC,MAAM,CAAC;QACV,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,OAAoB;QAC7C,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QACrB,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,CAAC,CAAA;QACzC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAEpD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAC3D,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,EAAa,EAAE,OAAqB;QAClD,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE;YACrC,MAAM,IAAI,UAAU,EAAE,CAAA;SACvB;QACD,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;QAC5B,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAE5C,MAAM,YAAY,GAAG,MAAM,EAAE,CAAA;QAC7B,MAAM,KAAK,GAAG,CAAC,GAAQ,EAAE,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAA;YAEnC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC1B,CAAC,CAAA;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QAE/C,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,EAAE;YAC/B,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;SACpC;aAAM;YACL,SAAS,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;SACjC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;YAEjE,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YACvB,OAAO,SAAS,CAAA;SACjB;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,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;gBAC5C,CAAC,CAAC,CAAA;YACJ,CAAC,CAAA;YAED,mBAAmB;YACnB,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE;gBACrC,OAAO,OAAO,EAAE,CAAA;aACjB;YAED,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,IAAI;YACF,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;SACzE;gBAAS;YACR,IAAI,OAAO,IAAI,IAAI,EAAE;gBACnB,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;aACvD;SACF;QAED,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAE,OAA8B;QAC5C,OAAO,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IACrD,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;YAC7B,OAAO,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;SACrC;QAED,UAAU;QACV,IAAI,SAAS,IAAI,WAAW,EAAE;YAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;SAClC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;CACF;AAED,MAAM,UAAU,UAAU,CAAE,OAAuB,EAAE;IACnD,OAAO,GAAG,EAAE;QACV,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC,CAAA;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/websockets",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
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-websockets#readme",
|
|
@@ -174,8 +174,8 @@
|
|
|
174
174
|
"wherearewe": "^2.0.1"
|
|
175
175
|
},
|
|
176
176
|
"devDependencies": {
|
|
177
|
-
"@libp2p/interface-mocks": "^
|
|
178
|
-
"@libp2p/interface-transport-compliance-tests": "^
|
|
177
|
+
"@libp2p/interface-mocks": "^7.0.1",
|
|
178
|
+
"@libp2p/interface-transport-compliance-tests": "^3.0.0",
|
|
179
179
|
"@types/ws": "^8.2.2",
|
|
180
180
|
"aegir": "^37.5.3",
|
|
181
181
|
"is-loopback-addr": "^2.0.1",
|
|
@@ -187,7 +187,7 @@
|
|
|
187
187
|
"it-take": "^1.0.2",
|
|
188
188
|
"p-wait-for": "^5.0.0",
|
|
189
189
|
"uint8arraylist": "^2.3.2",
|
|
190
|
-
"uint8arrays": "^
|
|
190
|
+
"uint8arrays": "^4.0.2"
|
|
191
191
|
},
|
|
192
192
|
"browser": {
|
|
193
193
|
"./dist/src/listener.js": "./dist/src/listener.browser.js"
|
package/src/index.ts
CHANGED
|
@@ -23,7 +23,7 @@ export interface WebSocketsInit extends AbortOptions, WebSocketOptions {
|
|
|
23
23
|
server?: Server
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
class WebSockets implements Transport {
|
|
27
27
|
private readonly init?: WebSocketsInit
|
|
28
28
|
|
|
29
29
|
constructor (init?: WebSocketsInit) {
|
|
@@ -139,3 +139,9 @@ export class WebSockets implements Transport {
|
|
|
139
139
|
return filters.all(multiaddrs)
|
|
140
140
|
}
|
|
141
141
|
}
|
|
142
|
+
|
|
143
|
+
export function webSockets (init: WebSocketsInit = {}): (components?: any) => Transport {
|
|
144
|
+
return () => {
|
|
145
|
+
return new WebSockets(init)
|
|
146
|
+
}
|
|
147
|
+
}
|