Commit d2369dc6 authored by Marten Seemann's avatar Marten Seemann

add deprecation notices to Transport, the constructor and the README

parent 702833a5
# 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)
......
......@@ -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 {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment