@libp2p/interface 2.2.0-eee97c7d4 → 2.2.1-f53f65d18
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.
|
@@ -5,8 +5,19 @@ import type { StreamMuxerFactory } from '../stream-muxer/index.js';
|
|
|
5
5
|
import type { Multiaddr } from '@multiformats/multiaddr';
|
|
6
6
|
import type { ProgressOptions, ProgressEvent } from 'progress-events';
|
|
7
7
|
export interface ListenerEvents {
|
|
8
|
+
/**
|
|
9
|
+
* This event signals to the transport manager that the listening addresses
|
|
10
|
+
* have changed and may be emitted at any point and/or multiple times
|
|
11
|
+
*/
|
|
8
12
|
'listening': CustomEvent;
|
|
13
|
+
/**
|
|
14
|
+
* Emitted if listening on an address failed
|
|
15
|
+
*/
|
|
9
16
|
'error': CustomEvent<Error>;
|
|
17
|
+
/**
|
|
18
|
+
* Emitted when the listener has been shut down, has no open connections and
|
|
19
|
+
* will no longer accept new connections
|
|
20
|
+
*/
|
|
10
21
|
'close': CustomEvent;
|
|
11
22
|
}
|
|
12
23
|
export interface Listener extends TypedEventTarget<ListenerEvents> {
|
|
@@ -26,16 +37,21 @@ export interface Listener extends TypedEventTarget<ListenerEvents> {
|
|
|
26
37
|
close(): Promise<void>;
|
|
27
38
|
}
|
|
28
39
|
export declare const transportSymbol: unique symbol;
|
|
29
|
-
export interface ConnectionHandler {
|
|
30
|
-
(connection: Connection): void;
|
|
31
|
-
}
|
|
32
40
|
export interface MultiaddrFilter {
|
|
33
41
|
(multiaddrs: Multiaddr[]): Multiaddr[];
|
|
34
42
|
}
|
|
35
43
|
export interface CreateListenerOptions {
|
|
44
|
+
/**
|
|
45
|
+
* The upgrader turns a MultiaddrConnection into a Connection and notifies
|
|
46
|
+
* other libp2p components about a new incoming connection.
|
|
47
|
+
*/
|
|
36
48
|
upgrader: Upgrader;
|
|
37
49
|
}
|
|
38
50
|
export interface DialTransportOptions<DialEvents extends ProgressEvent = ProgressEvent> extends AbortOptions, ProgressOptions<DialEvents> {
|
|
51
|
+
/**
|
|
52
|
+
* The upgrader turns a MultiaddrConnection into a Connection which should be
|
|
53
|
+
* returned by the transport's dial method
|
|
54
|
+
*/
|
|
39
55
|
upgrader: Upgrader;
|
|
40
56
|
}
|
|
41
57
|
/**
|
|
@@ -93,11 +109,12 @@ export type InboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-inb
|
|
|
93
109
|
export type OutboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-outbound-connection'> | ProgressEvent<'upgrader:multiplex-outbound-connection'>;
|
|
94
110
|
export interface Upgrader {
|
|
95
111
|
/**
|
|
96
|
-
* Upgrades an outbound connection
|
|
112
|
+
* Upgrades an outbound connection created by the `dial` method of a transport
|
|
97
113
|
*/
|
|
98
114
|
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>;
|
|
99
115
|
/**
|
|
100
|
-
* Upgrades an inbound connection received by a transport listener
|
|
116
|
+
* Upgrades an inbound connection received by a transport listener and
|
|
117
|
+
* notifies other libp2p components about the new connection
|
|
101
118
|
*/
|
|
102
119
|
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<void>;
|
|
103
120
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAE3B;;;OAGG;IACH,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3C;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IACvB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,eAAO,MAAM,eAAe,eAAkC,CAAA;AAE9D,MAAM,WAAW,eAAe;IAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE;AAE3E,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC;IACvI;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa;IACzE;;OAEG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnF;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAA;IAExD;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAA;IAE7B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,wBAAgB,WAAW,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE3D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,QAAQ,IAAA;CACT;AAED,MAAM,WAAW,eAAe,CAAC,uBAAuB,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,eAAe,CAAC,uBAAuB,CAAC,EAAE,YAAY;IAC5J,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED,MAAM,MAAM,8BAA8B,GAC1C,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,uCAAuC,CAAC,CAAA;AAEtD,MAAM,MAAM,+BAA+B,GAC3C,aAAa,CAAC,sCAAsC,CAAC,GACrD,aAAa,CAAC,wCAAwC,CAAC,CAAA;AAEvD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,+BAA+B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1H;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AA2CA,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AAyD9D,MAAM,UAAU,WAAW,CAAE,KAAU;IACrC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB;;OAEG;IACH,6DAAa,CAAA;IAEb;;OAEG;IACH,2DAAQ,CAAA;AACV,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/interface",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.1-f53f65d18",
|
|
4
4
|
"description": "The interface implemented by a libp2p node",
|
|
5
5
|
"license": "Apache-2.0 OR MIT",
|
|
6
6
|
"homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface#readme",
|
package/src/transport/index.ts
CHANGED
|
@@ -6,8 +6,21 @@ import type { Multiaddr } from '@multiformats/multiaddr'
|
|
|
6
6
|
import type { ProgressOptions, ProgressEvent } from 'progress-events'
|
|
7
7
|
|
|
8
8
|
export interface ListenerEvents {
|
|
9
|
+
/**
|
|
10
|
+
* This event signals to the transport manager that the listening addresses
|
|
11
|
+
* have changed and may be emitted at any point and/or multiple times
|
|
12
|
+
*/
|
|
9
13
|
'listening': CustomEvent
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Emitted if listening on an address failed
|
|
17
|
+
*/
|
|
10
18
|
'error': CustomEvent<Error>
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Emitted when the listener has been shut down, has no open connections and
|
|
22
|
+
* will no longer accept new connections
|
|
23
|
+
*/
|
|
11
24
|
'close': CustomEvent
|
|
12
25
|
}
|
|
13
26
|
|
|
@@ -30,15 +43,21 @@ export interface Listener extends TypedEventTarget<ListenerEvents> {
|
|
|
30
43
|
|
|
31
44
|
export const transportSymbol = Symbol.for('@libp2p/transport')
|
|
32
45
|
|
|
33
|
-
export interface ConnectionHandler { (connection: Connection): void }
|
|
34
|
-
|
|
35
46
|
export interface MultiaddrFilter { (multiaddrs: Multiaddr[]): Multiaddr[] }
|
|
36
47
|
|
|
37
48
|
export interface CreateListenerOptions {
|
|
49
|
+
/**
|
|
50
|
+
* The upgrader turns a MultiaddrConnection into a Connection and notifies
|
|
51
|
+
* other libp2p components about a new incoming connection.
|
|
52
|
+
*/
|
|
38
53
|
upgrader: Upgrader
|
|
39
54
|
}
|
|
40
55
|
|
|
41
56
|
export interface DialTransportOptions<DialEvents extends ProgressEvent = ProgressEvent> extends AbortOptions, ProgressOptions<DialEvents> {
|
|
57
|
+
/**
|
|
58
|
+
* The upgrader turns a MultiaddrConnection into a Connection which should be
|
|
59
|
+
* returned by the transport's dial method
|
|
60
|
+
*/
|
|
42
61
|
upgrader: Upgrader
|
|
43
62
|
}
|
|
44
63
|
|
|
@@ -115,12 +134,13 @@ ProgressEvent<'upgrader:multiplex-outbound-connection'>
|
|
|
115
134
|
|
|
116
135
|
export interface Upgrader {
|
|
117
136
|
/**
|
|
118
|
-
* Upgrades an outbound connection
|
|
137
|
+
* Upgrades an outbound connection created by the `dial` method of a transport
|
|
119
138
|
*/
|
|
120
139
|
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>
|
|
121
140
|
|
|
122
141
|
/**
|
|
123
|
-
* Upgrades an inbound connection received by a transport listener
|
|
142
|
+
* Upgrades an inbound connection received by a transport listener and
|
|
143
|
+
* notifies other libp2p components about the new connection
|
|
124
144
|
*/
|
|
125
145
|
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<void>
|
|
126
146
|
}
|