Skip to content
This repository was archived by the owner on Feb 24, 2021. It is now read-only.

Commit 0d1ffa7

Browse files
Merge pull request #76 from marten-seemann/deprecate
add deprecation notices to Transport, the constructor and the README
2 parents 702833a + d2369dc commit 0d1ffa7

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# DEPRECATION NOTICE
2+
3+
secio is not maintained any more, and we advise against using it.
4+
5+
Use [go-libp2p-tls](https://github.com/libp2p/go-libp2p-tls/) and [go-libp2p-noise](https://github.com/libp2p/go-libp2p-noise/) instead.
6+
7+
18
# go-libp2p-secio
29

310
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)

transport.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ import (
1414
// ID is secio's protocol ID (used when negotiating with multistream)
1515
const ID = "/secio/1.0.0"
1616

17-
// SessionGenerator constructs secure communication sessions for a peer.
17+
// Deprecated: secio is now deprecated.
18+
// Use TLS 1.3 (https://github.com/libp2p/go-libp2p-tls/) and Noise (https://github.com/libp2p/go-libp2p-noise/) instead.
1819
type Transport struct {
1920
LocalID peer.ID
2021
PrivateKey ci.PrivKey
2122
}
2223

24+
// Deprecated: secio is now deprecated.
25+
// Use TLS 1.3 (https://github.com/libp2p/go-libp2p-tls/) and Noise (https://github.com/libp2p/go-libp2p-noise/) instead.
2326
func New(sk ci.PrivKey) (*Transport, error) {
2427
id, err := peer.IDFromPrivateKey(sk)
2528
if err != nil {

0 commit comments

Comments
 (0)