@libp2p/floodsub 9.0.11-e1c01370b → 9.0.11-f0d2b52d0
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 +25 -6
- package/dist/src/index.d.ts +8 -6
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +8 -6
- package/dist/src/index.js.map +1 -1
- package/package.json +11 -10
- package/src/index.ts +8 -6
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# @libp2p/floodsub
|
|
2
|
+
|
|
1
3
|
[](http://libp2p.io/)
|
|
2
4
|
[](https://discuss.libp2p.io)
|
|
3
5
|
[](https://codecov.io/gh/libp2p/js-libp2p)
|
|
@@ -7,6 +9,21 @@
|
|
|
7
9
|
|
|
8
10
|
# About
|
|
9
11
|
|
|
12
|
+
<!--
|
|
13
|
+
|
|
14
|
+
!IMPORTANT!
|
|
15
|
+
|
|
16
|
+
Everything in this README between "# About" and "# Install" is automatically
|
|
17
|
+
generated and will be overwritten the next time the doc generator is run.
|
|
18
|
+
|
|
19
|
+
To make changes to this section, please update the @packageDocumentation section
|
|
20
|
+
of src/index.js or src/index.ts
|
|
21
|
+
|
|
22
|
+
To experiment with formatting, please run "npm run docs" from the root of this
|
|
23
|
+
repo and examine the changes made.
|
|
24
|
+
|
|
25
|
+
-->
|
|
26
|
+
|
|
10
27
|
> Don't use this module
|
|
11
28
|
|
|
12
29
|
This module is a naive implementation of pubsub. It broadcasts all messages to all network peers, cannot provide older messages and has no protection against bad actors.
|
|
@@ -18,21 +35,23 @@ Instead please use [gossipsub](https://www.npmjs.com/package/@chainsafe/libp2p-g
|
|
|
18
35
|
## Example - Configuring libp2p to use floodsub
|
|
19
36
|
|
|
20
37
|
```TypeScript
|
|
21
|
-
import {
|
|
38
|
+
import { createLibp2p } from 'libp2p'
|
|
22
39
|
import { floodsub } from '@libp2p/floodsub'
|
|
23
40
|
|
|
24
|
-
const node = await
|
|
25
|
-
|
|
41
|
+
const node = await createLibp2p({
|
|
42
|
+
services: {
|
|
43
|
+
pubsub: floodsub()
|
|
44
|
+
}
|
|
26
45
|
//... other options
|
|
27
46
|
})
|
|
28
47
|
await node.start()
|
|
29
48
|
|
|
30
|
-
node.pubsub.subscribe('fruit')
|
|
31
|
-
node.pubsub.addEventListener('message', (evt) => {
|
|
49
|
+
node.services.pubsub.subscribe('fruit')
|
|
50
|
+
node.services.pubsub.addEventListener('message', (evt) => {
|
|
32
51
|
console.log(evt)
|
|
33
52
|
})
|
|
34
53
|
|
|
35
|
-
node.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
54
|
+
node.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
36
55
|
```
|
|
37
56
|
|
|
38
57
|
# Install
|
package/dist/src/index.d.ts
CHANGED
|
@@ -12,21 +12,23 @@
|
|
|
12
12
|
* @example Configuring libp2p to use floodsub
|
|
13
13
|
*
|
|
14
14
|
* ```TypeScript
|
|
15
|
-
* import {
|
|
15
|
+
* import { createLibp2p } from 'libp2p'
|
|
16
16
|
* import { floodsub } from '@libp2p/floodsub'
|
|
17
17
|
*
|
|
18
|
-
* const node = await
|
|
19
|
-
*
|
|
18
|
+
* const node = await createLibp2p({
|
|
19
|
+
* services: {
|
|
20
|
+
* pubsub: floodsub()
|
|
21
|
+
* }
|
|
20
22
|
* //... other options
|
|
21
23
|
* })
|
|
22
24
|
* await node.start()
|
|
23
25
|
*
|
|
24
|
-
* node.pubsub.subscribe('fruit')
|
|
25
|
-
* node.pubsub.addEventListener('message', (evt) => {
|
|
26
|
+
* node.services.pubsub.subscribe('fruit')
|
|
27
|
+
* node.services.pubsub.addEventListener('message', (evt) => {
|
|
26
28
|
* console.log(evt)
|
|
27
29
|
* })
|
|
28
30
|
*
|
|
29
|
-
* node.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
31
|
+
* node.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
30
32
|
* ```
|
|
31
33
|
*/
|
|
32
34
|
import { PubSubBaseProtocol, type PubSubComponents } from '@libp2p/pubsub';
|
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
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAE1E,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAExC,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AACxH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,OAAO,EAAE,UAAU,EAAE,CAAA;AAErB,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;CAE3D;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,kBAAkB;IACvC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;gBAE7B,UAAU,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,YAAY;IAmBhE;;OAEG;IACH,SAAS,CAAE,KAAK,EAAE,UAAU,GAAG,cAAc,GAAG,SAAS;IAIzD;;OAEG;IACH,SAAS,CAAE,GAAG,EAAE,SAAS,GAAG,UAAU;IAItC,aAAa,CAAE,KAAK,EAAE,UAAU,GAAG,cAAc,GAAG,gBAAgB;IAIpE,aAAa,CAAE,GAAG,EAAE,gBAAgB,GAAG,UAAU;IAIjD;;;OAGG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpE;;OAEG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CA4B9E;AAED,wBAAgB,QAAQ,CAAE,IAAI,GAAE,YAAiB,GAAG,CAAC,UAAU,EAAE,kBAAkB,KAAK,MAAM,CAE7F"}
|
package/dist/src/index.js
CHANGED
|
@@ -12,21 +12,23 @@
|
|
|
12
12
|
* @example Configuring libp2p to use floodsub
|
|
13
13
|
*
|
|
14
14
|
* ```TypeScript
|
|
15
|
-
* import {
|
|
15
|
+
* import { createLibp2p } from 'libp2p'
|
|
16
16
|
* import { floodsub } from '@libp2p/floodsub'
|
|
17
17
|
*
|
|
18
|
-
* const node = await
|
|
19
|
-
*
|
|
18
|
+
* const node = await createLibp2p({
|
|
19
|
+
* services: {
|
|
20
|
+
* pubsub: floodsub()
|
|
21
|
+
* }
|
|
20
22
|
* //... other options
|
|
21
23
|
* })
|
|
22
24
|
* await node.start()
|
|
23
25
|
*
|
|
24
|
-
* node.pubsub.subscribe('fruit')
|
|
25
|
-
* node.pubsub.addEventListener('message', (evt) => {
|
|
26
|
+
* node.services.pubsub.subscribe('fruit')
|
|
27
|
+
* node.services.pubsub.addEventListener('message', (evt) => {
|
|
26
28
|
* console.log(evt)
|
|
27
29
|
* })
|
|
28
30
|
*
|
|
29
|
-
* node.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
31
|
+
* node.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
30
32
|
* ```
|
|
31
33
|
*/
|
|
32
34
|
import { PubSubBaseProtocol } from '@libp2p/pubsub';
|
package/dist/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EAAE,kBAAkB,EAAyB,MAAM,gBAAgB,CAAA;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAItC,OAAO,EAAE,UAAU,EAAE,CAAA;AAUrB;;;;GAIG;AACH,MAAM,OAAO,QAAS,SAAQ,kBAAkB;IACvC,SAAS,CAA0B;IAE1C,YAAa,UAA8B,EAAE,IAAmB;QAC9D,KAAK,CAAC,UAAU,EAAE;YAChB,GAAG,IAAI;YACP,eAAe,EAAE,IAAI;YACrB,WAAW,EAAE,CAAC,UAAU,CAAC;SAC1B,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAE5D;;;;WAIG;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAU;YAC5C,UAAU,EAAE,IAAI,EAAE,OAAO,IAAI,KAAK;SACnC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,SAAS,CAAE,KAAkC;QAC3C,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,SAAS,CAAE,GAAc;QACvB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,aAAa,CAAE,KAAkC;QAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED,aAAa,CAAE,GAAqB;QAClC,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAE,IAAY,EAAE,OAAgB;QAClD,iDAAiD;QACjD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAE1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,OAAM;QACR,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAElC,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAE,IAAY,EAAE,OAAgB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAChD,MAAM,UAAU,GAAa,EAAE,CAAA;QAE/B,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;YAC9D,OAAO,EAAE,UAAU,EAAE,CAAA;QACvB,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACjB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;gBACpE,OAAM;YACR,CAAC;YAED,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,IAAI,CAAC,GAAG,CAAC,8CAA8C,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;gBAC3E,OAAM;YACR,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YAE3D,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACnB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;QAEF,OAAO,EAAE,UAAU,EAAE,CAAA;IACvB,CAAC;CACF;AAED,MAAM,UAAU,QAAQ,CAAE,OAAqB,EAAE;IAC/C,OAAO,CAAC,UAA8B,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAC3E,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/floodsub",
|
|
3
|
-
"version": "9.0.11-
|
|
3
|
+
"version": "9.0.11-f0d2b52d0",
|
|
4
4
|
"description": "libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).",
|
|
5
5
|
"license": "Apache-2.0 OR MIT",
|
|
6
6
|
"homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub#readme",
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
"clean": "aegir clean",
|
|
49
49
|
"lint": "aegir lint",
|
|
50
50
|
"dep-check": "aegir dep-check",
|
|
51
|
+
"doc-check": "aegir doc-check",
|
|
51
52
|
"build": "aegir build",
|
|
52
53
|
"generate": "protons ./src/message/rpc.proto",
|
|
53
54
|
"test": "aegir test",
|
|
@@ -59,21 +60,21 @@
|
|
|
59
60
|
"test:electron-main": "aegir test -t electron-main"
|
|
60
61
|
},
|
|
61
62
|
"dependencies": {
|
|
62
|
-
"@libp2p/interface": "1.1.3-
|
|
63
|
-
"@libp2p/pubsub": "9.0.10-
|
|
63
|
+
"@libp2p/interface": "1.1.3-f0d2b52d0",
|
|
64
|
+
"@libp2p/pubsub": "9.0.10-f0d2b52d0",
|
|
64
65
|
"protons-runtime": "^5.4.0",
|
|
65
66
|
"uint8arraylist": "^2.4.8",
|
|
66
|
-
"uint8arrays": "^5.0.
|
|
67
|
+
"uint8arrays": "^5.0.2"
|
|
67
68
|
},
|
|
68
69
|
"devDependencies": {
|
|
69
|
-
"@libp2p/interface-compliance-tests": "5.3.1-
|
|
70
|
-
"@libp2p/logger": "4.0.6-
|
|
71
|
-
"@libp2p/peer-collections": "5.1.6-
|
|
72
|
-
"@libp2p/peer-id-factory": "4.0.6-
|
|
70
|
+
"@libp2p/interface-compliance-tests": "5.3.1-f0d2b52d0",
|
|
71
|
+
"@libp2p/logger": "4.0.6-f0d2b52d0",
|
|
72
|
+
"@libp2p/peer-collections": "5.1.6-f0d2b52d0",
|
|
73
|
+
"@libp2p/peer-id-factory": "4.0.6-f0d2b52d0",
|
|
73
74
|
"@multiformats/multiaddr": "^12.1.14",
|
|
74
75
|
"@types/sinon": "^17.0.3",
|
|
75
|
-
"aegir": "^42.2.
|
|
76
|
-
"multiformats": "^13.0
|
|
76
|
+
"aegir": "^42.2.4",
|
|
77
|
+
"multiformats": "^13.1.0",
|
|
77
78
|
"p-wait-for": "^5.0.2",
|
|
78
79
|
"protons": "^7.5.0",
|
|
79
80
|
"sinon": "^17.0.1"
|
package/src/index.ts
CHANGED
|
@@ -12,21 +12,23 @@
|
|
|
12
12
|
* @example Configuring libp2p to use floodsub
|
|
13
13
|
*
|
|
14
14
|
* ```TypeScript
|
|
15
|
-
* import {
|
|
15
|
+
* import { createLibp2p } from 'libp2p'
|
|
16
16
|
* import { floodsub } from '@libp2p/floodsub'
|
|
17
17
|
*
|
|
18
|
-
* const node = await
|
|
19
|
-
*
|
|
18
|
+
* const node = await createLibp2p({
|
|
19
|
+
* services: {
|
|
20
|
+
* pubsub: floodsub()
|
|
21
|
+
* }
|
|
20
22
|
* //... other options
|
|
21
23
|
* })
|
|
22
24
|
* await node.start()
|
|
23
25
|
*
|
|
24
|
-
* node.pubsub.subscribe('fruit')
|
|
25
|
-
* node.pubsub.addEventListener('message', (evt) => {
|
|
26
|
+
* node.services.pubsub.subscribe('fruit')
|
|
27
|
+
* node.services.pubsub.addEventListener('message', (evt) => {
|
|
26
28
|
* console.log(evt)
|
|
27
29
|
* })
|
|
28
30
|
*
|
|
29
|
-
* node.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
31
|
+
* node.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
|
|
30
32
|
* ```
|
|
31
33
|
*/
|
|
32
34
|
|