Skip to content
This repository has been archived by the owner on Apr 24, 2023. It is now read-only.

Dial using WebRTC without the need to set up any Signalling Rendezvous Point!

License

Unknown and 2 other licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

libp2p/js-libp2p-webrtc-direct

Repository files navigation

⚠️⚠️⚠️⚠️⚠️⚠️

Status:

Archived and not maintained

Alternatives:

WebRTC Browser-to-Server is being implemented in js-libp2p and tracked here libp2p/js-libp2p#1478 per the specification: libp2p/specs#412

WebRTC Browser-to-Browser is being tracked here: libp2p/js-libp2p#1462

Questions:

Please direct any questions about the specification to: https://github.com/libp2p/specs/issues

Please direct any questions about the js-libp2p WebRTC implementations to: libp2p/js-libp2p#1478 or libp2p/js-libp2p#1462

⚠️⚠️⚠️⚠️⚠️⚠️

@libp2p/webrtc-direct

libp2p.io Discuss codecov CI

Dial using WebRTC without the need to set up any Signalling Rendezvous Point!

Table of contents

Install

$ npm i @libp2p/webrtc-direct

Browser <script> tag

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

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

NOTE: To run build scripts node-pre-gyp is required. You can install it by running npm install -g node-pre-gyp.

Usage

import { createLibp2p } from 'libp2p'
import { webRTCDirect } from '@libp2p/webrtc-direct'

const node = await createLibp2p({
  transports: [
    webRTCDirect()
  ]
  //... other config
})
await node.start()
await node.dial('/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct')

API

Transport

Connection

Contribute

The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:

  • Go through the modules and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
  • Perform code reviews.
  • Add tests. There can never be enough tests.

License

Licensed under either of

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.