diff --git a/.gitignore b/.gitignore index 910f633..7ad9e67 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ dist node_modules package-lock.json yarn.lock +.vscode diff --git a/README.md b/README.md index 88a9474..1c561ef 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ - [Connection](#connection) - [API Docs](#api-docs) - [License](#license) -- [Contribute](#contribute) +- [Contribution](#contribution) ## Install @@ -60,10 +60,10 @@ 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 | +| 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). @@ -125,6 +125,6 @@ Licensed under either of - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) - MIT ([LICENSE-MIT](LICENSE-MIT) / ) -## Contribute +## 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. diff --git a/package.json b/package.json index 50f8031..69deeb2 100644 --- a/package.json +++ b/package.json @@ -159,32 +159,32 @@ "docs": "aegir docs" }, "dependencies": { - "@libp2p/interface-connection": "^4.0.0", - "@libp2p/interface-transport": "^2.0.0", + "@libp2p/interface-connection": "^5.0.0", + "@libp2p/interface-transport": "^3.0.0", "@libp2p/interfaces": "^3.0.3", "@libp2p/logger": "^2.0.0", "@libp2p/utils": "^3.0.2", "@multiformats/mafmt": "^12.0.0", "@multiformats/multiaddr": "^12.0.0", "@multiformats/multiaddr-to-uri": "^9.0.2", - "abortable-iterator": "^4.0.2", - "it-ws": "^5.0.6", + "abortable-iterator": "^5.0.0", + "it-ws": "^6.0.0", "p-defer": "^4.0.0", "p-timeout": "^6.0.0", "wherearewe": "^2.0.1", "ws": "^8.12.1" }, "devDependencies": { - "@libp2p/interface-mocks": "^9.1.3", + "@libp2p/interface-mocks": "^10.0.0", "@libp2p/interface-transport-compliance-tests": "^3.0.0", "@types/ws": "^8.2.2", "aegir": "^38.1.7", "is-loopback-addr": "^2.0.1", "it-all": "^3.0.1", - "it-drain": "^2.0.0", + "it-drain": "^3.0.1", "it-goodbye": "^4.0.1", - "it-pipe": "^2.0.3", - "it-stream-types": "^1.0.4", + "it-pipe": "^3.0.1", + "it-stream-types": "^2.0.1", "p-wait-for": "^5.0.0", "uint8arraylist": "^2.3.2", "uint8arrays": "^4.0.2"