@waku/core 0.0.33-00c3261.0 → 0.0.33-11bf1c1.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/bundle/{base_protocol-iQ9XIkPz.js → base_protocol-Dzv-QHPR.js} +55 -122
- package/bundle/{index-tdQNdKHx.js → index-BIW3qNYx.js} +19 -450
- package/bundle/index.js +100 -417
- package/bundle/lib/base_protocol.js +2 -2
- package/bundle/lib/message/version_0.js +2 -2
- package/bundle/{version_0-BrbNEwD-.js → version_0-CdmZMfkQ.js} +451 -2
- package/dist/.tsbuildinfo +1 -1
- package/dist/index.d.ts +1 -2
- package/dist/index.js +1 -2
- package/dist/index.js.map +1 -1
- package/dist/lib/base_protocol.d.ts +4 -6
- package/dist/lib/base_protocol.js +10 -14
- package/dist/lib/base_protocol.js.map +1 -1
- package/dist/lib/filter/index.js +2 -2
- package/dist/lib/filter/index.js.map +1 -1
- package/dist/lib/metadata/index.js +1 -1
- package/dist/lib/metadata/index.js.map +1 -1
- package/dist/lib/stream_manager/stream_manager.d.ts +6 -4
- package/dist/lib/stream_manager/stream_manager.js +40 -16
- package/dist/lib/stream_manager/stream_manager.js.map +1 -1
- package/dist/lib/stream_manager/utils.d.ts +1 -1
- package/dist/lib/stream_manager/utils.js +5 -17
- package/dist/lib/stream_manager/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1 -3
- package/src/lib/base_protocol.ts +14 -28
- package/src/lib/filter/index.ts +5 -2
- package/src/lib/metadata/index.ts +1 -1
- package/src/lib/stream_manager/stream_manager.ts +52 -31
- package/src/lib/stream_manager/utils.ts +5 -17
- package/dist/lib/wait_for_remote_peer.d.ts +0 -22
- package/dist/lib/wait_for_remote_peer.js +0 -142
- package/dist/lib/wait_for_remote_peer.js.map +0 -1
- package/src/lib/wait_for_remote_peer.ts +0 -200
@@ -1,9 +1,9 @@
|
|
1
1
|
import type { Peer, Stream } from "@libp2p/interface";
|
2
2
|
import type { Libp2p } from "@waku/interfaces";
|
3
3
|
export declare class StreamManager {
|
4
|
-
multicodec
|
5
|
-
|
6
|
-
|
4
|
+
private multicodec;
|
5
|
+
private getConnections;
|
6
|
+
private addEventListener;
|
7
7
|
private readonly log;
|
8
8
|
private ongoingCreation;
|
9
9
|
private streamPool;
|
@@ -13,5 +13,7 @@ export declare class StreamManager {
|
|
13
13
|
private createStreamWithLock;
|
14
14
|
private handlePeerUpdateStreamPool;
|
15
15
|
private scheduleNewStream;
|
16
|
-
private
|
16
|
+
private getOpenStreamForCodec;
|
17
|
+
private lockStream;
|
18
|
+
private isStreamLocked;
|
17
19
|
}
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Logger } from "@waku/utils";
|
2
|
-
import {
|
3
|
-
const
|
2
|
+
import { selectOpenConnection } from "./utils.js";
|
3
|
+
const STREAM_LOCK_KEY = "consumed";
|
4
4
|
export class StreamManager {
|
5
5
|
multicodec;
|
6
6
|
getConnections;
|
@@ -18,18 +18,23 @@ export class StreamManager {
|
|
18
18
|
async getStream(peer) {
|
19
19
|
const peerId = peer.id.toString();
|
20
20
|
const scheduledStream = this.streamPool.get(peerId);
|
21
|
-
|
22
|
-
|
23
|
-
|
21
|
+
if (scheduledStream) {
|
22
|
+
this.streamPool.delete(peerId);
|
23
|
+
await scheduledStream;
|
24
|
+
}
|
25
|
+
let stream = this.getOpenStreamForCodec(peer.id);
|
24
26
|
if (stream) {
|
25
27
|
this.log.info(`Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
|
28
|
+
this.lockStream(peer.id.toString(), stream);
|
26
29
|
return stream;
|
27
30
|
}
|
28
|
-
|
31
|
+
stream = await this.createStream(peer);
|
32
|
+
this.lockStream(peer.id.toString(), stream);
|
33
|
+
return stream;
|
29
34
|
}
|
30
35
|
async createStream(peer, retries = 0) {
|
31
36
|
const connections = this.getConnections(peer.id);
|
32
|
-
const connection =
|
37
|
+
const connection = selectOpenConnection(connections);
|
33
38
|
if (!connection) {
|
34
39
|
throw new Error(`Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
|
35
40
|
}
|
@@ -40,6 +45,7 @@ export class StreamManager {
|
|
40
45
|
this.log.info(`Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
|
41
46
|
stream = await connection.newStream(this.multicodec);
|
42
47
|
this.log.info(`Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
|
48
|
+
break;
|
43
49
|
}
|
44
50
|
catch (error) {
|
45
51
|
lastError = error;
|
@@ -61,16 +67,20 @@ export class StreamManager {
|
|
61
67
|
this.ongoingCreation.add(peerId);
|
62
68
|
await this.createStream(peer);
|
63
69
|
}
|
70
|
+
catch (error) {
|
71
|
+
this.log.error(`Failed to createStreamWithLock:`, error);
|
72
|
+
}
|
64
73
|
finally {
|
65
74
|
this.ongoingCreation.delete(peerId);
|
66
75
|
}
|
76
|
+
return;
|
67
77
|
}
|
68
78
|
handlePeerUpdateStreamPool = (evt) => {
|
69
79
|
const { peer } = evt.detail;
|
70
80
|
if (!peer.protocols.includes(this.multicodec)) {
|
71
81
|
return;
|
72
82
|
}
|
73
|
-
const stream = this.
|
83
|
+
const stream = this.getOpenStreamForCodec(peer.id);
|
74
84
|
if (stream) {
|
75
85
|
return;
|
76
86
|
}
|
@@ -78,20 +88,34 @@ export class StreamManager {
|
|
78
88
|
};
|
79
89
|
scheduleNewStream(peer) {
|
80
90
|
this.log.info(`Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
|
81
|
-
|
82
|
-
|
83
|
-
this.
|
84
|
-
|
85
|
-
|
86
|
-
this.streamPool.set(peer.id.toString(), streamPromise);
|
91
|
+
// abandon previous attempt
|
92
|
+
if (this.streamPool.has(peer.id.toString())) {
|
93
|
+
this.streamPool.delete(peer.id.toString());
|
94
|
+
}
|
95
|
+
this.streamPool.set(peer.id.toString(), this.createStreamWithLock(peer));
|
87
96
|
}
|
88
|
-
|
89
|
-
const
|
97
|
+
getOpenStreamForCodec(peerId) {
|
98
|
+
const connections = this.getConnections(peerId);
|
99
|
+
const connection = selectOpenConnection(connections);
|
90
100
|
if (!connection) {
|
91
101
|
return;
|
92
102
|
}
|
93
103
|
const stream = connection.streams.find((s) => s.protocol === this.multicodec);
|
104
|
+
if (!stream) {
|
105
|
+
return;
|
106
|
+
}
|
107
|
+
const isStreamUnusable = ["done", "closed", "closing"].includes(stream.writeStatus || "");
|
108
|
+
if (isStreamUnusable || this.isStreamLocked(stream)) {
|
109
|
+
return;
|
110
|
+
}
|
94
111
|
return stream;
|
95
112
|
}
|
113
|
+
lockStream(peerId, stream) {
|
114
|
+
this.log.info(`Locking stream for peerId:${peerId}\tstreamId:${stream.id}`);
|
115
|
+
stream.metadata[STREAM_LOCK_KEY] = true;
|
116
|
+
}
|
117
|
+
isStreamLocked(stream) {
|
118
|
+
return !!stream.metadata[STREAM_LOCK_KEY];
|
119
|
+
}
|
96
120
|
}
|
97
121
|
//# sourceMappingURL=stream_manager.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"stream_manager.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/stream_manager.ts"],"names":[],"mappings":"
|
1
|
+
{"version":3,"file":"stream_manager.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/stream_manager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC,MAAM,OAAO,aAAa;IAOd;IACA;IACA;IARO,GAAG,CAAS;IAErB,eAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,UAAU,GAA+B,IAAI,GAAG,EAAE,CAAC;IAE3D,YACU,UAAkB,EAClB,cAAwC,EACxC,gBAA4C;QAF5C,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAA0B;QACxC,qBAAgB,GAAhB,gBAAgB,CAA4B;QAEpD,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACxE,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,IAAU;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QAElC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEpD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC/B,MAAM,eAAe,CAAC;QACxB,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEjD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,gCAAgC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACnF,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAE5C,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAU,EAAE,OAAO,GAAG,CAAC;QAChD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAErD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,iDAAiD,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACpG,CAAC;QACJ,CAAC;QAED,IAAI,SAAkB,CAAC;QACvB,IAAI,MAA0B,CAAC;QAE/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,4CAA4C,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CAC/F,CAAC;gBACF,MAAM,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,6BAA6B,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CAChF,CAAC;gBACF,MAAM;YACR,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM;gBAC3D,SAAS,CACZ,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,IAAU;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QAElC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wDAAwD,MAAM,eAAe,IAAI,CAAC,UAAU,EAAE,CAC/F,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QAED,OAAO;IACT,CAAC;IAEO,0BAA0B,GAAG,CAAC,GAA4B,EAAQ,EAAE;QAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEnD,IAAI,MAAM,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEM,iBAAiB,CAAC,IAAU;QAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,8CAA8C,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACjG,CAAC;QAEF,2BAA2B;QAC3B,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEO,qBAAqB,CAAC,MAAc;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAErD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,UAAU,CACtC,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAC7D,MAAM,CAAC,WAAW,IAAI,EAAE,CACzB,CAAC;QACF,IAAI,gBAAgB,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YACpD,OAAO;QACT,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,UAAU,CAAC,MAAc,EAAE,MAAc;QAC/C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,MAAM,cAAc,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;IAC1C,CAAC;IAEO,cAAc,CAAC,MAAc;QACnC,OAAO,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC;CACF"}
|
@@ -1,2 +1,2 @@
|
|
1
1
|
import type { Connection } from "@libp2p/interface";
|
2
|
-
export declare function
|
2
|
+
export declare function selectOpenConnection(connections: Connection[]): Connection | undefined;
|
@@ -1,19 +1,7 @@
|
|
1
|
-
export function
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
let latestConnection;
|
7
|
-
connections.forEach((connection) => {
|
8
|
-
if (connection.status === "open") {
|
9
|
-
if (!latestConnection) {
|
10
|
-
latestConnection = connection;
|
11
|
-
}
|
12
|
-
else if (connection.timeline.open > latestConnection.timeline.open) {
|
13
|
-
latestConnection = connection;
|
14
|
-
}
|
15
|
-
}
|
16
|
-
});
|
17
|
-
return latestConnection;
|
1
|
+
export function selectOpenConnection(connections) {
|
2
|
+
return connections
|
3
|
+
.filter((c) => c.status === "open")
|
4
|
+
.sort((left, right) => right.timeline.open - left.timeline.open)
|
5
|
+
.at(0);
|
18
6
|
}
|
19
7
|
//# sourceMappingURL=utils.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,oBAAoB,CAClC,WAAyB;IAEzB,OAAO,WAAW;SACf,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC;SAClC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;SAC/D,EAAE,CAAC,CAAC,CAAC,CAAC;AACX,CAAC"}
|
package/package.json
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"name":"@waku/core","version":"0.0.33-
|
1
|
+
{"name":"@waku/core","version":"0.0.33-11bf1c1.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"dependencies":{"@libp2p/ping":"^1.1.2","@waku/enr":"0.0.27-11bf1c1.0","@waku/interfaces":"0.0.28-11bf1c1.0","@waku/proto":"0.0.9-11bf1c1.0","@waku/utils":"0.0.21-11bf1c1.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","sinon":"^18.0.0","cspell":"^8.6.1","fast-check":"^3.19.0","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.8.1"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"libp2p":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}
|
package/src/index.ts
CHANGED
@@ -13,9 +13,7 @@ export * as waku_light_push from "./lib/light_push/index.js";
|
|
13
13
|
export { LightPushCodec, LightPushCore } from "./lib/light_push/index.js";
|
14
14
|
|
15
15
|
export * as waku_store from "./lib/store/index.js";
|
16
|
-
export { StoreCore } from "./lib/store/index.js";
|
17
|
-
|
18
|
-
export { waitForRemotePeer } from "./lib/wait_for_remote_peer.js";
|
16
|
+
export { StoreCore, StoreCodec } from "./lib/store/index.js";
|
19
17
|
|
20
18
|
export { ConnectionManager } from "./lib/connection_manager.js";
|
21
19
|
|
package/src/lib/base_protocol.ts
CHANGED
@@ -1,16 +1,12 @@
|
|
1
1
|
import type { Libp2p } from "@libp2p/interface";
|
2
|
-
import type { Peer,
|
2
|
+
import type { Peer, Stream } from "@libp2p/interface";
|
3
3
|
import type {
|
4
4
|
IBaseProtocolCore,
|
5
5
|
Libp2pComponents,
|
6
6
|
PubsubTopic
|
7
7
|
} from "@waku/interfaces";
|
8
|
-
import { Logger
|
9
|
-
import {
|
10
|
-
getConnectedPeersForProtocolAndShard,
|
11
|
-
getPeersForProtocol,
|
12
|
-
sortPeersByLatency
|
13
|
-
} from "@waku/utils/libp2p";
|
8
|
+
import { Logger } from "@waku/utils";
|
9
|
+
import { getPeersForProtocol, sortPeersByLatency } from "@waku/utils/libp2p";
|
14
10
|
|
15
11
|
import { filterPeersByDiscovery } from "./filterPeers.js";
|
16
12
|
import { StreamManager } from "./stream_manager/index.js";
|
@@ -26,7 +22,7 @@ export class BaseProtocol implements IBaseProtocolCore {
|
|
26
22
|
|
27
23
|
protected constructor(
|
28
24
|
public multicodec: string,
|
29
|
-
|
25
|
+
protected components: Libp2pComponents,
|
30
26
|
private log: Logger,
|
31
27
|
public readonly pubsubTopics: PubsubTopic[]
|
32
28
|
) {
|
@@ -50,25 +46,22 @@ export class BaseProtocol implements IBaseProtocolCore {
|
|
50
46
|
return this.streamManager.getStream(peer);
|
51
47
|
}
|
52
48
|
|
53
|
-
public get peerStore(): PeerStore {
|
54
|
-
return this.components.peerStore;
|
55
|
-
}
|
56
|
-
|
57
49
|
/**
|
58
50
|
* Returns known peers from the address book (`libp2p.peerStore`) that support
|
59
51
|
* the class protocol. Waku may or may not be currently connected to these
|
60
52
|
* peers.
|
61
53
|
*/
|
62
54
|
public async allPeers(): Promise<Peer[]> {
|
63
|
-
return getPeersForProtocol(this.peerStore, [this.multicodec]);
|
55
|
+
return getPeersForProtocol(this.components.peerStore, [this.multicodec]);
|
64
56
|
}
|
65
57
|
|
66
58
|
public async connectedPeers(): Promise<Peer[]> {
|
67
59
|
const peers = await this.allPeers();
|
68
60
|
return peers.filter((peer) => {
|
69
|
-
|
70
|
-
|
61
|
+
const connections = this.components.connectionManager.getConnections(
|
62
|
+
peer.id
|
71
63
|
);
|
64
|
+
return connections.length > 0;
|
72
65
|
});
|
73
66
|
}
|
74
67
|
|
@@ -77,9 +70,8 @@ export class BaseProtocol implements IBaseProtocolCore {
|
|
77
70
|
*
|
78
71
|
* @param numPeers - The total number of peers to retrieve. If 0, all peers are returned.
|
79
72
|
* @param maxBootstrapPeers - The maximum number of bootstrap peers to retrieve.
|
80
|
-
|
81
|
-
|
82
|
-
*/
|
73
|
+
* @returns A list of peers that support the protocol sorted by latency. By default, returns all peers available, including bootstrap.
|
74
|
+
*/
|
83
75
|
public async getPeers(
|
84
76
|
{
|
85
77
|
numPeers,
|
@@ -88,29 +80,23 @@ export class BaseProtocol implements IBaseProtocolCore {
|
|
88
80
|
numPeers: number;
|
89
81
|
maxBootstrapPeers: number;
|
90
82
|
} = {
|
91
|
-
maxBootstrapPeers:
|
83
|
+
maxBootstrapPeers: 0,
|
92
84
|
numPeers: 0
|
93
85
|
}
|
94
86
|
): Promise<Peer[]> {
|
95
87
|
// Retrieve all connected peers that support the protocol & shard (if configured)
|
96
|
-
const
|
97
|
-
await getConnectedPeersForProtocolAndShard(
|
98
|
-
this.components.connectionManager.getConnections(),
|
99
|
-
this.peerStore,
|
100
|
-
[this.multicodec],
|
101
|
-
pubsubTopicsToShardInfo(this.pubsubTopics)
|
102
|
-
);
|
88
|
+
const allAvailableConnectedPeers = await this.connectedPeers();
|
103
89
|
|
104
90
|
// Filter the peers based on discovery & number of peers requested
|
105
91
|
const filteredPeers = filterPeersByDiscovery(
|
106
|
-
|
92
|
+
allAvailableConnectedPeers,
|
107
93
|
numPeers,
|
108
94
|
maxBootstrapPeers
|
109
95
|
);
|
110
96
|
|
111
97
|
// Sort the peers by latency
|
112
98
|
const sortedFilteredPeers = await sortPeersByLatency(
|
113
|
-
this.peerStore,
|
99
|
+
this.components.peerStore,
|
114
100
|
filteredPeers
|
115
101
|
);
|
116
102
|
|
package/src/lib/filter/index.ts
CHANGED
@@ -301,8 +301,11 @@ export class FilterCore extends BaseProtocol implements IBaseProtocolCore {
|
|
301
301
|
() => {
|
302
302
|
log.info("Receiving pipe closed.");
|
303
303
|
},
|
304
|
-
(e) => {
|
305
|
-
log.error(
|
304
|
+
async (e) => {
|
305
|
+
log.error(
|
306
|
+
`Error with receiving pipe on peer:${connection.remotePeer.toString()} -- stream:${stream.id} -- protocol:${stream.protocol}: `,
|
307
|
+
e
|
308
|
+
);
|
306
309
|
}
|
307
310
|
);
|
308
311
|
} catch (e) {
|
@@ -45,7 +45,7 @@ class Metadata extends BaseProtocol implements IMetadata {
|
|
45
45
|
pubsubTopicsToShardInfo(this.pubsubTopics)
|
46
46
|
);
|
47
47
|
|
48
|
-
const peer = await this.peerStore.get(peerId);
|
48
|
+
const peer = await this.libp2pComponents.peerStore.get(peerId);
|
49
49
|
if (!peer) {
|
50
50
|
return {
|
51
51
|
shardInfo: null,
|
@@ -1,16 +1,10 @@
|
|
1
|
-
import type {
|
2
|
-
Connection,
|
3
|
-
Peer,
|
4
|
-
PeerId,
|
5
|
-
PeerUpdate,
|
6
|
-
Stream
|
7
|
-
} from "@libp2p/interface";
|
1
|
+
import type { Peer, PeerId, PeerUpdate, Stream } from "@libp2p/interface";
|
8
2
|
import type { Libp2p } from "@waku/interfaces";
|
9
3
|
import { Logger } from "@waku/utils";
|
10
4
|
|
11
|
-
import {
|
5
|
+
import { selectOpenConnection } from "./utils.js";
|
12
6
|
|
13
|
-
const
|
7
|
+
const STREAM_LOCK_KEY = "consumed";
|
14
8
|
|
15
9
|
export class StreamManager {
|
16
10
|
private readonly log: Logger;
|
@@ -19,9 +13,9 @@ export class StreamManager {
|
|
19
13
|
private streamPool: Map<string, Promise<void>> = new Map();
|
20
14
|
|
21
15
|
public constructor(
|
22
|
-
|
23
|
-
|
24
|
-
|
16
|
+
private multicodec: string,
|
17
|
+
private getConnections: Libp2p["getConnections"],
|
18
|
+
private addEventListener: Libp2p["addEventListener"]
|
25
19
|
) {
|
26
20
|
this.log = new Logger(`stream-manager:${multicodec}`);
|
27
21
|
this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
|
@@ -31,24 +25,31 @@ export class StreamManager {
|
|
31
25
|
const peerId = peer.id.toString();
|
32
26
|
|
33
27
|
const scheduledStream = this.streamPool.get(peerId);
|
34
|
-
this.streamPool.delete(peerId);
|
35
|
-
await scheduledStream;
|
36
28
|
|
37
|
-
|
29
|
+
if (scheduledStream) {
|
30
|
+
this.streamPool.delete(peerId);
|
31
|
+
await scheduledStream;
|
32
|
+
}
|
33
|
+
|
34
|
+
let stream = this.getOpenStreamForCodec(peer.id);
|
38
35
|
|
39
36
|
if (stream) {
|
40
37
|
this.log.info(
|
41
38
|
`Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`
|
42
39
|
);
|
40
|
+
this.lockStream(peer.id.toString(), stream);
|
43
41
|
return stream;
|
44
42
|
}
|
45
43
|
|
46
|
-
|
44
|
+
stream = await this.createStream(peer);
|
45
|
+
this.lockStream(peer.id.toString(), stream);
|
46
|
+
|
47
|
+
return stream;
|
47
48
|
}
|
48
49
|
|
49
50
|
private async createStream(peer: Peer, retries = 0): Promise<Stream> {
|
50
51
|
const connections = this.getConnections(peer.id);
|
51
|
-
const connection =
|
52
|
+
const connection = selectOpenConnection(connections);
|
52
53
|
|
53
54
|
if (!connection) {
|
54
55
|
throw new Error(
|
@@ -68,6 +69,7 @@ export class StreamManager {
|
|
68
69
|
this.log.info(
|
69
70
|
`Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
|
70
71
|
);
|
72
|
+
break;
|
71
73
|
} catch (error) {
|
72
74
|
lastError = error;
|
73
75
|
}
|
@@ -96,9 +98,13 @@ export class StreamManager {
|
|
96
98
|
try {
|
97
99
|
this.ongoingCreation.add(peerId);
|
98
100
|
await this.createStream(peer);
|
101
|
+
} catch (error) {
|
102
|
+
this.log.error(`Failed to createStreamWithLock:`, error);
|
99
103
|
} finally {
|
100
104
|
this.ongoingCreation.delete(peerId);
|
101
105
|
}
|
106
|
+
|
107
|
+
return;
|
102
108
|
}
|
103
109
|
|
104
110
|
private handlePeerUpdateStreamPool = (evt: CustomEvent<PeerUpdate>): void => {
|
@@ -108,7 +114,7 @@ export class StreamManager {
|
|
108
114
|
return;
|
109
115
|
}
|
110
116
|
|
111
|
-
const stream = this.
|
117
|
+
const stream = this.getOpenStreamForCodec(peer.id);
|
112
118
|
|
113
119
|
if (stream) {
|
114
120
|
return;
|
@@ -122,22 +128,17 @@ export class StreamManager {
|
|
122
128
|
`Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
|
123
129
|
);
|
124
130
|
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
const streamPromise = Promise.race([
|
130
|
-
this.createStreamWithLock(peer),
|
131
|
-
timeoutPromise
|
132
|
-
]);
|
131
|
+
// abandon previous attempt
|
132
|
+
if (this.streamPool.has(peer.id.toString())) {
|
133
|
+
this.streamPool.delete(peer.id.toString());
|
134
|
+
}
|
133
135
|
|
134
|
-
this.streamPool.set(peer.id.toString(),
|
136
|
+
this.streamPool.set(peer.id.toString(), this.createStreamWithLock(peer));
|
135
137
|
}
|
136
138
|
|
137
|
-
private
|
138
|
-
const
|
139
|
-
|
140
|
-
);
|
139
|
+
private getOpenStreamForCodec(peerId: PeerId): Stream | undefined {
|
140
|
+
const connections = this.getConnections(peerId);
|
141
|
+
const connection = selectOpenConnection(connections);
|
141
142
|
|
142
143
|
if (!connection) {
|
143
144
|
return;
|
@@ -147,6 +148,26 @@ export class StreamManager {
|
|
147
148
|
(s) => s.protocol === this.multicodec
|
148
149
|
);
|
149
150
|
|
151
|
+
if (!stream) {
|
152
|
+
return;
|
153
|
+
}
|
154
|
+
|
155
|
+
const isStreamUnusable = ["done", "closed", "closing"].includes(
|
156
|
+
stream.writeStatus || ""
|
157
|
+
);
|
158
|
+
if (isStreamUnusable || this.isStreamLocked(stream)) {
|
159
|
+
return;
|
160
|
+
}
|
161
|
+
|
150
162
|
return stream;
|
151
163
|
}
|
164
|
+
|
165
|
+
private lockStream(peerId: string, stream: Stream): void {
|
166
|
+
this.log.info(`Locking stream for peerId:${peerId}\tstreamId:${stream.id}`);
|
167
|
+
stream.metadata[STREAM_LOCK_KEY] = true;
|
168
|
+
}
|
169
|
+
|
170
|
+
private isStreamLocked(stream: Stream): boolean {
|
171
|
+
return !!stream.metadata[STREAM_LOCK_KEY];
|
172
|
+
}
|
152
173
|
}
|
@@ -1,22 +1,10 @@
|
|
1
1
|
import type { Connection } from "@libp2p/interface";
|
2
2
|
|
3
|
-
export function
|
3
|
+
export function selectOpenConnection(
|
4
4
|
connections: Connection[]
|
5
5
|
): Connection | undefined {
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
connections.forEach((connection) => {
|
12
|
-
if (connection.status === "open") {
|
13
|
-
if (!latestConnection) {
|
14
|
-
latestConnection = connection;
|
15
|
-
} else if (connection.timeline.open > latestConnection.timeline.open) {
|
16
|
-
latestConnection = connection;
|
17
|
-
}
|
18
|
-
}
|
19
|
-
});
|
20
|
-
|
21
|
-
return latestConnection;
|
6
|
+
return connections
|
7
|
+
.filter((c) => c.status === "open")
|
8
|
+
.sort((left, right) => right.timeline.open - left.timeline.open)
|
9
|
+
.at(0);
|
22
10
|
}
|
@@ -1,22 +0,0 @@
|
|
1
|
-
import type { Waku } from "@waku/interfaces";
|
2
|
-
import { Protocols } from "@waku/interfaces";
|
3
|
-
/**
|
4
|
-
* Wait for a remote peer to be ready given the passed protocols.
|
5
|
-
* Must be used after attempting to connect to nodes, using
|
6
|
-
* {@link @waku/sdk!WakuNode.dial} or a bootstrap method with
|
7
|
-
* {@link @waku/sdk!createLightNode}.
|
8
|
-
*
|
9
|
-
* If the passed protocols is a GossipSub protocol, then it resolves only once
|
10
|
-
* a peer is in a mesh, to help ensure that other peers will send and receive
|
11
|
-
* message to us.
|
12
|
-
*
|
13
|
-
* @param waku The Waku Node
|
14
|
-
* @param protocols The protocols that need to be enabled by remote peers.
|
15
|
-
* @param timeoutMs A timeout value in milliseconds..
|
16
|
-
*
|
17
|
-
* @returns A promise that **resolves** if all desired protocols are fulfilled by
|
18
|
-
* remote nodes, **rejects** if the timeoutMs is reached.
|
19
|
-
* @throws If passing a protocol that is not mounted
|
20
|
-
* @default Wait for remote peers with protocols enabled locally and no time out is applied.
|
21
|
-
*/
|
22
|
-
export declare function waitForRemotePeer(waku: Waku, protocols?: Protocols[], timeoutMs?: number): Promise<void>;
|