Skip to content

Commit 9a9b11f

Browse files
authored
fix!: remove pubsub (#3291)
Removes the @libp2p/pubsub module to let floodsub/gossipsub/etc defined what "pubsub" is and not have a "canonical" representation that may limit API design in the future. BREAKING CHANGE: the `@libp2p/pubsub` module has been removed
1 parent acfb7b0 commit 9a9b11f

File tree

129 files changed

+14484
-4144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+14484
-4144
lines changed

.cspell.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,8 @@
77
"name": "project",
88
"path": "./.github/dictionary.txt",
99
"addWords": true
10-
}]
10+
}],
11+
"ignorePaths": [
12+
"packages/gossipsub/**"
13+
]
1114
}

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"packages/config":"1.1.14","packages/connection-encrypter-plaintext":"2.0.29","packages/connection-encrypter-tls":"2.2.7","packages/crypto":"5.1.8","packages/interface":"2.11.0","packages/interface-compliance-tests":"6.5.0","packages/interface-internal":"2.3.19","packages/kad-dht":"15.1.11","packages/keychain":"5.2.9","packages/libp2p":"2.10.0","packages/logger":"5.2.0","packages/metrics-opentelemetry":"1.0.21","packages/metrics-prometheus":"4.3.30","packages/metrics-simple":"1.3.16","packages/multistream-select":"6.0.29","packages/peer-collections":"6.0.35","packages/peer-discovery-bootstrap":"11.0.47","packages/peer-discovery-mdns":"11.0.47","packages/peer-id":"5.1.9","packages/peer-record":"8.0.35","packages/peer-store":"11.2.7","packages/pnet":"2.0.47","packages/protocol-autonat":"2.0.38","packages/protocol-dcutr":"2.0.38","packages/protocol-echo":"2.1.28","packages/protocol-fetch":"3.0.22","packages/protocol-identify":"3.0.39","packages/protocol-perf":"4.0.47","packages/protocol-ping":"2.0.37","packages/pubsub":"10.1.18","packages/pubsub-floodsub":"10.1.46","packages/record":"4.0.7","packages/stream-multiplexer-mplex":"11.0.47","packages/transport-circuit-relay-v2":"3.2.24","packages/transport-memory":"1.1.14","packages/transport-tcp":"10.1.19","packages/transport-webrtc":"5.2.24","packages/transport-websockets":"9.2.19","packages/transport-webtransport":"5.0.51","packages/upnp-nat":"3.1.22","packages/utils":"6.7.2","packages/protocol-autonat-v2":"1.0.1"}
1+
{"packages/config":"1.1.14","packages/connection-encrypter-plaintext":"2.0.29","packages/connection-encrypter-tls":"2.2.7","packages/crypto":"5.1.8","packages/interface":"2.11.0","packages/interface-compliance-tests":"6.5.0","packages/interface-internal":"2.3.19","packages/kad-dht":"15.1.11","packages/keychain":"5.2.9","packages/libp2p":"2.10.0","packages/logger":"5.2.0","packages/metrics-opentelemetry":"1.0.21","packages/metrics-prometheus":"4.3.30","packages/metrics-simple":"1.3.16","packages/multistream-select":"6.0.29","packages/peer-collections":"6.0.35","packages/peer-discovery-bootstrap":"11.0.47","packages/peer-discovery-mdns":"11.0.47","packages/peer-id":"5.1.9","packages/peer-record":"8.0.35","packages/peer-store":"11.2.7","packages/pnet":"2.0.47","packages/protocol-autonat":"2.0.38","packages/protocol-dcutr":"2.0.38","packages/protocol-echo":"2.1.28","packages/protocol-fetch":"3.0.22","packages/protocol-identify":"3.0.39","packages/protocol-perf":"4.0.47","packages/protocol-ping":"2.0.37","packages/floodsub":"10.1.46","packages/record":"4.0.7","packages/stream-multiplexer-mplex":"11.0.47","packages/transport-circuit-relay-v2":"3.2.24","packages/transport-memory":"1.1.14","packages/transport-tcp":"10.1.19","packages/transport-webrtc":"5.2.24","packages/transport-websockets":"9.2.19","packages/transport-webtransport":"5.0.51","packages/upnp-nat":"3.1.22","packages/utils":"6.7.2","packages/protocol-autonat-v2":"1.0.1"}

.release-please.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@
3939
"packages/protocol-identify": {},
4040
"packages/protocol-perf": {},
4141
"packages/protocol-ping": {},
42-
"packages/pubsub": {},
43-
"packages/pubsub-floodsub": {},
42+
"packages/floodsub": {},
4443
"packages/record": {},
4544
"packages/stream-multiplexer-mplex": {},
4645
"packages/transport-circuit-relay-v2": {},

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ You can find multiple examples on the [examples repo](https://github.com/libp2p/
9696
- [`/packages/protocol-echo`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-echo) Implementation of an Echo protocol
9797
- [`/packages/protocol-perf`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-perf) Implementation of the Perf protocol
9898
- [`/packages/pubsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub) libp2p pubsub base class
99-
- [`/packages/pubsub-floodsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) 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).
99+
- [`/packages/floodsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/floodsub) 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).
100100
- [`/packages/record`](https://github.com/libp2p/js-libp2p/tree/main/packages/record) libp2p record implementation
101101
- [`/packages/stream-multiplexer-mplex`](https://github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex) JavaScript implementation of <https://github.com/libp2p/mplex>
102102
- [`/packages/transport-tcp`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp) A TCP transport for libp2p
@@ -174,7 +174,7 @@ List of packages currently in existence for libp2p
174174
| [`@libp2p/peer-record`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-record) | [![npm](https://img.shields.io/npm/v/%40libp2p%2Fpeer-record.svg?maxAge=86400&style=flat-square)](//npmjs.com/package/@libp2p/peer-record) | [![Deps](https://img.shields.io/librariesio/release/npm/%40libp2p%2Fpeer-record?logo=Libraries.io&logoColor=white&style=flat-square)](//libraries.io/npm/%40libp2p%2Fpeer-record) | [![GitHub CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main&label=ci&style=flat-square)](//github.com/libp2p/js-libp2p/actions?query=branch%3Amain+workflow%3Aci+) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-record/branch/main/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-record) |
175175
| **pubsub** |
176176
| [`@chainsafe/libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub) | [![npm](https://img.shields.io/npm/v/%40chainsafe%2Flibp2p-gossipsub.svg?maxAge=86400&style=flat-square)](//npmjs.com/package/@chainsafe/libp2p-gossipsub) | [![Deps](https://img.shields.io/librariesio/release/npm/%40chainsafe%2Flibp2p-gossipsub?logo=Libraries.io&logoColor=white&style=flat-square)](//libraries.io/npm/%40chainsafe%2Flibp2p-gossipsub) | [![GitHub CI](https://img.shields.io/github/actions/workflow/status/ChainSafe/js-libp2p-gossipsub/main.yml?branch=master&label=ci&style=flat-square)](//github.com/ChainSafe/js-libp2p-gossipsub/actions?query=branch%3Amaster+workflow%3Aci+) | [![codecov](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub) |
177-
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) | [![npm](https://img.shields.io/npm/v/%40libp2p%2Ffloodsub.svg?maxAge=86400&style=flat-square)](//npmjs.com/package/@libp2p/floodsub) | [![Deps](https://img.shields.io/librariesio/release/npm/%40libp2p%2Ffloodsub?logo=Libraries.io&logoColor=white&style=flat-square)](//libraries.io/npm/%40libp2p%2Ffloodsub) | [![GitHub CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main&label=ci&style=flat-square)](//github.com/libp2p/js-libp2p/actions?query=branch%3Amain+workflow%3Aci+) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub/branch/main/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) |
177+
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p/tree/main/packages/floodsub) | [![npm](https://img.shields.io/npm/v/%40libp2p%2Ffloodsub.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p/tree/main/packages/floodsub/releases) | [![Deps](https://img.shields.io/librariesio/release/npm/%40libp2p%2Ffloodsub?logo=Libraries.io&logoColor=white&style=flat-square)](//libraries.io/npm/%40libp2p%2Ffloodsub) | [![GitHub CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/tree/main/packages/floodsub/main.yml?branch=main&label=ci&style=flat-square)](//github.com/libp2p/js-libp2p/tree/main/packages/floodsub/actions?query=branch%3Amain+workflow%3Aci+) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/floodsub/branch/main/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/floodsub) |
178178

179179
## Used by
180180

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

packages/pubsub-floodsub/README.md renamed to packages/floodsub/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ Loading this module through a script tag will make its exports available as `Lib
7676

7777
Licensed under either of
7878

79-
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub-floodsub/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
80-
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub-floodsub/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
79+
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/floodsub/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
80+
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/floodsub/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
8181

8282
# Contribution
8383

0 commit comments

Comments
 (0)