Socket
Socket
Sign inDemoInstall

@truffle/dashboard-message-bus-common

Package Overview
Dependencies
0
Maintainers
9
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @truffle/dashboard-message-bus-common

Message types that are used when communicating with the Truffle dashboard message bus


Version published
Weekly downloads
9.6K
decreased by-5.51%
Maintainers
9
Install size
12.0 kB
Created
Weekly downloads
 

Readme

Source

@truffle/dashboard-message-bus-common

:warning: This is a middleware package and should only be used when developing integrations for the truffle dashboard :warning:

This package serves as a set of common types to be shared between packages like @truffle/dashboard-message-bus and @truffle/dashboard-message-bus-client

Installation

If you are building a package that needs to interface with the Dashboard or message bus, you can install this package from NPM.

npm install @truffle/dashboard-message-bus-common
yarn add @truffle/dashboard-message-bus-common

Adding new message types

Right now there are very few message types. The most important one is "provider", which sends RPC requests for the dashboard-provider. Other message types are "invalidate", which can be sent to invalidate earlier messages, and "log", which is sent by the message bus to send log messages over the wire. The interfaces of these messages are defined inside of this package, from where they can be imported by consumers.

To add additional message types, the interface for the new message type should be defined in this package under lib/messages.ts. To use these new messge formats, support needs to be added to any consuming packages such as @truffle/dashboard as well.

FAQs

Last updated on 07 Sep 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc