@libp2p/websockets NPM

@libp2p/websockets

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

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>

Usage

> npm i @libp2p/websockets

Constructor properties

import { createLibp2pNode } from 'libp2p'
import { webSockets } from '@libp2p/webrtc-direct'

const node = await createLibp2p({
  transports: [
    webSockets()
  ]
  //... other config
})
await node.start()
await node.dial('/ip4/127.0.0.1/tcp/9090/ws')

Name	Type	Description	Default
upgrader	`Upgrader`	connection upgrader object with `upgradeOutbound` and `upgradeInbound`	REQUIRED
filter	`(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>`	override transport addresses filter	Browser: DNS+WSS multiaddrs / Node.js: DNS+[WS, WSS] multiaddrs

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.

Libp2p Usage Example

import { createLibp2pNode } from 'libp2p'
import { websockets } from '@libp2p/websockets'
import filters from '@libp2p/websockets/filters'
import { mplex } from '@libp2p/mplex'
import { noise } from '@libp2p/noise'

const transportKey = Websockets.prototype[Symbol.toStringTag]
const node = await Libp2p.create({
  transport: [
    websockets({
      // connect to all sockets, even insecure ones
      filters: filters.all
    })
  ],
  streamMuxers: [
    mplex()
  ],
  connectionEncryption: [
    noise()
  ]
})

For more information see libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-transports.

API

Transport

Connection

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.

IPFS

@libp2p/interface @libp2p/utils @multiformats/mafmt @multiformats/multiaddr @multiformats/multiaddr-to-uri @types/ws it-ws p-defer wherearewe ws

@everything-registry/sub-chunk-546 ipfs-node js-chaintalk-utils js-cmnctr js-cmnctra helia ipfs-core ipdw ipfs-interop js-waku interface-ipfs-core rivalz-client-node-lib rivalz-client-node peer-cli peerbit mt-libp2p mtxp2p metapoint moonbase-js rivalz-client-lib rivalz-node-cli rivalz-node-client @libp2p/amino-dht-bootstrapper @libp2p/multidim-interop @peerbit/libp2p-test-utils @filecoin-renewable-energy-purchases/js-api zkdatabase @futureverse/sylo-protocol-sdk @questflow/deworker-cli @sarcophagus-org/sarcophagus-v2-sdk @sarcophagus-org/sarcophagus-v2-sdk-client @satellite-im/iridium @fluencelabs/js-client @fluencelabs/js-peer @nabladelta/lambdadelta walletdrop @dstanesc/ipfs-core-store-access @dwn-protocol/dwn @dwn-protocol/id-sdk @helia/cli-utils @helia/interop @eridanus-network/js-core.peer @heirtrust/heirtrust-sdk @abaxx/sdk @0xvaibhav/libp2p-events @0xvaibhav/libp2p-events-client @waku/create @waku/sdk @tabcat/zzzync @veramo/libp2p-client @veramo/libp2p-utils @veramo/libp2p-utils-browser @windingtree/sdk @windingtree/sdk-client @windingtree/sdk-node @windingtree/sdk-server @zalastax/nolb-_lib @blockless/browser-node @canvas-js/core @soketi/p2p @badaimweeb/js-protov2 @autismjs/protocol @co2-storage/js-api @constl/ipa @dao-xyz/peerbit-libp2p @drtc/relay @drtc/relay-node @drtc/tests @drtc/bootstrap @drtc/bootstrap-node @drtc/create @djack-sdk/server @djack-sdk/signal @douganderson444/ipfs-core @dreamcatcher-tech/interblock chatternet-lib chaintalk-utils chaintalk-lib chaintalk-relay dagula decontact denetwork-lib denetwork-relay denetwork-utils

23 hours ago

1 day ago

1 day ago

2 days ago

2 days ago

2 days ago

6 days ago

6 days ago

7 days ago

8 days ago

8 days ago

8 days ago

9 days ago

10 days ago

10 days ago

16 days ago

16 days ago

17 days ago

17 days ago

20 days ago

20 days ago

20 days ago

23 days ago

23 days ago

24 days ago

27 days ago

27 days ago

28 days ago

29 days ago

30 days ago

30 days ago

1 month ago

30 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

7 months ago

6 months ago

8 months ago

6 months ago

10 months ago

5 months ago

5 months ago

7 months ago

5 months ago

6 months ago

6 months ago

5 months ago

9 months ago

8 months ago

7 months ago

9 months ago

7 months ago

8 months ago

9 months ago

5 months ago

9 months ago

9 months ago

5 months ago

9 months ago

6 months ago

9 months ago

6 months ago

5 months ago

8 months ago

6 months ago

6 months ago

9 months ago

6 months ago

9 months ago

9 months ago

5 months ago

5 months ago

9 months ago

6 months ago

8 months ago

6 months ago

6 months ago

6 months ago

6 months ago

9 months ago

5 months ago

9 months ago

9 months ago

5 months ago

7 months ago

10 months ago

5 months ago

9 months ago

9 months ago

5 months ago

8 months ago

10 months ago

8 months ago

9 months ago

9 months ago

6 months ago

6 months ago

7 months ago

8 months ago

6 months ago

9 months ago

5 months ago

8 months ago

9 months ago

5 months ago

8 months ago

9 months ago

7 months ago

7 months ago

8 months ago

5 months ago

6 months ago

7 months ago

9 months ago

8 months ago

5 months ago

6 months ago

8 months ago

10 months ago

9 months ago

7 months ago

7 months ago

6 months ago

9 months ago

5 months ago

9 months ago

9 months ago

8 months ago

5 months ago

8 months ago

9 months ago

5 months ago

8 months ago

7 months ago

9 months ago

8 months ago

7 months ago

5 months ago

8 months ago

9 months ago

5 months ago

7 months ago

7 months ago

9 months ago

6 months ago

8 months ago

8 months ago

8 months ago

9 months ago

6 months ago

7 months ago

7 months ago

6 months ago

9 months ago

9 months ago

8 months ago

5 months ago

10 months ago

10 months ago

5 months ago

7 months ago

7 months ago

6 months ago

9 months ago

5 months ago

6 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

8 months ago

9 months ago

8 months ago

9 months ago

6 months ago

9 months ago

9 months ago

7 months ago

6 months ago

6 months ago

8 months ago

5 months ago

6 months ago

5 months ago

9 months ago

6 months ago

9 months ago

8 months ago

10 months ago

8 months ago

8 months ago

5 months ago

7 months ago

8 months ago

5 months ago

7 months ago

6 months ago

8 months ago

6 months ago

7 months ago

5 months ago

5 months ago

9 months ago

5 months ago

6 months ago

8 months ago

5 months ago

7 months ago

6 months ago

9 months ago

5 months ago

5 months ago

8 months ago

8 months ago

7 months ago

5 months ago

5 months ago

5 months ago

8 months ago

5 months ago

9 months ago

9 months ago

5 months ago

9 months ago

5 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

@libp2p/websockets v8.0.22