{"id":14483668,"url":"https://github.com/libp2p/js-libp2p-webrtc-direct","last_synced_at":"2025-08-30T04:31:47.473Z","repository":{"id":37484354,"uuid":"78057880","full_name":"libp2p/js-libp2p-webrtc-direct","owner":"libp2p","description":"Dial using WebRTC without the need to set up any Signalling Rendezvous Point!","archived":true,"fork":false,"pushed_at":"2023-04-24T17:36:18.000Z","size":1317,"stargazers_count":78,"open_issues_count":2,"forks_count":19,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-12-20T10:04:04.028Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/libp2p/js-libp2p-webrtc-direct","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libp2p.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-04T22:23:35.000Z","updated_at":"2023-09-21T10:20:32.000Z","dependencies_parsed_at":"2024-06-18T16:42:57.145Z","dependency_job_id":"f65ead24-d66a-488f-81dd-764e2f44dde9","html_url":"https://github.com/libp2p/js-libp2p-webrtc-direct","commit_stats":{"total_commits":106,"total_committers":20,"mean_commits":5.3,"dds":0.7830188679245282,"last_synced_commit":"2569bd568dacefe89a72e66ed59fe107ac6a313d"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-webrtc-direct","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-webrtc-direct/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-webrtc-direct/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libp2p%2Fjs-libp2p-webrtc-direct/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libp2p","download_url":"https://codeload.github.com/libp2p/js-libp2p-webrtc-direct/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231287259,"owners_count":18353174,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-03T00:01:58.198Z","updated_at":"2024-12-27T05:30:27.274Z","avatar_url":"https://github.com/libp2p.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# ⚠️⚠️⚠️⚠️⚠️⚠️  \u003c!-- omit in toc --\u003e\n**Status:**\n\n[Archived](https://github.com/libp2p/github-mgmt/pull/80) and not maintained\n\n**Alternatives:**\n\nWebRTC Browser-to-Server is being implemented in js-libp2p and tracked here https://github.com/libp2p/js-libp2p/issues/1478 per the specification: https://github.com/libp2p/specs/pull/412\n\nWebRTC Browser-to-Browser is being tracked here: https://github.com/libp2p/js-libp2p/issues/1462\n\n**Questions:**\n\nPlease direct any questions about the specification to: https://github.com/libp2p/specs/issues\n\nPlease direct any questions about the js-libp2p WebRTC implementations to:\nhttps://github.com/libp2p/js-libp2p/issues/1478 or\nhttps://github.com/libp2p/js-libp2p/issues/1462\n# ⚠️⚠️⚠️⚠️⚠️⚠️  \u003c!-- omit in toc --\u003e\n\n# @libp2p/webrtc-direct \u003c!-- omit in toc --\u003e\n\n[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)\n[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)\n[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-webrtc-direct.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-webrtc-direct)\n[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-webrtc-direct/js-test-and-release.yml?branch=master\\\u0026style=flat-square)](https://github.com/libp2p/js-libp2p-webrtc-direct/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)\n\n\u003e Dial using WebRTC without the need to set up any Signalling Rendezvous Point!\n\n## Table of contents \u003c!-- omit in toc --\u003e\n\n- [Install](#install)\n  - [Browser `\u003cscript\u003e` tag](#browser-script-tag)\n- [Usage](#usage)\n- [API](#api)\n  - [Transport](#transport)\n  - [Connection](#connection)\n- [Contribute](#contribute)\n- [License](#license)\n- [Contribution](#contribution)\n\n## Install\n\n```console\n$ npm i @libp2p/webrtc-direct\n```\n\n### Browser `\u003cscript\u003e` tag\n\nLoading this module through a script tag will make it's exports available as `Libp2pWebrtcDirect` in the global namespace.\n\n```html\n\u003cscript src=\"https://unpkg.com/@libp2p/webrtc-direct/dist/index.min.js\"\u003e\u003c/script\u003e\n```\n\n![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/connection/img/badge.png)\n![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/transport/img/badge.png)\n\n**NOTE:** To run build scripts `node-pre-gyp` is required. You can install it by running `npm install -g node-pre-gyp`.\n\n## Usage\n\n```js\nimport { createLibp2p } from 'libp2p'\nimport { webRTCDirect } from '@libp2p/webrtc-direct'\n\nconst node = await createLibp2p({\n  transports: [\n    webRTCDirect()\n  ]\n  //... other config\n})\nawait node.start()\nawait node.dial('/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct')\n```\n\n## API\n\n### Transport\n\n[![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/transport/img/badge.png)](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport)\n\n### Connection\n\n[![](https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/connection/img/badge.png)](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/connection)\n\n## Contribute\n\nThe libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:\n\n- 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.\n- **Perform code reviews**.\n- **Add tests**. There can never be enough tests.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT ([LICENSE-MIT](LICENSE-MIT) / \u003chttp://opensource.org/licenses/MIT\u003e)\n\n## Contribution\n\nUnless 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibp2p%2Fjs-libp2p-webrtc-direct","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibp2p%2Fjs-libp2p-webrtc-direct","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibp2p%2Fjs-libp2p-webrtc-direct/lists"}