npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@windingtree/sdk-pubsub

v1.3.6

Published

libp2p PubSub protocol implementation for the WindingTree market protocol

Downloads

46

Readme

@windingtree/sdk-pubsub

This package provides a centralized publish/subscribe protocol (CenterSub) for peer-to-peer communication within a WindingTree network, built on top of the libp2p-gossipsub protocol.

Installation

pnpm i @windingtree/sdk-pubsub

Key concepts

This library introduces a custom PubSub protocol (CenterSub) for the WindingTree network. It is based on the GossipSub protocol from the ChainSafe library but modifies certain aspects to adapt to a centralized system.

The key concepts in this library include:

  1. CenterSub: The main class that extends GossipSub and modifies it to suit a centralized PubSub model.

  2. MessagesCache: A class used to manage and manipulate a cache of messages that are currently being processed by the network.

  3. MessageTransformer: A user-defined function to parse and process incoming messages.

  4. handlePeerConnect, onAddPeer, onRemovePeer, onHandleReceivedMessage, onSelectPeersToPublish: Overridden GossipSub methods to adapt the protocol to the centralized model.

Usage

This package is primarily used to manage the PubSub protocol for a WindingTree network. An instance of the CenterSub class can be created and used for message broadcasting and handling.

import { createLibp2p } from 'libp2p';
import { CenterSubOptions, centerSub } from '@windingtree/sdk-pubsub';

const options: CenterSubOptions = {
  isClient: true,
  directPeers: [...],
  messageTransformer: (message: ArrayBuffer) => {
    // parse and process the message
    return JSON.parse(decodeText(message)) as GenericMessage;
  },
  messagesStorage: new Storage(),
};

const createCenterSubInstance = centerSub(options);

this.libp2p = await createLibp2p({
  transports: [...],
  streamMuxers: [...],
  connectionEncryption: [...],
  services: {
    pubsub: centerSub({ // <-- Using CenterSub as pubsub service
      isClient: true,
      directPeers: [
        {
          id: /* serverPeerId */,
          addrs: [/* serverMultiaddr */],
        },
      ],
    }),
  },
  connectionManager: {...},
);

Documentation

For full documentation and examples, visit windingtree.github.io/sdk

Testing

pnpm test

Contributing

Contribution guidelines