@ipshipyard/libp2p-devtools

@ipshipyard/libp2p-devtools

Browser DevTools plugin to inspect a libp2p node running on the current page

About

A DevTools plugin that adds a "libp2p" tab to your developer tools that contacts a libp2p node running on the current page.

Works with @ipshipyard/libp2p-inspector-metrics which supplies metrics and allows us to interact with the running node.

Installation instructions

1. Browser installation

Until this plugin is published on the relevant browser plugin stores, please run this locally.

• Clone this repo
• Run npm i && npm run build
• Install as an unpacked/temporary add on for your browser:

• Chrome: How to load an unpacked extension
• Firefox: How to install temporary add-ons

2. App installation

Configure @ipshipyard/libp2p-inspector-metrics as your metrics implementation:

import { createLibp2p } from 'libp2p'
import { inspectorMetrics } from '@ipshipyard/libp2p-inspector-metrics'

const node = await createLibp2p({
  metrics: inspectorMetrics(),
  //... other options her
})

3. Permissions

With the move to Manifest v3, users must now opt in to running content scripts on a page.

Chrome

Please click the extensions button, then grant the extension permission to run:

Firefox

Please click the extensions button, then grant the extension permission to run:

4. Go!

Browse to your webapp and open the DevTools, you should see a "libp2p" tab towards the right hand side of the toolbar. Click it to see stats about the running node.

What's next?

• Tests

• There aren't a lot of tests here yet

• Better UI

• It's quite rough

• Graphs

• We don't do much with the collected metrics yet. It would be nice to use Chart.js or similar to show some useful graphs
• Bonus points for letting the user define their own graphs a la Grafana/Prometheus
• More bonus points for being able to export/import graph configs

• Dynamic panels

• We should be able to inspect the libp2p node's configured services (or protocols?) and, for example, only show a DHT tab if the DHT is configured

• Light theme support

• There are partial overrides for light theme font/background/border colors but we need better detection of when it's enabled

• ??? more features here

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.