@libp2p/webtransport

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

About

A libp2p transport based on WebTransport.

⚠️ Note

This WebTransport implementation currently only allows dialing to other nodes. It does not yet allow listening for incoming dials. This feature requires QUIC support to land in Node JS first.

QUIC support in Node JS is actively being worked on. You can keep an eye on the progress by watching the related issues on the Node JS issue tracker

Example

import { createLibp2p } from 'libp2p'
import { webTransport } from '@libp2p/webtransport'
import { noise } from '@chainsafe/libp2p-noise'

const node = await createLibp2p({
  transports: [
    webTransport()
  ],
  connectionEncrypters: [
    noise()
  ]
})
Copy

Install

$ npm i @libp2p/webtransport
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as Libp2pWebtransport in the global namespace.

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

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_webtransport.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.