From cfcf0230b2f5f11ed6dd060f97305faa973abed2 Mon Sep 17 00:00:00 2001 From: Prithvi Shahi <50885601+p-shahi@users.noreply.github.com> Date: Sun, 27 Nov 2022 18:35:02 -0800 Subject: [PATCH] chore: update lifecycle and maturity (#484) --- addressing/README.md | 44 +++++++++++++++++------------------- autonat/README.md | 6 ++--- connections/hole-punching.md | 6 ++--- relay/DCUtR.md | 22 ++++++++---------- relay/circuit-v2.md | 12 ++++++---- tls/tls.md | 30 ++++++++++++------------ webrtc/README.md | 1 + webtransport/README.md | 2 +- 8 files changed, 62 insertions(+), 61 deletions(-) diff --git a/addressing/README.md b/addressing/README.md index f62738aa0..72023bd5e 100644 --- a/addressing/README.md +++ b/addressing/README.md @@ -1,9 +1,9 @@ -# Addressing in libp2p +# Addressing in libp2p > How network addresses are encoded and used in libp2p -| Lifecycle Stage | Maturity | Status | Latest Revision | -|-----------------|---------------|--------|-----------------| -| 1A | Recommendation | Active | r0, 2021-07-22 | +| Lifecycle Stage | Maturity | Status | Latest Revision | +|-----------------|----------------|--------|-----------------| +| 3A | Recommendation | Active | r0, 2021-07-22 | Authors: [@yusefnapora] @@ -18,25 +18,23 @@ and spec status. [lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md -## Table of Contents - -- [Addressing in libp2p](#addressing-in-libp2p) - - [Table of Contents](#table-of-contents) - - [Overview](#overview) - - [multiaddr in libp2p](#multiaddr-in-libp2p) - - [multiaddr basics](#multiaddr-basics) - - [Composing multiaddrs](#composing-multiaddrs) - - [Encapsulation](#encapsulation) - - [Decapsulation](#decapsulation) - - [The p2p multiaddr](#the-p2p-multiaddr) - - [Historical Note: the `ipfs` multiaddr Protocol](#historical-note-the-ipfs-multiaddr-protocol) - - [Transport multiaddrs](#transport-multiaddrs) - - [IP and Name Resolution](#ip-and-name-resolution) - - [dnsaddr Links](#dnsaddr-links) - - [TCP](#tcp) - - [WebSockets](#websockets) - - [QUIC](#quic) - - [`p2p-circuit` Relay Addresses](#p2p-circuit-relay-addresses) +## Table of Contents + +- [Overview](#overview) +- [multiaddr in libp2p](#multiaddr-in-libp2p) + - [multiaddr basics](#multiaddr-basics) + - [Composing multiaddrs](#composing-multiaddrs) + - [Encapsulation](#encapsulation) + - [Decapsulation](#decapsulation) + - [The p2p multiaddr](#the-p2p-multiaddr) + - [Historical Note: the `ipfs` multiaddr Protocol](#historical-note-the-ipfs-multiaddr-protocol) +- [Transport multiaddrs](#transport-multiaddrs) + - [IP and Name Resolution](#ip-and-name-resolution) + - [dnsaddr Links](#dnsaddr-links) + - [TCP](#tcp) + - [WebSockets](#websockets) + - [QUIC](#quic) + - [`p2p-circuit` Relay Addresses](#p2p-circuit-relay-addresses) ## Overview diff --git a/autonat/README.md b/autonat/README.md index eabb435d5..86f1a72d7 100644 --- a/autonat/README.md +++ b/autonat/README.md @@ -1,9 +1,9 @@ -# NAT Discovery +# NAT Discovery > How we detect if we're behind a NAT. | Lifecycle Stage | Maturity | Status | Latest Revision | |-----------------|----------------|--------|-----------------| -| 1A | Recommendation | Active | r0, 2021-08-26 | +| 3A | Recommendation | Active | r0, 2021-08-26 | Authors: [@marten-seemann] @@ -22,7 +22,7 @@ and spec status. [lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md -## Table of Contents +## Table of Contents - [Overview](#overview) - [AutoNAT Protocol](#autonat-protocol) diff --git a/connections/hole-punching.md b/connections/hole-punching.md index 44e08cff3..9cfae8935 100644 --- a/connections/hole-punching.md +++ b/connections/hole-punching.md @@ -1,9 +1,9 @@ # Hole punching -| Lifecycle Stage | Maturity | Status | Latest Revision | -|-----------------|---------------|--------|-----------------| -| 1A | Working Draft | Active | r1, 2022-06-13 | +| Lifecycle Stage | Maturity | Status | Latest Revision | +|-----------------|----------------|--------|-----------------| +| 3A | Recommendation | Active | r1, 2022-06-13 | Authors: [@mxinden] diff --git a/relay/DCUtR.md b/relay/DCUtR.md index 81836c718..707f587e4 100644 --- a/relay/DCUtR.md +++ b/relay/DCUtR.md @@ -1,8 +1,8 @@ -# Direct Connection Upgrade through Relay +# Direct Connection Upgrade through Relay -| Lifecycle Stage | Maturity | Status | Latest Revision | -|-----------------|---------------|--------|--------------------| -| 1A | Working Draft | Active | r1, 2021-11-20 | +| Lifecycle Stage | Maturity | Status | Latest Revision | +|-----------------|----------------|--------|--------------------| +| 3A | Recommendation | Active | r1, 2021-11-20 | Authors: [@vyzo] @@ -18,15 +18,13 @@ Interest Group: [@raulk], [@stebalien], [@whyrusleeping], [@mxinden], [@marten-s See the [lifecycle document](https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md) for context about maturity level and spec status. -## Table of Contents +## Table of Contents -- [Direct Connection Upgrade through Relay](#direct-connection-upgrade-through-relay) - - [Table of Contents](#table-of-contents) - - [Introduction](#introduction) - - [The Protocol](#the-protocol) - - [RPC messages](#rpc-messages) - - [FAQ](#faq) - - [References](#references) +- [Introduction](#introduction) +- [The Protocol](#the-protocol) + - [RPC messages](#rpc-messages) +- [FAQ](#faq) +- [References](#references) ## Introduction diff --git a/relay/circuit-v2.md b/relay/circuit-v2.md index f78d1fc5d..9bc018fd1 100644 --- a/relay/circuit-v2.md +++ b/relay/circuit-v2.md @@ -1,10 +1,10 @@ -# Circuit Relay v2 +# Circuit Relay v2 This is the version 2 of the libp2p Circuit Relay protocol. -| Lifecycle Stage | Maturity | Status | Latest Revision | -|-----------------|----------------|--------|-----------------| -| 1A | DRAFT | Active | r1, 2021-12-17 | +| Lifecycle Stage | Maturity | Status | Latest Revision | +|-----------------|-----------------|--------|-----------------| +| 3A | Recommendation | Active | r1, 2021-12-17 | Authors: [@vyzo] @@ -20,13 +20,15 @@ and spec status. [lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md -## Table of Contents +## Table of Contents - [Introduction](#introduction) - [Rationale](#rationale) - [The Protocol](#the-protocol) - [Interaction](#interaction) - [Hop Protocol](#hop-protocol) + - [Reservation](#reservation) + - [Connection Initiation](#connection-initiation) - [Stop Protocol](#stop-protocol) - [Reservation Vouchers](#reservation-vouchers) - [Protobuf](#protobuf) diff --git a/tls/tls.md b/tls/tls.md index 997c94df6..1962297dd 100644 --- a/tls/tls.md +++ b/tls/tls.md @@ -1,8 +1,8 @@ -# libp2p TLS Handshake +# libp2p TLS Handshake -| Lifecycle Stage | Maturity | Status | Latest Revision | -|-----------------|--------------------------|--------|-----------------| -| 2A | Candidate Recommendation | Active | r0, 2019-03-23 | +| Lifecycle Stage | Maturity | Status | Latest Revision | +|-----------------|----------------|--------|-----------------| +| 3A | Recommendation | Active | r0, 2019-03-23 | Authors: [@marten-seemann] @@ -21,16 +21,18 @@ and spec status. [lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md -## Table of Contents - -- [libp2p TLS Handshake](#libp2p-tls-handshake) - - [Table of Contents](#table-of-contents) - - [Introduction](#introduction) - - [Handshake Protocol](#handshake-protocol) - - [Peer Authentication](#peer-authentication) - - [libp2p Public Key Extension](#libp2p-public-key-extension) - - [Test vectors](#test-vectors) - - [Future Extensibility](#future-extensibility) +## Table of Contents + +- [Introduction](#introduction) +- [Handshake Protocol](#handshake-protocol) +- [Peer Authentication](#peer-authentication) + - [libp2p Public Key Extension](#libp2p-public-key-extension) +- [Test vectors](#test-vectors) + - [1. Valid certificate authenticating an ED25519 Peer ID](#1-valid-certificate-authenticating-an-ed25519-peer-id) + - [2. Valid certificate authenticating an ECDSA Peer ID](#2-valid-certificate-authenticating-an-ecdsa-peer-id) + - [3. Valid certificate authenticating a secp256k1 Peer ID](#3-valid-certificate-authenticating-a-secp256k1-peer-id) + - [4. Invalid certificate](#4-invalid-certificate) +- [Future Extensibility](#future-extensibility) ## Introduction diff --git a/webrtc/README.md b/webrtc/README.md index 1839d3a2b..65d2caa86 100644 --- a/webrtc/README.md +++ b/webrtc/README.md @@ -3,6 +3,7 @@ | Lifecycle Stage | Maturity | Status | Latest Revision | |-----------------|---------------------------|--------|-----------------| | 2A | Candidate Recommendation | Active | r0, 2022-10-14 | + Authors: [@mxinden] Interest Group: [@marten-seemann] diff --git a/webtransport/README.md b/webtransport/README.md index b3c72e7bc..bb4d117ea 100644 --- a/webtransport/README.md +++ b/webtransport/README.md @@ -2,7 +2,7 @@ | Lifecycle Stage | Maturity | Status | Latest Revision | |-----------------|--------------------------|--------|-----------------| -| 1A | Candidate Recommendation | Active | r0, 2022-10-12 | +| 2A | Candidate Recommendation | Active | r0, 2022-10-12 | Authors: [@marten-seemann]