Skip to content

Commit

Permalink
minor tweak to lifestyle doc phrase (#494)
Browse files Browse the repository at this point in the history
  • Loading branch information
salmad3 authored Dec 14, 2022
1 parent 3fe53ec commit 946441e
Show file tree
Hide file tree
Showing 20 changed files with 69 additions and 69 deletions.
12 changes: 6 additions & 6 deletions 00-framework-02-document-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Interest Group: [@raulk], [@vyzo], [@mgoelzer], [@jacobheun], [@tomaka]
[@jacobheun]: https://github.com/jacobheun
[@tomaka]: https://github.com/tomaka

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand All @@ -33,7 +33,7 @@ help move it forward in its evolution.
This document defines a header format to convey this key status information in
an easy-to-read manner.

## Example
## Example

```markdown
# Spec title
Expand All @@ -54,7 +54,7 @@ Interest Group: [@interested1], [@interested2]
[@interested1]: https://github.com/interested1
[@interested2]: https://github.com/interested2

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand All @@ -64,7 +64,7 @@ and spec status.

### Title and Short Intro

Each spec begins with its title, formatted as an H1 markdown header.
Each spec begins with its title, formatted as an H1 markdown header.

The title can optionally be followed by a short block-quote introducing the
spec, which serves as a subtitle and should be a maximum of one or two lines.
Expand All @@ -75,7 +75,7 @@ The main status information is contained in a markdown table, using the [table
syntax][gfm-tables] supported by [Github Flavored Markdown][gfm-spec].

The status table consists of a single row, with a header containing the field
names.
names.

Example:

Expand Down Expand Up @@ -154,7 +154,7 @@ specs repo, an absolute URL is preferred when linking to the specs document.
Here's an example that can be copy/pasted directly:

```markdown
See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
14 changes: 7 additions & 7 deletions addressing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Interest Group: [@mxinden, @Stebalien, @raulk, @marten-seemann, @vyzo]
[@yusefnapora]: https://github.com/yusefnapora
[@mxinden]: https://github.com/mxinden/

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -166,7 +166,7 @@ within](#encapsulation) another multiaddr.
For example, the above `p2p` address can be combined with the transport address
on which the node is listening:

```
```
/ip4/7.7.7.7/tcp/1234/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N
```

Expand Down Expand Up @@ -199,7 +199,7 @@ appreciated.

Most libp2p transports use the IP protocol as a foundational layer, and as a
result, most transport multiaddrs will begin with a component that represents an
IPv4 or IPv6 address.
IPv4 or IPv6 address.

This may be an actual address, such as `/ip4/7.7.7.7` or
`/ip6/fe80::883:a581:fff1:833`, or it could be something that resolves to an IP
Expand All @@ -219,7 +219,7 @@ resolvable or "name-based" protocols:

When the `/dns` protocol is used, the lookup may result in both IPv4 and IPv6
addresses, in which case IPv6 will be preferred. To explicitly resolve to IPv4
or IPv6 addresses, use the `/dns4` or `/dns6` protocols, respectively.
or IPv6 addresses, use the `/dns4` or `/dns6` protocols, respectively.

Note that in some restricted environments, such as inside a web browser, libp2p
may not have access to the resolved IP addresses at all, in which case the
Expand Down Expand Up @@ -269,7 +269,7 @@ wherever TCP/IP sockets are accessible.

Addresses for the TCP transport are of the form `<ip-multiaddr>/tcp/<tcp-port>`,
where `<ip-multiaddr>` is a multiaddr that resolves to an IP address, as
described in the [IP and Name Resolution section](#ip-and-name-resolution).
described in the [IP and Name Resolution section](#ip-and-name-resolution).
The `<tcp-port>` argument must be a 16-bit unsigned integer.

### WebSockets
Expand All @@ -288,7 +288,7 @@ multiaddr format mirrors this arrangement.

A libp2p QUIC multiaddr is of the form `<ip-multiaddr>/udp/<udp-port>/quic`,
where `<ip-multiaddr>` is a multiaddr that resolves to an IP address, as
described in the [IP and Name Resolution section](#ip-and-name-resolution).
described in the [IP and Name Resolution section](#ip-and-name-resolution).
The `<udp-port>` argument must be a 16-bit unsigned integer in network byte order.


Expand Down Expand Up @@ -318,7 +318,7 @@ destination peer.

A full example would be:

```
```
/ip4/127.0.0.1/tcp/5002/p2p/QmdPU7PfRyKehdrP5A3WqmjyD6bhVpU1mLGKppa2FjGDjZ/p2p-circuit/p2p/QmVT6GYwjeeAF5TR485Yc58S3xRF5EFsZ5YAF4VcP3URHt
```

Expand Down
2 changes: 1 addition & 1 deletion autonat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Interest Group: [@mxinden], [@vyzo], [@raulk], [@stebalien], [@willscott]
[@stebalien]: https://github.com/stebalien
[@willscott]: https://github.com/willscott

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
8 changes: 4 additions & 4 deletions connections/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Interest Group: [@JustMaier], [@vasco-santos] [@bigs], [@mgoelzer]
[@bigs]: https://github.com/bigs
[@mgoelzer]: https://github.com/mgoelzer

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -100,7 +100,7 @@ One of libp2p's core design goals is to be adaptable to many network
environments, including those that don't yet exist. To provide this flexibility,
the connection upgrade process supports multiple protocols for connection
security and stream multiplexing and allows peers to select which to use for
each connection.
each connection.

The process of selecting protocols is called **protocol negotiation**. In
addition to its role in the connection upgrade process, protocol negotiation is
Expand All @@ -114,7 +114,7 @@ Each protocol supported by a peer is identified using a unique string called a
path-like structure containing a short name and a version number, separated by
`/` characters. For example: `/yamux/1.0.0` identifies version 1.0.0 of the
[`yamux` stream multiplexing protocol][yamux]. multistream-select itself has a
protocol id of `/multistream/1.0.0`.
protocol id of `/multistream/1.0.0`.

Including a version number in the protocol id simplifies the case where you want
to concurrently support multiple versions of a protocol, perhaps a stable version
Expand Down Expand Up @@ -286,7 +286,7 @@ The recommended baseline **stream multiplexer** is [yamux][yamux], which
provides a very simple programmatic API and is supported in most libp2p
implementations.

### State Management
### State Management

While the connection establishment process itself does not require any
persistent state, some state management is useful to assist bootstrapping and
Expand Down
4 changes: 2 additions & 2 deletions connections/hole-punching.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Interest Group: [@vyzo], [@vasco], [@stebalien], [@aarsh], [@raulk]
[@vasco]: https://github.com/vasco
[@vyzo]: https://github.com/vyzo

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -151,7 +151,7 @@ connections across the various permutations of the two dimensions.

- **Why use both [AutoNAT] and [STUN], why not settle on one for both TCP / QUIC
and WebRTC based hole punching?**

On browser platforms libp2p implementations do not control the local WebRTC
stack. This same stack can only operate with [STUN] and not [AutoNAT]. One
could use [STUN] instead of [AutoNAT] for TCP and QUIC hole punching though.
Expand Down
2 changes: 1 addition & 1 deletion connections/simopen.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Interest Group: [@raulk], [@stebalien], [@mxinden]
[@stebalien]: https://github.com/stebalien
[@mxinden]: https://github.com/mxinden

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
10 changes: 5 additions & 5 deletions discovery/mdns.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Interest Group: [@yusefnapora], [@raulk], [@daviddias], [@jacobheun]
[@daviddias]: https://github.com/daviddias
[@jacobheun]: https://github.com/jacobheun

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -59,7 +59,7 @@ Conceptually, it is very simple. When a peer starts (or detects a network change

As the this field doesn't carry any meaning, it is sufficient to ensure the uniqueness of this identifier. Peers SHOULD generate a random, lower-case alphanumeric string of least 32 characters in length when booting up their node. Peers SHOULD NOT use their Peer ID here because a future Peer ID could exceed the DNS label limit of 63 characters.

If a [private network](https://github.com/libp2p/specs/blob/master/pnet/Private-Networks-PSK-V1.md) is in use, then the `service-name` contains the base-16 encoding of the network's fingerprint as in `_p2p-X._udp.local`.
If a [private network](https://github.com/libp2p/specs/blob/master/pnet/Private-Networks-PSK-V1.md) is in use, then the `service-name` contains the base-16 encoding of the network's fingerprint as in `_p2p-X._udp.local`.
This prevents public and private networks from discovering each other's peers.

## Peer Discovery
Expand Down Expand Up @@ -98,8 +98,8 @@ A peer responds with the answer

```
_services._dns-sd._udp.local PTR <service-name>
```
```

### Find All Response

On receipt of a `find all peers` query, the following **additional records** should be included
Expand All @@ -122,7 +122,7 @@ Many existing tools ignore the Additional Records, and always send individual qu
## Issues

[ ] mDNS requires link-local addresses. Loopback and "NAT busting" addresses should not sent and must be ignored on receipt?

## References

- [RFC 1035 - Domain Names (DNS)](https://tools.ietf.org/html/rfc1035)
Expand Down
14 changes: 7 additions & 7 deletions fetch/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fetch v0.0.1

> The Fetch protocol is used for performing a direct peer-to-peer key-value lookup
> The Fetch protocol is used for performing a direct peer-to-peer key-value lookup
| Lifecycle Stage | Maturity | Status | Latest Revision |
|-----------------|----------------|--------|-----------------|
Expand All @@ -12,7 +12,7 @@ Interest Group: [Insert Your Name Here]

[@aschmahmann]: https://github.com/aschmahmann

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -68,16 +68,16 @@ who doesn't want to use it to change anything about their current use.
3. Might be abused/overused given the simple nature of the protocol

### Expected Feature Set and Tentative Technical Directions

Should support: `Fetch(key) (value, statusCode)`

However, the level of specificity in the types of the above variables has wiggle room if people are interested.
The `go-libp2p-pubsub-router` implementation requires:

`key`: At least as generic as a UTF-8 string

`value`: At least as generic as a byte array

`statusCode`: Supports at least `OK`, `NOT_FOUND`, and `ERROR`

## Wire protocol
Expand Down Expand Up @@ -117,7 +117,7 @@ message FetchResponse {
- `B` does some internal lookup and responds with a `RespondLatest` message
- If `B` finds (and elects to send) some data `v` to `A` it sends `RespondLatest{status: SUCCESS, data: v}`
- If `B` has no data to send it responds with `RespondLatest{status: NOT_FOUND, data: null}`
- `A` ignores any information in the `data` field if the status is `NOT_FOUND`
- `A` ignores any information in the `data` field if the status is `NOT_FOUND`

Note: If at any time `A` or `B` break from the protocol in some way, either by disconnecting/closing streams or by sending
invalid data there is no guarantee on the behavior from the other party.
Expand Down
2 changes: 1 addition & 1 deletion identify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Interest Group: [@yusefnapora], [@tomaka], [@richardschneider], [@Stebalien], [@
[@Stebalien]: https://github.com/Stebalien
[@bigs]: https://github.com/bigs

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
2 changes: 1 addition & 1 deletion kad-dht/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Interest Group:
[@jhiesey]: https://github.com/jhiesey
[@mxinden]: https://github.com/mxinden

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
2 changes: 1 addition & 1 deletion mplex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Interest Group: [@yusefnapora], [@richardschneider], [@jacobheun]
[@richardschneider]: https://github.com/richardschneider
[@jacobheun]: https://github.com/jacobheun

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down
20 changes: 10 additions & 10 deletions noise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Interest Group: [@raulk], [@tomaka], [@romanb], [@shahankhatch], [@Mikerah],
[@mhchia]: https://github.com/mhchia


See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -81,14 +81,14 @@ a component that layers security and stream multiplexing over "raw" connections
like TCP sockets. When peers connect, the upgrader uses a protocol called
multistream-select to negotiate which security and multiplexing protocols to
use. The upgrade process is described in the [connection establishment
spec][conn-spec].
spec][conn-spec].

The transport upgrade process is likely to evolve soon, as we are in the process
of designing multiselect 2, a successor to multistream-select. Some noise-libp2p
features are designed to enable proposed features of multiselect 2, however
noise-libp2p is fully compatible with the current upgrade process and
multistream-select. See the [Negotiation section](#negotiation) for details
about protocol negotiation.
about protocol negotiation.

Every Noise connection begins with a handshake between an initiating peer and a
responding peer, or in libp2p terms, a dialer and a listener. Over the course of
Expand Down Expand Up @@ -205,10 +205,10 @@ messages. We leverage this construct to transmit:

The extensions are inserted into the first message of the handshake pattern
**that guarantees secrecy**. Specifically, this means that the initiator MUST NOT
send extensions in their first message.
The initiator sends its extensions in message 3 (closing message), and the
send extensions in their first message.
The initiator sends its extensions in message 3 (closing message), and the
responder sends theirs in message 2 (their only message). It should be stressed,
that while the second message of the handshake pattern has forward secrecy,
that while the second message of the handshake pattern has forward secrecy,
the sender has not authenticated the responder yet, so this payload might be
sent to any party, including an active attacker.

Expand Down Expand Up @@ -257,15 +257,15 @@ knowledge of the other's static public key.

`noise-libp2p` supports the [XX handshake pattern](#xx), which provides mutual
authentication and encryption of static keys and handshake payloads and is
resistant to replay attacks.
resistant to replay attacks.

Prior revisions of this spec included a compound protocol involving the `IK` and
`XXfallback `patterns, but this was [removed](#why-the-xx-handshake-pattern) due
to the benefits not justifying the considerable additional complexity.

#### XX

```
```
XX:
-> e
<- e, ee, s, es
Expand Down Expand Up @@ -337,7 +337,7 @@ The `noise_message_len` field stores the length in bytes of the `noise_message`
field, encoded as a 16-bit big-endian unsigned integer.

The `noise_message` field contains a [Noise Message as defined in the Noise
spec][npf-message-format], which has a maximum length of 65535 bytes.
spec][npf-message-format], which has a maximum length of 65535 bytes.

During the handshake phase, `noise_message` will be a Noise handshake message.
Noise handshake messages may contain encrypted payloads. If so, they will have
Expand All @@ -352,7 +352,7 @@ payload plus 16 bytes of authentication data.

During the handshake phase, the initiator (Alice) will initialize a Noise
[`HandshakeState` object][npf-handshake-state] with the [Noise protocol
name](#noise-protocol-name) `Noise_XX_25519_ChaChaPoly_SHA256`.
name](#noise-protocol-name) `Noise_XX_25519_ChaChaPoly_SHA256`.

Alice and Bob exchange handshake messages, during which they [authenticate each
other's static Noise keys](#static-key-authentication). Handshake messages are
Expand Down
4 changes: 2 additions & 2 deletions plaintext/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Interest Group: [@raulk], [@Warchant], [@Stebalien], [@mhchia]
[@Stebalien]: https://github.com/Stebalien
[@mhchia]: https://github.com/mhchia

See the [lifecycle document][lifecycle-spec] for context about maturity level
See the [lifecycle document][lifecycle-spec] for context about the maturity level
and spec status.

[lifecycle-spec]: https://github.com/libp2p/specs/blob/master/00-framework-01-spec-lifecycle.md
Expand Down Expand Up @@ -55,7 +55,7 @@ process][conn-spec-conn-upgrade].
## Protocol Id and Version History

The plaintext protocol described in this document has the protocol id of
`/plaintext/2.0.0`.
`/plaintext/2.0.0`.

An earlier version, `/plaintext/1.0.0`, was implemented in several languages,
but it did not include any exchange of public keys or peer ids. This led to
Expand Down
Loading

0 comments on commit 946441e

Please sign in to comment.