@libp2p/utils 6.7.1 → 6.7.2-a02cb0461

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.
Files changed (120) hide show
  1. package/README.md +16 -1
  2. package/dist/index.min.js +6 -1
  3. package/dist/index.min.js.map +4 -4
  4. package/dist/src/abstract-message-stream.d.ts +129 -0
  5. package/dist/src/abstract-message-stream.d.ts.map +1 -0
  6. package/dist/src/abstract-message-stream.js +389 -0
  7. package/dist/src/abstract-message-stream.js.map +1 -0
  8. package/dist/src/abstract-multiaddr-connection.d.ts +26 -0
  9. package/dist/src/abstract-multiaddr-connection.d.ts.map +1 -0
  10. package/dist/src/abstract-multiaddr-connection.js +66 -0
  11. package/dist/src/abstract-multiaddr-connection.js.map +1 -0
  12. package/dist/src/abstract-stream-muxer.d.ts +53 -0
  13. package/dist/src/abstract-stream-muxer.d.ts.map +1 -0
  14. package/dist/src/abstract-stream-muxer.js +169 -0
  15. package/dist/src/abstract-stream-muxer.js.map +1 -0
  16. package/dist/src/abstract-stream.d.ts +14 -130
  17. package/dist/src/abstract-stream.d.ts.map +1 -1
  18. package/dist/src/abstract-stream.js +39 -321
  19. package/dist/src/abstract-stream.js.map +1 -1
  20. package/dist/src/errors.d.ts +8 -0
  21. package/dist/src/errors.d.ts.map +1 -1
  22. package/dist/src/errors.js +8 -0
  23. package/dist/src/errors.js.map +1 -1
  24. package/dist/src/index.d.ts +33 -1
  25. package/dist/src/index.d.ts.map +1 -1
  26. package/dist/src/index.js +33 -1
  27. package/dist/src/index.js.map +1 -1
  28. package/dist/src/length-prefixed-decoder.d.ts +37 -0
  29. package/dist/src/length-prefixed-decoder.d.ts.map +1 -0
  30. package/dist/src/length-prefixed-decoder.js +64 -0
  31. package/dist/src/length-prefixed-decoder.js.map +1 -0
  32. package/dist/src/message-queue.d.ts +61 -0
  33. package/dist/src/message-queue.d.ts.map +1 -0
  34. package/dist/src/message-queue.js +93 -0
  35. package/dist/src/message-queue.js.map +1 -0
  36. package/dist/src/mock-muxer.d.ts +57 -0
  37. package/dist/src/mock-muxer.d.ts.map +1 -0
  38. package/dist/src/mock-muxer.js +204 -0
  39. package/dist/src/mock-muxer.js.map +1 -0
  40. package/dist/src/mock-stream.d.ts +31 -0
  41. package/dist/src/mock-stream.d.ts.map +1 -0
  42. package/dist/src/mock-stream.js +69 -0
  43. package/dist/src/mock-stream.js.map +1 -0
  44. package/dist/src/multiaddr/index.d.ts +7 -0
  45. package/dist/src/multiaddr/index.d.ts.map +1 -0
  46. package/dist/src/multiaddr/index.js +7 -0
  47. package/dist/src/multiaddr/index.js.map +1 -0
  48. package/dist/src/multiaddr-connection-pair.d.ts +25 -0
  49. package/dist/src/multiaddr-connection-pair.d.ts.map +1 -0
  50. package/dist/src/multiaddr-connection-pair.js +103 -0
  51. package/dist/src/multiaddr-connection-pair.js.map +1 -0
  52. package/dist/src/queue/index.d.ts +5 -0
  53. package/dist/src/queue/index.d.ts.map +1 -1
  54. package/dist/src/queue/index.js +24 -9
  55. package/dist/src/queue/index.js.map +1 -1
  56. package/dist/src/rate-limiter.d.ts +1 -15
  57. package/dist/src/rate-limiter.d.ts.map +1 -1
  58. package/dist/src/rate-limiter.js +1 -14
  59. package/dist/src/rate-limiter.js.map +1 -1
  60. package/dist/src/socket-writer.browser.d.ts +2 -0
  61. package/dist/src/socket-writer.browser.d.ts.map +1 -0
  62. package/dist/src/socket-writer.browser.js +4 -0
  63. package/dist/src/socket-writer.browser.js.map +1 -0
  64. package/dist/src/socket-writer.d.ts +19 -0
  65. package/dist/src/socket-writer.d.ts.map +1 -0
  66. package/dist/src/socket-writer.js +43 -0
  67. package/dist/src/socket-writer.js.map +1 -0
  68. package/dist/src/stream-pair.d.ts +42 -0
  69. package/dist/src/stream-pair.d.ts.map +1 -0
  70. package/dist/src/stream-pair.js +40 -0
  71. package/dist/src/stream-pair.js.map +1 -0
  72. package/dist/src/stream-utils.d.ts +199 -0
  73. package/dist/src/stream-utils.d.ts.map +1 -0
  74. package/dist/src/stream-utils.js +369 -0
  75. package/dist/src/stream-utils.js.map +1 -0
  76. package/package.json +19 -163
  77. package/src/abstract-message-stream.ts +549 -0
  78. package/src/abstract-multiaddr-connection.ts +93 -0
  79. package/src/abstract-stream-muxer.ts +239 -0
  80. package/src/abstract-stream.ts +51 -464
  81. package/src/errors.ts +10 -0
  82. package/src/index.ts +33 -1
  83. package/src/length-prefixed-decoder.ts +98 -0
  84. package/src/message-queue.ts +156 -0
  85. package/src/mock-muxer.ts +304 -0
  86. package/src/mock-stream.ts +101 -0
  87. package/src/multiaddr/index.ts +6 -0
  88. package/src/multiaddr-connection-pair.ts +147 -0
  89. package/src/queue/index.ts +30 -9
  90. package/src/rate-limiter.ts +3 -30
  91. package/src/socket-writer.browser.ts +3 -0
  92. package/src/socket-writer.ts +64 -0
  93. package/src/stream-pair.ts +90 -0
  94. package/src/stream-utils.ts +874 -0
  95. package/dist/src/abort-options.d.ts +0 -7
  96. package/dist/src/abort-options.d.ts.map +0 -1
  97. package/dist/src/abort-options.js +0 -14
  98. package/dist/src/abort-options.js.map +0 -1
  99. package/dist/src/array-equals.d.ts +0 -24
  100. package/dist/src/array-equals.d.ts.map +0 -1
  101. package/dist/src/array-equals.js +0 -31
  102. package/dist/src/array-equals.js.map +0 -1
  103. package/dist/src/close-source.d.ts +0 -4
  104. package/dist/src/close-source.d.ts.map +0 -1
  105. package/dist/src/close-source.js +0 -11
  106. package/dist/src/close-source.js.map +0 -1
  107. package/dist/src/close.d.ts +0 -21
  108. package/dist/src/close.d.ts.map +0 -1
  109. package/dist/src/close.js +0 -49
  110. package/dist/src/close.js.map +0 -1
  111. package/dist/src/stream-to-ma-conn.d.ts +0 -23
  112. package/dist/src/stream-to-ma-conn.d.ts.map +0 -1
  113. package/dist/src/stream-to-ma-conn.js +0 -75
  114. package/dist/src/stream-to-ma-conn.js.map +0 -1
  115. package/dist/typedoc-urls.json +0 -147
  116. package/src/abort-options.ts +0 -20
  117. package/src/array-equals.ts +0 -34
  118. package/src/close-source.ts +0 -14
  119. package/src/close.ts +0 -65
  120. package/src/stream-to-ma-conn.ts +0 -105
@@ -1,105 +0,0 @@
1
- import forEach from 'it-foreach'
2
- import { pipe } from 'it-pipe'
3
- import type { ComponentLogger, MultiaddrConnection, Stream } from '@libp2p/interface'
4
- import type { Multiaddr } from '@multiformats/multiaddr'
5
- import type { Uint8ArrayList } from 'uint8arraylist'
6
-
7
- export interface StreamProperties {
8
- stream: Stream
9
- remoteAddr: Multiaddr
10
- localAddr: Multiaddr
11
- logger: ComponentLogger
12
-
13
- /**
14
- * A callback invoked when data is read from the stream
15
- */
16
- onDataRead?(buf: Uint8ArrayList | Uint8Array): void
17
-
18
- /**
19
- * A callback invoked when data is written to the stream
20
- */
21
- onDataWrite?(buf: Uint8ArrayList | Uint8Array): void
22
- }
23
-
24
- /**
25
- * Convert a duplex iterable into a MultiaddrConnection.
26
- * https://github.com/libp2p/interface-transport#multiaddrconnection
27
- */
28
- export function streamToMaConnection (props: StreamProperties): MultiaddrConnection {
29
- const { stream, remoteAddr, logger, onDataRead, onDataWrite } = props
30
- const log = logger.forComponent('libp2p:stream:converter')
31
-
32
- let closedRead = false
33
- let closedWrite = false
34
-
35
- // piggyback on `stream.close` invocations to close multiaddr connection
36
- const streamClose = stream.close.bind(stream)
37
- stream.close = async (options): Promise<void> => {
38
- await streamClose(options)
39
- close(true)
40
- }
41
-
42
- // piggyback on `stream.abort` invocations to close multiaddr connection
43
- const streamAbort = stream.abort.bind(stream)
44
- stream.abort = (err): void => {
45
- streamAbort(err)
46
- close(true)
47
- }
48
-
49
- // piggyback on `stream.sink` invocations to close multiaddr connection
50
- const streamSink = stream.sink.bind(stream)
51
- stream.sink = async (source): Promise<void> => {
52
- try {
53
- await streamSink(
54
- pipe(
55
- source,
56
- (source) => forEach(source, buf => onDataWrite?.(buf))
57
- )
58
- )
59
- } catch (err: any) {
60
- // If aborted we can safely ignore
61
- if (err.type !== 'aborted') {
62
- // If the source errored the socket will already have been destroyed by
63
- // toIterable.duplex(). If the socket errored it will already be
64
- // destroyed. There's nothing to do here except log the error & return.
65
- log.error('%s error in sink', remoteAddr, err)
66
- }
67
- } finally {
68
- closedWrite = true
69
- close()
70
- }
71
- }
72
-
73
- const maConn: MultiaddrConnection = {
74
- log,
75
- sink: stream.sink,
76
- source: (async function * (): AsyncGenerator<Uint8ArrayList> {
77
- try {
78
- for await (const buf of stream.source) {
79
- onDataRead?.(buf)
80
- yield buf
81
- }
82
- } finally {
83
- closedRead = true
84
- close()
85
- }
86
- }()),
87
- remoteAddr,
88
- timeline: { open: Date.now(), close: undefined },
89
- close: stream.close,
90
- abort: stream.abort
91
- }
92
-
93
- function close (force?: boolean): void {
94
- if (force === true) {
95
- closedRead = true
96
- closedWrite = true
97
- }
98
-
99
- if (closedRead && closedWrite && maConn.timeline.close == null) {
100
- maConn.timeline.close = Date.now()
101
- }
102
- }
103
-
104
- return maConn
105
- }