Merge pull request #76 from marten-seemann/deprecate

add deprecation notices to Transport, the constructor and the README
libp2p · Feb 24, 2021 · 0d1ffa7 · 0d1ffa7
2 parents 702833a + d2369dc
commit 0d1ffa7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,10 @@
+# DEPRECATION NOTICE
+
+secio is not maintained any more, and we advise against using it.
+
+Use [go-libp2p-tls](https://github.com/libp2p/go-libp2p-tls/) and [go-libp2p-noise](https://github.com/libp2p/go-libp2p-noise/) instead.
+
+
 # go-libp2p-secio
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)

diff --git a/transport.go b/transport.go
@@ -14,12 +14,15 @@ import (
 // ID is secio's protocol ID (used when negotiating with multistream)
 const ID = "/secio/1.0.0"
 
-// SessionGenerator constructs secure communication sessions for a peer.
+// Deprecated: secio is now deprecated.
+// Use TLS 1.3 (https://github.com/libp2p/go-libp2p-tls/) and Noise (https://github.com/libp2p/go-libp2p-noise/) instead.
 type Transport struct {
 	LocalID    peer.ID
 	PrivateKey ci.PrivKey
 }
 
+// Deprecated: secio is now deprecated.
+// Use TLS 1.3 (https://github.com/libp2p/go-libp2p-tls/) and Noise (https://github.com/libp2p/go-libp2p-noise/) instead.
 func New(sk ci.PrivKey) (*Transport, error) {
 	id, err := peer.IDFromPrivateKey(sk)
 	if err != nil {