@libp2p/websockets

@libp2p/websockets

JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec

About

A libp2p transport based on WebSockets.

Example

import { createLibp2p } from 'libp2p'
import { webSockets } from '@libp2p/websockets'
import { multiaddr } from '@multiformats/multiaddr'

const node = await createLibp2p({
  transports: [
    webSockets()
  ]
//... other config
})
await node.start()

const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ws')
await node.dial(ma)

Filters

When run in a browser by default this module will only connect to secure web socket addresses.

To change this you should pass a filter to the factory function.

You can create your own address filters for this transports, or rely in the filters provided.

The available filters are:

• filters.all
  • Returns all TCP and DNS based addresses, both with ws or wss.
• filters.dnsWss
  • Returns all DNS based addresses with wss.
• filters.dnsWsOrWss
  • Returns all DNS based addresses, both with ws or wss.

Example - Allow dialing insecure WebSockets

import { createLibp2p } from 'libp2p'
import { webSockets } from '@libp2p/websockets'
import * as filters from '@libp2p/websockets/filters'

const node = await createLibp2p({
  transports: [
    webSockets({
      // connect to all sockets, even insecure ones
      filter: filters.all
    })
  ]
})

Install

$ npm i @libp2p/websockets

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pWebsockets in the global namespace.

<script src="https://unpkg.com/@libp2p/websockets/dist/index.min.js"></script>

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_websockets.html

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.