@libp2p/interface 1.5.0-b0b6cae12 → 1.6.0-151bc46fb
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.
|
@@ -3,6 +3,7 @@ import type { TypedEventTarget } from '../event-target.js';
|
|
|
3
3
|
import type { AbortOptions } from '../index.js';
|
|
4
4
|
import type { StreamMuxerFactory } from '../stream-muxer/index.js';
|
|
5
5
|
import type { Multiaddr } from '@multiformats/multiaddr';
|
|
6
|
+
import type { ProgressOptions, ProgressEvent } from 'progress-events';
|
|
6
7
|
export interface ListenerEvents {
|
|
7
8
|
'connection': CustomEvent<Connection>;
|
|
8
9
|
'listening': CustomEvent;
|
|
@@ -36,13 +37,13 @@ export interface CreateListenerOptions {
|
|
|
36
37
|
handler?: ConnectionHandler;
|
|
37
38
|
upgrader: Upgrader;
|
|
38
39
|
}
|
|
39
|
-
export interface DialOptions extends AbortOptions {
|
|
40
|
+
export interface DialOptions<DialEvents extends ProgressEvent = ProgressEvent> extends AbortOptions, ProgressOptions<DialEvents> {
|
|
40
41
|
upgrader: Upgrader;
|
|
41
42
|
}
|
|
42
43
|
/**
|
|
43
|
-
* A libp2p transport
|
|
44
|
+
* A libp2p transport offers dial and listen methods to establish connections.
|
|
44
45
|
*/
|
|
45
|
-
export interface Transport {
|
|
46
|
+
export interface Transport<DialEvents extends ProgressEvent = ProgressEvent> {
|
|
46
47
|
/**
|
|
47
48
|
* Used to identify the transport
|
|
48
49
|
*/
|
|
@@ -54,7 +55,7 @@ export interface Transport {
|
|
|
54
55
|
/**
|
|
55
56
|
* Dial a given multiaddr.
|
|
56
57
|
*/
|
|
57
|
-
dial(ma: Multiaddr, options: DialOptions): Promise<Connection>;
|
|
58
|
+
dial(ma: Multiaddr, options: DialOptions<DialEvents>): Promise<Connection>;
|
|
58
59
|
/**
|
|
59
60
|
* Create transport listeners.
|
|
60
61
|
*/
|
|
@@ -84,7 +85,7 @@ export declare enum FaultTolerance {
|
|
|
84
85
|
*/
|
|
85
86
|
NO_FATAL = 1
|
|
86
87
|
}
|
|
87
|
-
export interface UpgraderOptions {
|
|
88
|
+
export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent> extends ProgressOptions<ConnectionUpgradeEvents> {
|
|
88
89
|
skipEncryption?: boolean;
|
|
89
90
|
skipProtection?: boolean;
|
|
90
91
|
muxerFactory?: StreamMuxerFactory;
|
|
@@ -94,14 +95,16 @@ export interface UpgraderOptions {
|
|
|
94
95
|
*/
|
|
95
96
|
transient?: boolean;
|
|
96
97
|
}
|
|
98
|
+
export type InboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-inbound-connection'> | ProgressEvent<'upgrader:multiplex-inbound-connection'>;
|
|
99
|
+
export type OutboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-outbound-connection'> | ProgressEvent<'upgrader:multiplex-outbound-connection'>;
|
|
97
100
|
export interface Upgrader {
|
|
98
101
|
/**
|
|
99
102
|
* Upgrades an outbound connection on `transport.dial`.
|
|
100
103
|
*/
|
|
101
|
-
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions): Promise<Connection>;
|
|
104
|
+
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>;
|
|
102
105
|
/**
|
|
103
106
|
* Upgrades an inbound connection on transport listener.
|
|
104
107
|
*/
|
|
105
|
-
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions): Promise<Connection>;
|
|
108
|
+
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<Connection>;
|
|
106
109
|
}
|
|
107
110
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC7E,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;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC7E,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,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IACrC,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAC3B,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,iBAAiB;IAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE;AAErE,MAAM,WAAW,eAAe;IAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE;AAE3E,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,WAAW,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC;IAC9H,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,WAAW,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1E;;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;IAC9I,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAEjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;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;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACzH"}
|
|
@@ -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":"AA+BA,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AAoD9D,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": "1.
|
|
3
|
+
"version": "1.6.0-151bc46fb",
|
|
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
|
@@ -3,6 +3,7 @@ import type { TypedEventTarget } from '../event-target.js'
|
|
|
3
3
|
import type { AbortOptions } from '../index.js'
|
|
4
4
|
import type { StreamMuxerFactory } from '../stream-muxer/index.js'
|
|
5
5
|
import type { Multiaddr } from '@multiformats/multiaddr'
|
|
6
|
+
import type { ProgressOptions, ProgressEvent } from 'progress-events'
|
|
6
7
|
|
|
7
8
|
export interface ListenerEvents {
|
|
8
9
|
'connection': CustomEvent<Connection>
|
|
@@ -39,14 +40,14 @@ export interface CreateListenerOptions {
|
|
|
39
40
|
upgrader: Upgrader
|
|
40
41
|
}
|
|
41
42
|
|
|
42
|
-
export interface DialOptions extends AbortOptions {
|
|
43
|
+
export interface DialOptions<DialEvents extends ProgressEvent = ProgressEvent> extends AbortOptions, ProgressOptions<DialEvents> {
|
|
43
44
|
upgrader: Upgrader
|
|
44
45
|
}
|
|
45
46
|
|
|
46
47
|
/**
|
|
47
|
-
* A libp2p transport
|
|
48
|
+
* A libp2p transport offers dial and listen methods to establish connections.
|
|
48
49
|
*/
|
|
49
|
-
export interface Transport {
|
|
50
|
+
export interface Transport<DialEvents extends ProgressEvent = ProgressEvent> {
|
|
50
51
|
/**
|
|
51
52
|
* Used to identify the transport
|
|
52
53
|
*/
|
|
@@ -60,7 +61,7 @@ export interface Transport {
|
|
|
60
61
|
/**
|
|
61
62
|
* Dial a given multiaddr.
|
|
62
63
|
*/
|
|
63
|
-
dial(ma: Multiaddr, options: DialOptions): Promise<Connection>
|
|
64
|
+
dial(ma: Multiaddr, options: DialOptions<DialEvents>): Promise<Connection>
|
|
64
65
|
|
|
65
66
|
/**
|
|
66
67
|
* Create transport listeners.
|
|
@@ -99,7 +100,7 @@ export enum FaultTolerance {
|
|
|
99
100
|
NO_FATAL
|
|
100
101
|
}
|
|
101
102
|
|
|
102
|
-
export interface UpgraderOptions {
|
|
103
|
+
export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent> extends ProgressOptions<ConnectionUpgradeEvents> {
|
|
103
104
|
skipEncryption?: boolean
|
|
104
105
|
skipProtection?: boolean
|
|
105
106
|
muxerFactory?: StreamMuxerFactory
|
|
@@ -111,14 +112,22 @@ export interface UpgraderOptions {
|
|
|
111
112
|
transient?: boolean
|
|
112
113
|
}
|
|
113
114
|
|
|
115
|
+
export type InboundConnectionUpgradeEvents =
|
|
116
|
+
ProgressEvent<'upgrader:encrypt-inbound-connection'> |
|
|
117
|
+
ProgressEvent<'upgrader:multiplex-inbound-connection'>
|
|
118
|
+
|
|
119
|
+
export type OutboundConnectionUpgradeEvents =
|
|
120
|
+
ProgressEvent<'upgrader:encrypt-outbound-connection'> |
|
|
121
|
+
ProgressEvent<'upgrader:multiplex-outbound-connection'>
|
|
122
|
+
|
|
114
123
|
export interface Upgrader {
|
|
115
124
|
/**
|
|
116
125
|
* Upgrades an outbound connection on `transport.dial`.
|
|
117
126
|
*/
|
|
118
|
-
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions): Promise<Connection>
|
|
127
|
+
upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>
|
|
119
128
|
|
|
120
129
|
/**
|
|
121
130
|
* Upgrades an inbound connection on transport listener.
|
|
122
131
|
*/
|
|
123
|
-
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions): Promise<Connection>
|
|
132
|
+
upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<Connection>
|
|
124
133
|
}
|