Module index

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)
Copy

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
    })
  ]
})
Copy