chore: update docs after secio deprecation announcement (#745)

This commit is contained in:
Vasco Santos 2020-09-08 14:07:06 +02:00 committed by GitHub
parent bd26bde876
commit 63ba2f8fa3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 36 additions and 36 deletions

View File

@ -2,7 +2,7 @@
* [Static Functions](#static-functions) * [Static Functions](#static-functions)
* [`create`](#create) * [`create`](#create)
* [Instance Methods](#instance-methods) * [Instance Methods](#libp2p-instance-methods)
* [`start`](#start) * [`start`](#start)
* [`stop`](#stop) * [`stop`](#stop)
* [`dial`](#dial) * [`dial`](#dial)

View File

@ -98,7 +98,7 @@ If you want to know more about libp2p stream multiplexing, you should read the f
Some available connection encryption protocols: Some available connection encryption protocols:
- [NodeFactoryIo/js-libp2p-noise](https://github.com/NodeFactoryIo/js-libp2p-noise) - [NodeFactoryIo/js-libp2p-noise](https://github.com/NodeFactoryIo/js-libp2p-noise)
- [libp2p/js-libp2p-secio](https://github.com/libp2p/js-libp2p-secio) - [libp2p/js-libp2p-secio](https://github.com/libp2p/js-libp2p-secio) ⚠️ [DEPRECATED](https://blog.ipfs.io/2020-08-07-deprecating-secio)
If none of the available connection encryption mechanisms fulfills your needs, you can create a libp2p compatible one. A libp2p connection encryption protocol just needs to be compliant with the [Crypto Interface](https://github.com/libp2p/js-interfaces/tree/master/src/crypto). If none of the available connection encryption mechanisms fulfills your needs, you can create a libp2p compatible one. A libp2p connection encryption protocol just needs to be compliant with the [Crypto Interface](https://github.com/libp2p/js-interfaces/tree/master/src/crypto).
@ -232,7 +232,7 @@ const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const WS = require('libp2p-websockets') const WS = require('libp2p-websockets')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const MulticastDNS = require('libp2p-mdns') const MulticastDNS = require('libp2p-mdns')
const DHT = require('libp2p-kad-dht') const DHT = require('libp2p-kad-dht')
const GossipSub = require('libp2p-gossipsub') const GossipSub = require('libp2p-gossipsub')
@ -244,7 +244,7 @@ const node = await Libp2p.create({
new WS() // It can take instances too! new WS() // It can take instances too!
], ],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
peerDiscovery: [MulticastDNS], peerDiscovery: [MulticastDNS],
dht: DHT, dht: DHT,
pubsub: GossipSub pubsub: GossipSub
@ -258,14 +258,14 @@ const node = await Libp2p.create({
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const MulticastDNS = require('libp2p-mdns') const MulticastDNS = require('libp2p-mdns')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
peerDiscovery: [MulticastDNS] peerDiscovery: [MulticastDNS]
}, },
config: { config: {
@ -291,7 +291,7 @@ const Libp2p = require('libp2p')
const WS = require('libp2p-websockets') const WS = require('libp2p-websockets')
const WebRTCStar = require('libp2p-webrtc-star') const WebRTCStar = require('libp2p-webrtc-star')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
@ -300,7 +300,7 @@ const node = await Libp2p.create({
WebRTCStar WebRTCStar
], ],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
}, },
config: { config: {
peerDiscovery: { peerDiscovery: {
@ -318,14 +318,14 @@ const node = await Libp2p.create({
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const GossipSub = require('libp2p-gossipsub') const GossipSub = require('libp2p-gossipsub')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
pubsub: GossipSub pubsub: GossipSub
}, },
config: { config: {
@ -345,14 +345,14 @@ const node = await Libp2p.create({
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const DHT = require('libp2p-kad-dht') const DHT = require('libp2p-kad-dht')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
dht: DHT dht: DHT
}, },
config: { config: {
@ -375,7 +375,7 @@ const node = await Libp2p.create({
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const DelegatedPeerRouter = require('libp2p-delegated-peer-routing') const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
const DelegatedContentRouter = require('libp2p-delegated-content-routing') const DelegatedContentRouter = require('libp2p-delegated-content-routing')
const PeerId = require('peer-id') const PeerId = require('peer-id')
@ -387,7 +387,7 @@ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO], connEncryption: [NOISE],
contentRouting: [ contentRouting: [
new DelegatedContentRouter(peerId) new DelegatedContentRouter(peerId)
], ],
@ -405,13 +405,13 @@ const node = await Libp2p.create({
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
config: { config: {
relay: { // Circuit Relay options (this config is part of libp2p core configurations) relay: { // Circuit Relay options (this config is part of libp2p core configurations)
@ -438,14 +438,14 @@ Libp2p allows you to setup a secure keychain to manage your keys. The keychain c
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const LevelStore = require('datastore-level') const LevelStore = require('datastore-level')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
keychain: { keychain: {
pass: 'notsafepassword123456789', pass: 'notsafepassword123456789',
@ -472,13 +472,13 @@ The below configuration example shows how the dialer should be configured, with
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
dialer: { dialer: {
maxParallelDials: 100, maxParallelDials: 100,
@ -495,13 +495,13 @@ The Connection Manager prunes Connections in libp2p whenever certain limits are
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
connectionManager: { connectionManager: {
maxConnections: Infinity, maxConnections: Infinity,
@ -526,7 +526,7 @@ The Transport Manager is responsible for managing the libp2p transports life cyc
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const { FaultTolerance } = require('libp2p/src/transport-manager')} const { FaultTolerance } = require('libp2p/src/transport-manager')}
@ -534,7 +534,7 @@ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
transportManager: { transportManager: {
faultTolerance: FaultTolerance.NO_FATAL faultTolerance: FaultTolerance.NO_FATAL
@ -560,13 +560,13 @@ The below configuration example shows how the metrics should be configured. Asid
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
metrics: { metrics: {
enabled: true, enabled: true,
@ -599,7 +599,7 @@ The below configuration example shows how the PeerStore should be configured. As
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const TCP = require('libp2p-tcp') const TCP = require('libp2p-tcp')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const LevelStore = require('datastore-level') const LevelStore = require('datastore-level')
@ -607,7 +607,7 @@ const node = await Libp2p.create({
modules: { modules: {
transport: [TCP], transport: [TCP],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
datastore: new LevelStore('path/to/store'), datastore: new LevelStore('path/to/store'),
peerStore: { peerStore: {
@ -625,7 +625,7 @@ Some Transports can be passed additional options when they are created. For exam
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const WebRTCStar = require('libp2p-webrtc-star') const WebRTCStar = require('libp2p-webrtc-star')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const wrtc = require('wrtc') const wrtc = require('wrtc')
const transportKey = WebRTCStar.prototype[Symbol.toStringTag] const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
@ -633,7 +633,7 @@ const node = await Libp2p.create({
modules: { modules: {
transport: [WebRTCStar], transport: [WebRTCStar],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
connEncryption: [SECIO] connEncryption: [NOISE]
}, },
config: { config: {
transport: { transport: {

View File

@ -112,13 +112,13 @@ npm install libp2p-mplex
```js ```js
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const WebSockets = require('libp2p-websockets') const WebSockets = require('libp2p-websockets')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [WebSockets], transport: [WebSockets],
connEncryption: [SECIO], connEncryption: [NOISE],
streamMuxer: [MPLEX] streamMuxer: [MPLEX]
} }
}) })
@ -139,7 +139,7 @@ Now that you have configured a [**Transport**][transport], [**Crypto**][crypto]
```js ```js
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const WebSockets = require('libp2p-websockets') const WebSockets = require('libp2p-websockets')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const node = await Libp2p.create({ const node = await Libp2p.create({
@ -148,7 +148,7 @@ const node = await Libp2p.create({
}, },
modules: { modules: {
transport: [WebSockets], transport: [WebSockets],
connEncryption: [SECIO], connEncryption: [NOISE],
streamMuxer: [MPLEX] streamMuxer: [MPLEX]
} }
}) })
@ -197,7 +197,7 @@ We can provide specific configurations for each protocol within a `config.peerDi
```js ```js
const Libp2p = require('libp2p') const Libp2p = require('libp2p')
const WebSockets = require('libp2p-websockets') const WebSockets = require('libp2p-websockets')
const SECIO = require('libp2p-secio') const { NOISE } = require('libp2p-noise')
const MPLEX = require('libp2p-mplex') const MPLEX = require('libp2p-mplex')
const Bootstrap = require('libp2p-bootstrap') const Bootstrap = require('libp2p-bootstrap')
@ -211,7 +211,7 @@ const bootstrapMultiaddrs = [
const node = await Libp2p.create({ const node = await Libp2p.create({
modules: { modules: {
transport: [WebSockets], transport: [WebSockets],
connEncryption: [SECIO], connEncryption: [NOISE],
streamMuxer: [MPLEX], streamMuxer: [MPLEX],
peerDiscovery: [Bootstrap] peerDiscovery: [Bootstrap]
}, },