Skip to content

Commit

Permalink
docs: Added info on Wayfinder v0.0.10
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobinstein committed Mar 5, 2024
1 parent 87ac17d commit e59d0f0
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 92 deletions.
6 changes: 0 additions & 6 deletions .vscode/settings.json

This file was deleted.

Binary file added docs/src/.vuepress/public/images/arcss-txt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 0 additions & 84 deletions docs/src/arcss.md

This file was deleted.

32 changes: 32 additions & 0 deletions docs/src/concepts/arcss.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,35 @@ ar://good-morning

The ARCSS protocol, along with the WayFinder extension, discerns between TxIds and ArNS names. Once the suitable `https://` request is formulated, the chosen gateway translates the ArNS name based on the ArNS smartweave contract.

## Wayfinder

The [AR.IO WayFinder browser extension](https://chrome.google.com/webstore/detail/ario-WayFinder/hnhmeknhajanolcoihhkkaaimapnmgil) is a browser extension designed to facilitate the resolving of `ar://` urls.

### v0.0.10

As of v0.0.10, Wayfinder supports the resolution of TXT records to Arwevae content on top level domains. This innovative feature leverages DNS TXT records to associate Arweave transaction IDs with human-readable domain names, facilitating intuitive and memorable access to permaweb content. By simply entering an AR:// URL with a domain name, Wayfinder resolves the corresponding Arweave transaction ID through DNS TXT records, redirecting users directly to the content hosted on the Arweave network.

**Setup**: Owners of a domain can set a TXT record for that domain following the format `ARTX <Arweave TXID>`.

<center><img :src="$withBase('/images/arcss-txt.png')"></center>

**AR:// Redirection**: With a TXT record set properly, whenever a user (who has Wayfinder installed) enters an AR:// URL containing a domain name (e.g., `ar://example.com`), Wayfinder performs a DNS lookup for that TXT record in order to redirect to the Arweave content. The lookup is completed through a secure DNS-over-HTTPS query to ensure privacy and integrity.

**Dynamic Content Resolution**: After retrieving the TXT record, Wayfinder extracts that Arweave transaction ID and dynamically redirects the user to the content on the permaweb. This process is transparent to the user, providing a seamless experience as if accessing a traditional website.

### Key Features

- **Gasless**: TXT records can be set without any onchain transactions that would require gas fees.
- **Easy Integration**: Domain owners can easily link their permaweb content to their domains, making it accessible through a simple AR:// URL.
- **Dyncamic Content Access**: Content links can be updated in real-time through DNS TXT records, without requiring any changes to the AR:// URL itself.
- **Enhanced User Experience**: Offers users a familiar and easy-to-remember way to access permaweb content, leveraging standard web domain names.
- **Security and Privacy**: Secure DNS-over-HTTPS queries for DNS lookups protect user privacy and enhances security.

### Use Cases

- **Branded Content Access**: Companies and individuals can brand their permaweb content, making it accessible through their domain, enhancing brand visibility and user trust.
- **Dynamic Content Updates**: Domain owners can easily update what Permaweb content their AR:// URL resolves to, which is ideal for frequently updated resources like documents, blogs, and application interfaces.
- **Educational and Informational Resources**: Educational institutions and information providers can make their resources permanently available on the permaweb, accessible through simple, memorable URLs.

This feature marks a significant advancement in making decentralized content more accessible and user-friendly, bridging the gap between traditional internet usability and the permaweb’s permanence and censorship-resistant nature.

4 changes: 2 additions & 2 deletions docs/src/gateways/ar-io-node/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
permalink: "/gateways/ar-io-node/overview"
prev: "./windows-setup"
next: "./linux-setup"
# prev: "./windows-setup"
# next: "./linux-setup"
---

# Overview
Expand Down

0 comments on commit e59d0f0

Please sign in to comment.