Skip to content

Commit

Permalink
ipns: move to ./ipns
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Oct 19, 2022
1 parent b926e8c commit 47d94f8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ The specs contained in this and related repositories are:
- **Networking layer:**
- [libp2p](https://github.com/libp2p/specs) - libp2p is a modular and extensible network stack, built and use by IPFS, but that it can be reused as a standalone project. Covers:
- **Records, Naming and Record Systems:**
- [IPNS](./IPNS.md) - InterPlanetary Naming System
- [IPNS](./ipns/IPNS.md) - InterPlanetary Naming System
- [IPNS over PubSub](./ipns/IPNS_PUBSUB.md) - IPNS over PubSub Router
- [DNSLink](https://dnslink.dev)
- **Other/related/included:**
- [PDD](https://github.com/ipfs/pdd) - Protocol Driven Development
Expand Down
6 changes: 3 additions & 3 deletions IPNS.md → ipns/IPNS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![draft](https://img.shields.io/badge/status-draft-yellow.svg?style=flat-square) IPNS - Inter-Planetary Naming System
# ![reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square) IPNS - Inter-Planetary Naming System

**Authors(s)**:

Expand Down Expand Up @@ -252,7 +252,7 @@ Once the record is created, it is ready to be spread through the network. This w
The means of distribution are left unspecified. Implementations MAY choose to
publish signed record using multiple routing systems, such as
[libp2p Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht),
[PubSub topic](naming/pubsub.md), or a [Reframe endpoint](reframe/) (see [Routing record](#routing-record)).
[PubSub topic](./IPNS_PUBSUB.md), or a [Reframe endpoint](../reframe/) (see [Routing record](#routing-record)).

On the other side, each peer must be able to get a record published by another node. It only needs to have the unique identifier used to publish the record to the network. Taking into account the routing system being used, we may obtain a set of occurrences of the record from the network. In this case, records can be compared using the sequence number, in order to obtain the most recent one.

Expand Down Expand Up @@ -323,7 +323,7 @@ Note: Base32 according to the [RFC4648](https://tools.ietf.org/html/rfc4648).
### Routing Record

The routing record is spread across the network according to the available routing systems.
The two routing systems currently available in IPFS are the [libp2p Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht) and [IPNS over PubSub](naming/pubsub.md).
The two routing systems currently available in IPFS are the [libp2p Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht) and [IPNS over PubSub](./IPNS_PUBSUB.md).

**Key format:** `/ipns/BINARY_ID`

Expand Down
11 changes: 7 additions & 4 deletions naming/pubsub.md → ipns/IPNS_PUBSUB.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) IPNS PubSub Router
# ![reliable](https://img.shields.io/badge/status-reliable-green.svg?style=flat-square) IPNS PubSub Router

Authors:

Expand All @@ -10,7 +10,7 @@ Reviewers:

# Abstract

[Inter-Planetary Naming System (IPNS)](/README.md) is a naming system responsible for the creating, reading and updating of mutable pointers to data.
[Inter-Planetary Naming System (IPNS)](./IPNS.md) is a naming system responsible for the creating, reading and updating of mutable pointers to data.
IPNS consists of a public/private asymmetric cryptographic key pair, a record type and a protocol.
Part of the protocol involves a routing layer that is used for the distribution and discovery of new or updated IPNS records.

Expand All @@ -35,7 +35,7 @@ In this spec we address building a router based on a PubSub system, particularly
# PubSub Protocol Overview

The protocol has four components:
- [IPNS Records and Validation](/README.md)
- [IPNS Records and Validation](./IPNS.md)
- [libp2p PubSub](https://github.com/libp2p/specs/tree/master/pubsub)
- Translating an IPNS record name to/from a PubSub topic
- Layering persistence onto libp2p PubSub
Expand Down Expand Up @@ -91,4 +91,7 @@ every 10 seconds)

# Implementations

- <https://github.com/ipfs/go-ipfs/tree/master/namesys>
- <https://github.com/ipfs/go-namesys>
- <https://github.com/libp2p/go-libp2p-pubsub>
- <https://github.com/ipfs/kubo/blob/master/docs/experimental-features.md#ipns-pubsub>
- <https://github.com/ipfs/kubo/issues/8591>

0 comments on commit 47d94f8

Please sign in to comment.