Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AR.IO Documentation
# Ar.io Documentation

AR.IO Documentation is a Next.js site built with Fumadocs that hosts the product and developer documentation for the AR.IO network and tooling. It contains authored guides, API references, and autogenerated content sourced from scripts in this repository.
Ar.io Documentation is a Next.js site built with Fumadocs that hosts the product and developer documentation for the ar.io network and tooling. It contains authored guides, API references, and autogenerated content sourced from scripts in this repository.

## Docs Site

Expand Down
18 changes: 9 additions & 9 deletions content/apis/ar-io-node/admin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ _openapi:
url: '#get-bundle-processing-status'
- depth: 2
title: >-
Blocks transactions or data-items so your AR.IO Gateway will not serve
Blocks transactions or data-items so your Ar.io Gateway will not serve
them.
url: >-
#blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- depth: 2
title: Blocks an ARNS name so your AR.IO Gateway will not serve it.
title: Blocks an ARNS name so your Ar.io Gateway will not serve it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of these should be ar.io

url: '#blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it'
- depth: 2
title: Unblock an ARNS name.
Expand All @@ -52,11 +52,11 @@ _openapi:
- content: Get bundle processing status
id: get-bundle-processing-status
- content: >-
Blocks transactions or data-items so your AR.IO Gateway will not serve
Blocks transactions or data-items so your Ar.io Gateway will not serve
them.
id: >-
blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- content: Blocks an ARNS name so your AR.IO Gateway will not serve it.
- content: Blocks an ARNS name so your Ar.io Gateway will not serve it.
id: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it
- content: Unblock an ARNS name.
id: unblock-an-arns-name
Expand All @@ -69,7 +69,7 @@ _openapi:
contents:
- content: >-
Get detailed information about the current operational state of your
AR.IO Gateway, including information about any current warnings or
Ar.io Gateway, including information about any current warnings or
errors.
heading: admin-debugging-information
- content: >-
Expand Down Expand Up @@ -97,7 +97,7 @@ _openapi:
heading: get-bundle-processing-status
- content: >
Submits a TX ID/data-item ID or sha-256 content hash for content you
do not want your AR.IO Gateway to serve. Once submitted, your Gateway
do not want your Ar.io Gateway to serve. Once submitted, your Gateway
will not respond to requests for these transactions or data-items.


Expand All @@ -106,9 +106,9 @@ _openapi:
by your Gateway.
heading: >-
blocks-transactions-or-data-items-so-your-ario-gateway-will-not-serve-them
- content: Blocks an ARNS name so your AR.IO Gateway will not serve it.
- content: Blocks an ARNS name so your Ar.io Gateway will not serve it.
heading: blocks-an-arns-name-so-your-ario-gateway-will-not-serve-it
- content: Unblock an ARNS name so your AR.IO Gateway will serve it again.
- content: Unblock an ARNS name so your Ar.io Gateway will serve it again.
heading: unblock-an-arns-name
- content: >
Initiates an export of data to Parquet format files. This process runs
Expand All @@ -128,7 +128,7 @@ _openapi:

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Access several password protected features and functions specific to your AR.IO Gateway.
Access several password protected features and functions specific to your Ar.io Gateway.


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/ar-io/admin/debug","method":"get"},{"path":"/ar-io/admin/queue-tx","method":"post"},{"path":"/ar-io/admin/queue-bundle","method":"post"},{"path":"/ar-io/admin/queue-data-item","method":"post"},{"path":"/ar-io/admin/bundle-status/{id}","method":"get"},{"path":"/ar-io/admin/block-data","method":"put"},{"path":"/ar-io/admin/block-name","method":"put"},{"path":"/ar-io/admin/unblock-name","method":"put"},{"path":"/ar-io/admin/export-parquet","method":"post"},{"path":"/ar-io/admin/export-parquet/status","method":"get"},{"path":"/ar-io/admin/prune-stable-data-items","method":"post"}]} webhooks={[]} hasHead={true} />
2 changes: 1 addition & 1 deletion content/apis/ar-io-node/arns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ _openapi:

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get data from the AR.IO Gateway Arweave Name System
Get data from the Ar.io Gateway Arweave Name System


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/ar-io/resolver/{name}","method":"get"}]} webhooks={[]} hasHead={true} />
8 changes: 4 additions & 4 deletions content/apis/ar-io-node/gateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ _openapi:
transaction or ArNS-resolved data (e.g., text/html for HTML documents,
application/json for JSON documents, application/octet-stream for
binary data, etc.).
- content: Get the current health status of the AR.IO Gateway.
- content: Get the current health status of the Ar.io Gateway.
- content: |
Returns information about the AR.IO Gateway, including:
Returns information about the Ar.io Gateway, including:
- Gateway wallet address
- Process ID
- ANS-104 filter configurations
- Supported manifest versions
- Gateway software release version
- content: >
Returns information about AR.IO Gateway peers and Arweave node peers.
Returns information about Ar.io Gateway peers and Arweave node peers.

For gateways, includes both data and chunk weights used for peer
selection.
Expand All @@ -59,7 +59,7 @@ _openapi:

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Operations related to the AR.IO Gateway server itself, including health checks, metrics, and gateway-specific information
Operations related to the Ar.io Gateway server itself, including health checks, metrics, and gateway-specific information


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/","method":"get"},{"path":"/ar-io/healthcheck","method":"get"},{"path":"/ar-io/info","method":"get"},{"path":"/ar-io/peers","method":"get"},{"path":"/ar-io/__gateway_metrics","method":"get"}]} webhooks={[]} hasHead={true} />
2 changes: 1 addition & 1 deletion content/apis/ar-io-node/index-querying.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ _openapi:

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Get data from the AR.IO Gateway index using GQL
Get data from the Ar.io Gateway index using GQL


<APIPage document={"https://raw.githubusercontent.com/ar-io/ar-io-node/refs/heads/openapi-update/docs/openapi.yaml"} operations={[{"path":"/graphql","method":"post"}]} webhooks={[]} hasHead={true} />
18 changes: 9 additions & 9 deletions content/apis/ar-io-node/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "AR.IO Gateway APIs"
title: "Ar.ioGateway APIs"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: "Ar.ioGateway APIs"
title: "ar.io Gateway APIs"

description: "Core gateway software for accessing, caching, and querying data on Arweave"
---

Expand All @@ -13,21 +13,21 @@ import {
FileText,
} from "lucide-react";

The AR.IO Gateway is the core software for the AR.IO network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web.
The Ar.io Gateway is the core software for the ar.io network, serving the essential responsibility of gateways for accessing, caching, and querying data stored on Arweave. It provides a robust, decentralized infrastructure for interacting with the permanent web.

## Core Responsibilities

The AR.IO Gateway handles fundamental operations for the Arweave ecosystem:
The Ar.io Gateway handles fundamental operations for the Arweave ecosystem:

- **Data Access** - Retrieve transaction data, files, and metadata from Arweave
- **Caching** - Intelligent caching strategies for improved performance and availability
- **Data Querying** - Powerful search and indexing capabilities for Arweave data
- **ArNS Resolution** - Resolve human-readable names to Arweave transaction IDs
- **Network Management** - Coordinate with other gateways in the AR.IO network
- **Network Management** - Coordinate with other gateways in the ar.io network

## Advanced Features

Beyond basic gateway functionality, AR.IO Gateway includes sophisticated capabilities:
Beyond basic gateway functionality, Ar.io Gateway includes sophisticated capabilities:

- **Parquet Generation** - Convert Arweave data into optimized Parquet format for analytics
- **Data Verification** - Cryptographic verification of data integrity and authenticity
Expand Down Expand Up @@ -76,13 +76,13 @@ Beyond basic gateway functionality, AR.IO Gateway includes sophisticated capabil
/>
</Cards>

## Get Involved with AR.IO Gateways
## Get Involved with Ar.io Gateways

<Cards>
<Card
icon={<Server />}
title="Run a Gateway"
description="Join the AR.IO network by operating your own gateway and earn rewards"
description="Join the ar.io network by operating your own gateway and earn rewards"
href="/build/run-a-gateway/quick-start"
/>
<Card
Expand All @@ -94,7 +94,7 @@ Beyond basic gateway functionality, AR.IO Gateway includes sophisticated capabil
<Card
icon={<Network />}
title="Join the Network"
description="Learn about the AR.IO network and how to participate in the ecosystem"
description="Learn about the ar.io network and how to participate in the ecosystem"
href="https://ar.io/network"
/>
</Cards>
Expand All @@ -106,4 +106,4 @@ Beyond basic gateway functionality, AR.IO Gateway includes sophisticated capabil
3. **Choose your integration approach** - Direct APIs calls or SDK usage
4. **Consider running a gateway** - Contribute to the network infrastructure

The AR.IO Gateway APIs provide the foundation for building robust, decentralized applications on Arweave with reliable data access and advanced querying capabilities.
The Ar.io Gateway APIs provide the foundation for building robust, decentralized applications on Arweave with reliable data access and advanced querying capabilities.
4 changes: 2 additions & 2 deletions content/apis/ar-io-node/meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "AR.IO Gateway",
"icon": "/ario.svg",
"title": "Ar.io Gateway",
"icon": "/public/brand/ario-white.svg",
"pages": [
"...",
"data",
Expand Down
16 changes: 8 additions & 8 deletions content/apis/index.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: "APIs Reference"
description: "REST APIs for interacting with AR.IO services and infrastructure"
description: "REST APIs for interacting with ar.io services and infrastructure"
---

import { Card, Cards } from 'fumadocs-ui/components/card';
import { Server, Zap, Globe, BookOpen } from 'lucide-react';
import Image from 'next/image';

Explore the REST APIs available in the AR.IO ecosystem. Our services are built with a commitment to open source principles, and all repositories are publicly available under AGPL-3 licenses.
Explore the REST APIs available in the ar.io ecosystem. Our services are built with a commitment to open source principles, and all repositories are publicly available under AGPL-3 licenses.

## Available Services

<Cards>
<Card
icon={<Image src="/ario.svg" alt="AR.IO" width={24} height={24} />}
title="AR.IO Gateway"
icon={<Image src="/public/brand/ario-white.svg" alt="ar.io" width={24} height={24} />}
title="Ar.io Gateway"
description="The core gateway software providing access to data on Arweave. Includes data retrieval, ArNS resolution, and network management."
href="/apis/ar-io-node"
/>
Expand All @@ -26,9 +26,9 @@ Explore the REST APIs available in the AR.IO ecosystem. Our services are built w
/>
</Cards>

## AR.IO Gateway APIs
## Ar.io Gateway APIs

The AR.IO Gateway serves as the primary interface for accessing Arweave data through the AR.IO network. Key endpoints include:
The Ar.io Gateway serves as the primary interface for accessing Arweave data through the ar.io network. Key endpoints include:

- **Data Access** - Retrieve transaction data and files from Arweave
- **ArNS Resolution** - Resolve human-readable names to Arweave transaction IDs
Expand All @@ -47,7 +47,7 @@ Turbo provides high-performance upload services for the Arweave network with add

## Open Source Commitment

We believe strongly in open source development. All AR.IO services are:
We believe strongly in open source development. All ar.io services are:

- **Publicly Available** - Source code is open and accessible
- **AGPL-3 Licensed** - Ensuring software freedom and transparency
Expand Down Expand Up @@ -87,7 +87,7 @@ For SDK alternatives to these REST APIs, visit our [SDK documentation](/sdks).
<Card
icon={<Server />}
title="Run a Gateway"
description="Deploy your own AR.IO gateway and access these APIs directly"
description="Deploy your own ar.io gateway and access these APIs directly"
href="/build/run-a-gateway"
/>
</Cards>
14 changes: 7 additions & 7 deletions content/build/access/arns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ The easiest way to get an ArNS name is via [arns.ar.io](https://arns.ar.io), whi

- **[Wander Chrome Extension](https://chrome.google.com/webstore/detail/wander)** - Browser-based registration
- **Wander Mobile App** - Register on iOS and Android
- **AR.IO SDK** - Programmatic registration using the `buyRecord` API
- **Ar.io SDK** - Programmatic registration using the `buyRecord` API

### Using the AR.IO SDK
### Using the Ar.io SDK

For developers, you can register ArNS names programmatically:

Expand All @@ -52,7 +52,7 @@ console.log('Record purchased:', result);
```

<Callout type="info">
**Learn More:** For a complete list of AR.IO SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns).
**Learn More:** For a complete list of Ar.io SDK APIs, see the [ArNS SDK Documentation](/sdks/ar-io-sdk/arweave-name-system-arns).
</Callout>

## Fetching Data via ArNS
Expand All @@ -76,7 +76,7 @@ console.log(data);
ArNS provides significant advantages for accessing data on Arweave:

**Decentralized Data Index**
- ArNS creates a decentralized index of data accessible through any gateway in the AR.IO network
- ArNS creates a decentralized index of data accessible through any gateway in the ar.io network
- No single point of failure - names resolve across all participating gateways
- Censorship-resistant access to your content

Expand All @@ -87,7 +87,7 @@ ArNS provides significant advantages for accessing data on Arweave:

**Supporting Network Decentralization**
- ArNS purchases contribute to the protocol balance
- Fees reward AR.IO gateway operators for participating in the network
- Fees reward ar.io gateway operators for participating in the network
- This economic model preserves decentralized access to data on Arweave
- Your name registration helps maintain the infrastructure that serves your content

Expand All @@ -104,10 +104,10 @@ ArNS provides significant advantages for accessing data on Arweave:

<Card
href="/learn/what-is-ario"
title="Join the AR.IO Network"
title="Join the Ar.io Network"
icon={<Globe />}
>
Learn how to participate in the AR.IO ecosystem.
Learn how to participate in the ar.io ecosystem.
</Card>

<Card
Expand Down
4 changes: 2 additions & 2 deletions content/build/access/fetch-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ https://<gateway>/raw/<transaction-id>
This endpoint returns the raw data bytes without resolving manifest paths, useful when you need the exact stored data.

<Callout type="info">
**Learn More:** For complete API documentation and testing, see the [AR.IO
**Learn More:** For complete API documentation and testing, see the [ar.io
Node Data APIs](/apis/ar-io-node/data).
</Callout>

## Sandboxing

AR.IO gateways implement security measures by redirecting requests to sandbox subdomains for enhanced browser security.
Ar.io gateways implement security measures by redirecting requests to sandbox subdomains for enhanced browser security.

**Why Redirects Happen:**

Expand Down
2 changes: 1 addition & 1 deletion content/build/access/find-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This separation allows for powerful data discovery while keeping data retrieval
- **Goldsky** - `https://arweave-search.goldsky.com/graphql` - High-performance GraphQL service with full data coverage

<Callout type="info">
**AR.IO Gateways:** AR.IO gateways support the `/graphql` endpoint, but they
**Ar.io Gateways:** ar.io gateways support the `/graphql` endpoint, but they
only return data they've indexed. If you're uploading data and want it
unbundled and indexed, you can run a gateway and configure it to unbundle your
data, or post data items/bundles via the gateway's APIs (recommended). [Learn
Expand Down
6 changes: 3 additions & 3 deletions content/build/access/wayfinder.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Wayfinder"
description: "Use AR.IO Wayfinder for decentralized content discovery and optimized data access"
description: "Use Ar.io Wayfinder for decentralized content discovery and optimized data access"
---

import { Code, Globe, Search, Link } from "lucide-react";

Wayfinder is a client-side routing and verification protocol that provides **decentralized, cryptographically verified access** to data stored on Arweave via the AR.IO Network.
Wayfinder is a client-side routing and verification protocol that provides **decentralized, cryptographically verified access** to data stored on Arweave via the Ar.io Network.

## What is Wayfinder?

Expand Down Expand Up @@ -103,7 +103,7 @@ function YourComponent() {

## Why Use Wayfinder?

Wayfinder eliminates centralized points of failure by distributing data access across the decentralized AR.IO Network, reducing dependency on arweave.net and providing advanced capabilities for production applications:
Wayfinder eliminates centralized points of failure by distributing data access across the decentralized Ar.io Network, reducing dependency on arweave.net and providing advanced capabilities for production applications:

**Maximum Reliability**

Expand Down
6 changes: 3 additions & 3 deletions content/build/advanced/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Advanced"
description: "Advanced topics and specialized guides for building on Arweave and AR.IO"
description: "Advanced topics and specialized guides for building on Arweave and ar.io"
---

## Overview

Explore advanced topics and specialized guides for building on Arweave and AR.IO. These resources are designed for developers and operators who need deeper technical knowledge and advanced configuration options.
Explore advanced topics and specialized guides for building on Arweave and ar.io. These resources are designed for developers and operators who need deeper technical knowledge and advanced configuration options.

## Advanced Topics

Expand All @@ -20,7 +20,7 @@ Explore advanced topics and specialized guides for building on Arweave and AR.IO
</Card>

<Card href="/build/advanced/sandboxing" title="Browser Sandboxing">
**Security mechanisms** in AR.IO gateways **Key topics:** - Same-origin policy
**Security mechanisms** in ar.io gateways **Key topics:** - Same-origin policy
</Card>

<Card href="/build/advanced/ethareum" title="EthAReum Protocol">
Expand Down
Loading