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
6 changes: 3 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CLAUDE.md - Repository Assistant Guide

## Repository Overview
This is the ar-io/docs repository, which manages the documentation for the AR.IO Developer Platform. It references various services, SDKs and tools for building on and with the AR.IO Network. It also includes documentation for interacting with ArDrive - a flagship consumer dApp that stores data on Arweave.
This is the ar-io/docs repository, which manages the documentation for the ar.io Developer Platform. It references various services, SDKs and tools for building on and with ar.io. It also includes documentation for interacting with ArDrive - a flagship consumer dApp that stores data on Arweave.

## Architecture
This repository is built with [Fumadocs](https://fumadocs.dev/), a documentation framework. The general architecture is as follows:
Expand Down Expand Up @@ -54,11 +54,11 @@ The repository supports OpenAPI documentation import (see recent commit 33af22f2
- Run linting and type checking before committing

## Community Resources
- **Discord**: https://discord.com/invite/HGG52EtTc2 - Join the AR.IO community for updates and discussions
- **Discord**: https://discord.com/invite/HGG52EtTc2 - Join the ar.io community for updates and discussions

## Important Notes
- This is a documentation repository - focus on content clarity and accuracy
- Always verify technical details match the actual AR.IO implementation
- Always verify technical details match the actual ar.io implementation
- Maintain consistent terminology throughout documentation
- Test all code examples before including them in documentation

Expand Down
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.
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} />
12 changes: 6 additions & 6 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.io Gateway APIs"
description: "Core gateway software for accessing, caching, and querying data on Arweave"
---

Expand All @@ -13,11 +13,11 @@ 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
Expand All @@ -27,7 +27,7 @@ The Ar.io Gateway handles fundamental operations for the Arweave ecosystem:

## 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,7 +76,7 @@ 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
Expand Down Expand Up @@ -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": "/public/brand/ario-white.svg",
"title": "ar.io Gateway",
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't we just change this?

"icon": "/brand/ario-white.svg",
"pages": [
"...",
"data",
Expand Down
10 changes: 5 additions & 5 deletions content/apis/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ Explore the REST APIs available in the ar.io ecosystem. Our services are built w

<Cards>
<Card
icon={<Image src="/public/brand/ario-white.svg" alt="ar.io" width={24} height={24} />}
title="Ar.io Gateway"
icon={<Image src="/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"
/>
<Card
icon={<Image src="/turbo.svg" alt="Turbo" width={24} height={24} />}
icon={<Image src="/ecosystem-logos/logo-turbo.svg" alt="Turbo" width={24} height={24} />}
title="Turbo"
description="Upload and payment services providing fast, reliable data uploads to Arweave with instant confirmation and transparent pricing."
href="/apis/turbo"
/>
</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 Down
2 changes: 1 addition & 1 deletion content/apis/turbo/meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Turbo",
"icon": "/turbo.svg",
"icon": "/ecosystem-logos/logo-turbo.svg",
"pages": ["...", "upload-service", "payment-service"],
"defaultOpen": false
}
8 changes: 4 additions & 4 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 Down Expand Up @@ -104,7 +104,7 @@ ArNS provides significant advantages for accessing data on Arweave:

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

## 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 ar.io, reducing dependency on arweave.net and providing advanced capabilities for production applications:

**Maximum Reliability**

Expand Down
4 changes: 2 additions & 2 deletions content/build/extensions/bundler.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Bundler"
description: "Learn about the Turbo ANS-104 data item bundler that can be run alongside an Ar.io Gateway to accept and submit data items to Arweave"
description: "Learn about the Turbo ANS-104 data item bundler that can be run alongside an ar.io Gateway to accept and submit data items to Arweave"
---

## Overview
Expand Down Expand Up @@ -30,7 +30,7 @@ Environmental variables must be provided for the bundler to function and integra
BUNDLER_ARWEAVE_WALLET='Stringified JWK wallet. e.g: '{ "n": "...", ... }'
BUNDLER_ARWEAVE_ADDRESS='Address for above wallet'

APP_NAME='Ar.io bundler service'
APP_NAME='ar.io bundler service'

# Use localstack s3 bucket for shared data source between ar.io gateway and bundler
AWS_S3_BUCKET=ar.io
Expand Down
4 changes: 2 additions & 2 deletions content/build/extensions/clickhouse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Apache Parquet is a columnar storage file format designed for efficient data sto

For more information about Parquet, see the [Parquet documentation](https://parquet.apache.org/docs/).

## Current Integration with Ar.io Gateways
## Current Integration with ar.io Gateways

In the current ar.io gateway implementation, Parquet and ClickHouse run alongside SQLite rather than replacing it. This parallel architecture allows each database to handle what it does best:

Expand All @@ -34,7 +34,7 @@ With ClickHouse integration enabled, GraphQL queries are primarily routed to Cli

For more information about gateway architecture and data processing, see our [Gateway Architecture](/learn/gateways/architecture) documentation.

## Parquet vs. SQLite in Ar.io Gateways
## Parquet vs. SQLite in ar.io Gateways

While SQLite is excellent for transactional workloads and small to medium datasets, it faces challenges with very large datasets:

Expand Down
2 changes: 1 addition & 1 deletion content/build/extensions/compute-unit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AO Compute Unit (CU)"
description: "Steps for deploying an AO Compute Unit (CU) sidecar alongside your Ar.io Gateway."
description: "Steps for deploying an AO Compute Unit (CU) sidecar alongside your ar.io Gateway."
---

## Overview
Expand Down
6 changes: 3 additions & 3 deletions content/build/extensions/grafana.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Grafana"
description: "Comprehensive guide to deploying and configuring Grafana for Ar.io Gateway monitoring and analytics"
description: "Comprehensive guide to deploying and configuring Grafana for ar.io Gateway monitoring and analytics"
---

import { Steps, Step } from "fumadocs-ui/components/steps";
Expand All @@ -15,7 +15,7 @@ Ar.io gateways track extensive performance and operational metrics using [Promet

The Grafana sidecar is deployed as a separate Docker container that uses the same network as the gateway, making it simple to integrate with your existing setup.

![Grafana Dashboard](/grafana.png)
![Grafana Dashboard](/content/grafana.png)

## Quick Start

Expand Down Expand Up @@ -353,7 +353,7 @@ docker compose -f docker-compose.grafana.yaml restart

- **Grafana Documentation** - [Official Grafana docs](https://grafana.com/docs/)
- **Prometheus Metrics** - [Understanding gateway metrics](https://prometheus.io/docs/concepts/metric_types/)
- **Community Support** - Join the [Ar.io Discord](https://discord.com/invite/HGG52EtTc2) for help
- **Community Support** - Join the [ar.io Discord](https://discord.com/invite/HGG52EtTc2) for help

## Useful Docker Commands

Expand Down
Loading