From 104797e088dc45acef52aaeabf44d6f351ec7b78 Mon Sep 17 00:00:00 2001 From: dozyio Date: Mon, 5 Aug 2024 13:47:39 +0100 Subject: [PATCH] docs: fix some archived repo links, give helia some love --- docs/community/contribute/ways-to-contribute.md | 2 +- docs/concepts/dht.md | 2 +- docs/concepts/file-systems.md | 2 +- docs/how-to/publish-ipns.md | 2 +- docs/project/repository-guide.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/community/contribute/ways-to-contribute.md b/docs/community/contribute/ways-to-contribute.md index ee10fe58a..8f9110723 100644 --- a/docs/community/contribute/ways-to-contribute.md +++ b/docs/community/contribute/ways-to-contribute.md @@ -18,7 +18,7 @@ IPFS and its sister-projects are big, with lots of code written in multiple lang The biggest and most active repositories we have today are: - [ipfs/kubo](https://github.com/ipfs/kubo) -- [ipfs/js-ipfs](https://github.com/ipfs/js-ipfs) +- [ipfs/helia](https://github.com/ipfs/helia) - [libp2p/go-libp2p](https://github.com/libp2p/go-libp2p) - [libp2p/js-libp2p](https://github.com/libp2p/js-libp2p) diff --git a/docs/concepts/dht.md b/docs/concepts/dht.md index 20ad32d3e..c83e5898a 100644 --- a/docs/concepts/dht.md +++ b/docs/concepts/dht.md @@ -35,7 +35,7 @@ A major property of Kademlia is that all peers can be arranged from smallest to While having peers that cannot talk to each other may sound like an oddity, two prevalent causes of unreachability are network address translators (NATs) and firewalls. Having asymmetrical networks where peers `X`, `Y`, and `Z` can connect to `A`, but `A` cannot connect to them is fairly common. Similarly, it is _extremely_ common that peers `A` and `B`, which are both behind NATs, cannot talk to each other. To deal with this, IPFS nodes ignore other nodes assumed to be unreachable by the general public. Nodes also filter themselves out of the network if they suspect they are not reachable. -To do this, we use [libp2p's AutoNAT](https://github.com/libp2p/go-libp2p-autonat), which acts as a distributed _session traversal utility for NAT_ (STUN) layer, informing peers of their observed addresses and whether or not they appear to be publicly dialable. Only when peers detect that they are publicly dialable do they switch from client mode (where they can query the DHT but not respond to queries) to server mode (where they can both query and respond to queries). Similarly, if a server discovers that it is no longer publicly dialable, it will switch back into client mode. +To do this, we use [libp2p's AutoNAT](https://github.com/libp2p/go-libp2p/tree/master/p2p/host/autonat), which acts as a distributed _session traversal utility for NAT_ (STUN) layer, informing peers of their observed addresses and whether or not they appear to be publicly dialable. Only when peers detect that they are publicly dialable do they switch from client mode (where they can query the DHT but not respond to queries) to server mode (where they can both query and respond to queries). Similarly, if a server discovers that it is no longer publicly dialable, it will switch back into client mode. IPFS exposes a _rate-limited_ AutoNAT service on all IPFS nodes that have discovered that they are publicly dialable. These requests are infrequent and do not have a noticeable overhead. diff --git a/docs/concepts/file-systems.md b/docs/concepts/file-systems.md index a78ed13e6..a51007c4e 100644 --- a/docs/concepts/file-systems.md +++ b/docs/concepts/file-systems.md @@ -219,7 +219,7 @@ await ipfs.files.rm('/my/beautiful/directory') When you add a _file_ to IPFS, it might be too big to fit in a single block, so it needs metadata to link all its blocks together. UnixFS is a [protocol-buffers](https://developers.google.com/protocol-buffers/)-based format for describing files, directories, and symlinks in IPFS. This data format is used to represent files and all their links and metadata in IPFS. UnixFS creates a block (or a tree of blocks) of linked objects. -UnixFS currently has [Javascript](https://github.com/ipfs/helia-unixfs) and [Go](https://github.com/ipfs/kubo/tree/b3faaad1310bcc32dc3dd24e1919e9edf51edba8/unixfs) implementations. These implementations have modules written in to run different functions: +UnixFS currently has [Javascript](https://github.com/ipfs/helia/tree/main/packages/unixfs) and [Go](https://github.com/ipfs/kubo/tree/b3faaad1310bcc32dc3dd24e1919e9edf51edba8/unixfs) implementations. These implementations have modules written in to run different functions: - **Data Formats**: manage the serialization/deserialization of UnixFS objects to protocol buffers diff --git a/docs/how-to/publish-ipns.md b/docs/how-to/publish-ipns.md index dbee60cc6..e65875b56 100644 --- a/docs/how-to/publish-ipns.md +++ b/docs/how-to/publish-ipns.md @@ -104,4 +104,4 @@ ipfs name publish --key=SecondKey /ipfs/bafybeicklkqcnlvtiscr2hzkubjwnwjinvskffn ``` ## Publishing IPNS names with helia-ipns -Learn more about using IPNS with JavaScript at the [helia-ipns](https://github.com/ipfs/helia-ipns) repository. \ No newline at end of file +Learn more about using IPNS with JavaScript with the [helia-ipns](https://github.com/ipfs/helia/tree/main/packages/ipns) package. diff --git a/docs/project/repository-guide.md b/docs/project/repository-guide.md index 77cd83ca6..1b36d3554 100644 --- a/docs/project/repository-guide.md +++ b/docs/project/repository-guide.md @@ -20,7 +20,7 @@ Organization and repository links for the top-level projects shipped as part of :::warning ### js-ipfs being discontinued -Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/). +Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript that was released in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/). Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.