shared types used by the libp2p webrtc transport and signalling server
npm install @libp2p/webrtc-star-protocol
> shared types used by the libp2p webrtc transport and signalling server
- Install
- Description
- Protocol
- License
- Contribution
``console`
$ npm i @libp2p/webrtc-star-protocol
This module contains type definitions for the websocket events that are exchanged between peers during the handshake process.
1. Peers connect to the same signal server and send an ss-join event with their multiaddr as a stringss-handshake
2. Peers send one or more events with candidate signalsws-handshake
3. Peers receive one or more events with candidate signalsss-handshake
4. Peers send one event with an offer signalws-handshake
5. Peers receive one events with an offer signalws-peer
6. Peers are now connected
7. Peers receive one or more events with a multiaddr as a string for peer discoveryss-leave
8. Peers send an event or disconnect when hanging up
See ./src/index.ts for definitions of ss-handshake and ws-handshake` payloads.
Licensed under either of
- Apache 2.0, (LICENSE-APACHE /
- MIT (LICENSE-MIT /
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.