Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChainSafe/js-libp2p-gossipsub
TypeScript implementation of Gossipsub
https://github.com/ChainSafe/js-libp2p-gossipsub
gossip-protocol javascript libp2p networking p2p peer-to-peer pubsub
Last synced: 3 months ago
JSON representation
TypeScript implementation of Gossipsub
- Host: GitHub
- URL: https://github.com/ChainSafe/js-libp2p-gossipsub
- Owner: ChainSafe
- License: apache-2.0
- Created: 2018-08-10T23:53:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T17:12:45.000Z (8 months ago)
- Last Synced: 2024-04-13T22:23:46.220Z (8 months ago)
- Topics: gossip-protocol, javascript, libp2p, networking, p2p, peer-to-peer, pubsub
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 131
- Watchers: 16
- Forks: 39
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# js-libp2p-gossipsub
[](https://chainsafe.io/)
[](https://travis-ci.com/ChainSafe/gossipsub-js)
## Table of Contents
- [js-libp2p-gossipsub](#js-libp2p-gossipsub)
- [Lead Maintainer](#lead-maintainer)
- [Table of Contents](#table-of-contents)
- [Specs](#specs)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Create a gossipsub implementation](#create-a-gossipsub-implementation)
- [Contribute](#contribute)
- [License](#license)
## Specs
Gossipsub is an implementation of pubsub based on meshsub and floodsub. You can read the specification [here](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub).
`libp2p-gossipsub` currently implements the [`v1.1`](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md) of the spec.
## Install
`npm install @chainsafe/libp2p-gossipsub`
## Usage
```javascript
import { gossipsub } from '@chainsafe/libp2p-gossipsub'
const libp2p = await createLibp2p({
// ...
services: {
pubsub: gossipsub(options)
}
});
libp2p.services.pubsub.addEventListener('message', (message) => {
console.log(`${message.detail.topic}:`, new TextDecoder().decode(message.detail.data))
})
libp2p.services.pubsub.subscribe('fruit')
libp2p.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
```
## API
### Create a gossipsub implementation
```js
const options = {…}
const gossipsub = gossipsub(options)(libp2p)
```
Options is an optional object with the following key-value pairs:
- **`emitSelf`**: boolean identifying whether the node should emit to self on publish, in the event of the topic being subscribed (defaults to **false**).
- **`gossipIncoming`**: boolean identifying if incoming messages on a subscribed topic should be automatically gossiped (defaults to **true**).
- **`fallbackToFloodsub`**: boolean identifying whether the node should fallback to the floodsub protocol, if another connecting peer does not support gossipsub (defaults to **true**).
- **`floodPublish`**: boolean identifying if self-published messages should be sent to all peers, (defaults to **true**).
- **`doPX`**: boolean identifying whether PX is enabled; this should be enabled in bootstrappers and other well connected/trusted nodes (defaults to **false**).
- **`msgIdFn`**: a function with signature `(message) => string` defining the message id given a message, used internally to deduplicate gossip (defaults to `(message) => message.from + message.seqno.toString('hex')`)
- **`signMessages`**: boolean identifying if we want to sign outgoing messages or not (default: `true`)
- **`strictSigning`**: boolean identifying if message signing is required for incoming messages or not (default: `true`)
- **`messageCache`**: optional, a customized `MessageCache` instance, see the implementation for the interface.
- **`scoreParams`**: optional, a customized peer score parameters Object.
- **`scoreThresholds`**: optional, a customized peer score thresholds Object.
- **`directPeers`**: optional, an array of `AddrInfo` of peers with which we will maintain direct connections.
For the remaining API, see [@libp2p/interface-pubsub](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interface-pubsub).
## Contribute
This module is actively under development. Please check out the issues and submit PRs!
## License
MIT © ChainSafe Systems