Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libp2p/js-libp2p-websockets
WebSockets module that libp2p uses and that implements the interface-transport spec
https://github.com/libp2p/js-libp2p-websockets
Last synced: 3 months ago
JSON representation
WebSockets module that libp2p uses and that implements the interface-transport spec
- Host: GitHub
- URL: https://github.com/libp2p/js-libp2p-websockets
- Owner: libp2p
- License: other
- Archived: true
- Created: 2016-02-25T12:21:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T15:50:51.000Z (over 1 year ago)
- Last Synced: 2024-08-30T05:41:55.736Z (4 months ago)
- Language: TypeScript
- Homepage: https://libp2p.io
- Size: 1.51 MB
- Stars: 95
- Watchers: 20
- Forks: 46
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📁 Archived - this module has been merged into [js-libp2p](https://github.com/libp2p/js-libp2p/tree/master/packages/transport-websockets)
# @libp2p/websockets
[](http://libp2p.io/)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-libp2p-websockets)
[](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec
## Table of contents
- [Install](#install)
- [Browser `` tag](#browser-script-tag)
- [Usage](#usage)
- [Constructor properties](#constructor-properties)
- [Libp2p Usage Example](#libp2p-usage-example)
- [API](#api)
- [Transport](#transport)
- [Connection](#connection)
- [API Docs](#api-docs)
- [License](#license)
- [Contribution](#contribution)
## Install
```console
$ 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.
```html
<script src="https://unpkg.com/@libp2p/websockets/dist/index.min.js">
```
[](https://github.com/libp2p/interface-transport)
[](https://github.com/libp2p/interface-connection)
## Usage
```sh
> npm i @libp2p/websockets
```
### Constructor properties
```js
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`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** |
| filter | `(multiaddrs: Array) => Array` | 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](./src/filters.js).
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
```js
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](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#customizing-transports).
## API
### Transport
[](https://github.com/libp2p/interface-transport)
### Connection
[](https://github.com/libp2p/interface-connection)
## API Docs
-
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-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.