diff --git a/README.md b/README.md index 11c14982d..a8da91fa7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/content/apis/ar-io-node/admin.mdx b/content/apis/ar-io-node/admin.mdx index 78aa03b34..24f0072d8 100644 --- a/content/apis/ar-io-node/admin.mdx +++ b/content/apis/ar-io-node/admin.mdx @@ -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. @@ -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 @@ -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: >- @@ -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. @@ -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 @@ -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. \ No newline at end of file diff --git a/content/apis/ar-io-node/arns.mdx b/content/apis/ar-io-node/arns.mdx index 058d07f2e..6edd7f34e 100644 --- a/content/apis/ar-io-node/arns.mdx +++ b/content/apis/ar-io-node/arns.mdx @@ -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 \ No newline at end of file diff --git a/content/apis/ar-io-node/gateway.mdx b/content/apis/ar-io-node/gateway.mdx index d375bda06..3ef95f648 100644 --- a/content/apis/ar-io-node/gateway.mdx +++ b/content/apis/ar-io-node/gateway.mdx @@ -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. @@ -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 \ No newline at end of file diff --git a/content/apis/ar-io-node/index-querying.mdx b/content/apis/ar-io-node/index-querying.mdx index a7560022a..b70dad8c5 100644 --- a/content/apis/ar-io-node/index-querying.mdx +++ b/content/apis/ar-io-node/index-querying.mdx @@ -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 \ No newline at end of file diff --git a/content/apis/ar-io-node/index.mdx b/content/apis/ar-io-node/index.mdx index 165e0b379..98e4d6c95 100644 --- a/content/apis/ar-io-node/index.mdx +++ b/content/apis/ar-io-node/index.mdx @@ -1,5 +1,5 @@ --- -title: "AR.IO Gateway APIs" +title: "Ar.ioGateway APIs" description: "Core gateway software for accessing, caching, and querying data on Arweave" --- @@ -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 @@ -76,13 +76,13 @@ Beyond basic gateway functionality, AR.IO Gateway includes sophisticated capabil /> -## Get Involved with AR.IO Gateways +## Get Involved with Ar.io Gateways } 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" /> } 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" /> @@ -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. diff --git a/content/apis/ar-io-node/meta.json b/content/apis/ar-io-node/meta.json index 1668c175b..bbe1082b2 100644 --- a/content/apis/ar-io-node/meta.json +++ b/content/apis/ar-io-node/meta.json @@ -1,6 +1,6 @@ { - "title": "AR.IO Gateway", - "icon": "/ario.svg", + "title": "Ar.io Gateway", + "icon": "/public/brand/ario-white.svg", "pages": [ "...", "data", diff --git a/content/apis/index.mdx b/content/apis/index.mdx index faaede91a..61209bf0f 100644 --- a/content/apis/index.mdx +++ b/content/apis/index.mdx @@ -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 } - title="AR.IO Gateway" + icon={ar.io} + 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" /> @@ -26,9 +26,9 @@ Explore the REST APIs available in the AR.IO ecosystem. Our services are built w /> -## 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 @@ -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 @@ -87,7 +87,7 @@ For SDK alternatives to these REST APIs, visit our [SDK documentation](/sdks). } 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" /> diff --git a/content/build/access/arns.mdx b/content/build/access/arns.mdx index 8c1b4464a..25356cddb 100644 --- a/content/build/access/arns.mdx +++ b/content/build/access/arns.mdx @@ -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: @@ -52,7 +52,7 @@ console.log('Record purchased:', result); ``` - **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). ## Fetching Data via ArNS @@ -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 @@ -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 @@ -104,10 +104,10 @@ ArNS provides significant advantages for accessing data on Arweave: } > - Learn how to participate in the AR.IO ecosystem. + Learn how to participate in the ar.io ecosystem. /raw/ This endpoint returns the raw data bytes without resolving manifest paths, useful when you need the exact stored data. - **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). ## 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:** diff --git a/content/build/access/find-data.mdx b/content/build/access/find-data.mdx index 8001e5979..61a24bb67 100644 --- a/content/build/access/find-data.mdx +++ b/content/build/access/find-data.mdx @@ -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 - **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 diff --git a/content/build/access/wayfinder.mdx b/content/build/access/wayfinder.mdx index 565d29a29..a1086b6bc 100644 --- a/content/build/access/wayfinder.mdx +++ b/content/build/access/wayfinder.mdx @@ -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? @@ -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** diff --git a/content/build/advanced/index.mdx b/content/build/advanced/index.mdx index 77687f5a6..fbd33f6c4 100644 --- a/content/build/advanced/index.mdx +++ b/content/build/advanced/index.mdx @@ -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 @@ -20,7 +20,7 @@ Explore advanced topics and specialized guides for building on Arweave and AR.IO - **Security mechanisms** in AR.IO gateways **Key topics:** - Same-origin policy + **Security mechanisms** in ar.io gateways **Key topics:** - Same-origin policy diff --git a/content/build/advanced/sandboxing.mdx b/content/build/advanced/sandboxing.mdx index 5efb2778a..e7cdb6a7a 100644 --- a/content/build/advanced/sandboxing.mdx +++ b/content/build/advanced/sandboxing.mdx @@ -1,6 +1,6 @@ --- title: "Browser Sandboxing" -description: "Learn about browser sandboxing in AR.IO gateways - how security is enhanced through same-origin policy and subdomain redirection" +description: "Learn about browser sandboxing in ar.io gateways - how security is enhanced through same-origin policy and subdomain redirection" --- @@ -27,9 +27,9 @@ The integration of TLS is crucial for the implementation of browser sandboxing. ## Deriving Sandbox Value -AR.IO nodes generate browser sandbox values deterministically. Because of this, it is possible to calculate ahead of time what that value will be for a particular transaction id. +Ar.io nodes generate browser sandbox values deterministically. Because of this, it is possible to calculate ahead of time what that value will be for a particular transaction id. -Sandbox values are a Base32 encoding of the transaction ID. AR.IO gateways use the following code snippet to accomplish the encoding: +Sandbox values are a Base32 encoding of the transaction ID. ar.io gateways use the following code snippet to accomplish the encoding: ```typescript const expectedTxSandbox = (id: string): string => { diff --git a/content/build/extensions/bundler.mdx b/content/build/extensions/bundler.mdx index 54fb4f272..bb6bdbec5 100644 --- a/content/build/extensions/bundler.mdx +++ b/content/build/extensions/bundler.mdx @@ -1,13 +1,13 @@ --- 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 -A [Turbo ANS-104](https://github.com/ardriveapp/turbo-upload-service/) data item bundler can be run alongside an AR.IO gateway. This allows gateways the ability to accept data items to be submitted to the Arweave blockweave. +A [Turbo ANS-104](https://github.com/ardriveapp/turbo-upload-service/) data item bundler can be run alongside an ar.io gateway. This allows gateways the ability to accept data items to be submitted to the Arweave blockweave. -The bundler service can be easily run inside Docker in the same way that the gateway is. It utilizes a separate docker compose file for configuration and deployment, which also allows for the use of a separate file for environmental variables specific to the bundler service. Additionally, the separation allows operators to spin their bundler service up or down at any time without affecting their core gateway service. Despite the use of separate docker compose files, the bundler service shares a docker network with the AR.IO gateway, and so is able to directly interact with the gateway service and data. +The bundler service can be easily run inside Docker in the same way that the gateway is. It utilizes a separate docker compose file for configuration and deployment, which also allows for the use of a separate file for environmental variables specific to the bundler service. Additionally, the separation allows operators to spin their bundler service up or down at any time without affecting their core gateway service. Despite the use of separate docker compose files, the bundler service shares a docker network with the ar.io gateway, and so is able to directly interact with the gateway service and data. For more information on ANS-104 Bundles, see the [ANS-104 Bundles](/learn/ans-104-bundles) page. @@ -15,7 +15,7 @@ For more information on ANS-104 Bundles, see the [ANS-104 Bundles](/learn/ans-10 **NOTE**: The bundler service relies on GraphQL indexing of recently bundled - and uploaded data to manage its pipeline operations. The AR.IO gateway should + and uploaded data to manage its pipeline operations. The ar.io gateway should have its indexes synced up to Arweave's current block height before starting the bundler's service stack. @@ -24,15 +24,15 @@ For more information on ANS-104 Bundles, see the [ANS-104 Bundles](/learn/ans-10 ### Configure Environmental Variables -Environmental variables must be provided for the bundler to function and integrate properly with an existing AR.IO gateway. The gateway repository provides a `.env.bundler.example` file that can be renamed to `.env.bundler` and used as a starting point. It contains the following: +Environmental variables must be provided for the bundler to function and integrate properly with an existing ar.io gateway. The gateway repository provides a `.env.bundler.example` file that can be renamed to `.env.bundler` and used as a starting point. It contains the following: ```bash 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 +# Use localstack s3 bucket for shared data source between ar.io gateway and bundler AWS_S3_BUCKET=ar.io AWS_S3_PREFIX='data' AWS_ACCESS_KEY_ID='test' @@ -45,7 +45,7 @@ AWS_ENDPOINT='http://localstack:4566' - `BUNDLER_ARWEAVE_ADDRESS` must be the [normalized public address](/glossary) for the provided Arweave wallet. - `APP_NAME` is a GraphQL tag that will be added to uploaded bundles. -The remaining lines in the `.env.bundler.example` file control settings that allow the bundler service to share data with the AR.IO gateway. Data sharing of contiguous data between a bundler and a gateway allows the gateway to serve optimistically cached data without waiting for it to fully settle on chain. +The remaining lines in the `.env.bundler.example` file control settings that allow the bundler service to share data with the ar.io gateway. Data sharing of contiguous data between a bundler and a gateway allows the gateway to serve optimistically cached data without waiting for it to fully settle on chain. @@ -106,7 +106,7 @@ AR_IO_ADMIN_KEY="Admin password" ### Starting -The bundler service is designed to run in conjunction with an AR.IO gateway, and so relies on the `ar-io-network` network created in Docker when the core gateway services are spun up. It is possible to spin up the bundler while the core services are down, but the network must exist in Docker. +The bundler service is designed to run in conjunction with an ar.io gateway, and so relies on the `ar-io-network` network created in Docker when the core gateway services are spun up. It is possible to spin up the bundler while the core services are down, but the network must exist in Docker. To start the bundler, specify the env and docker-compose files being used in a `docker compose up` command: diff --git a/content/build/extensions/clickhouse.mdx b/content/build/extensions/clickhouse.mdx index fbe86edae..be27cf5f2 100644 --- a/content/build/extensions/clickhouse.mdx +++ b/content/build/extensions/clickhouse.mdx @@ -1,13 +1,13 @@ --- title: "ClickHouse & Parquet" -description: "Learn how to use Parquet files and ClickHouse to improve performance and scalability of your AR.IO gateway for large datasets." +description: "Learn how to use Parquet files and ClickHouse to improve performance and scalability of your ar.io gateway for large datasets." --- ## Overview -AR.IO gateway Release 33 introduces a new configuration option for using Parquet files and ClickHouse to improve performance and scalability of your AR.IO gateway for large datasets. +Ar.io gateway Release 33 introduces a new configuration option for using Parquet files and ClickHouse to improve performance and scalability of your ar.io gateway for large datasets. -This guide will walk you through the process of setting up ClickHouse with your AR.IO gateway, and importing Parquet files to bootstrap your ClickHouse database. +This guide will walk you through the process of setting up ClickHouse with your ar.io gateway, and importing Parquet files to bootstrap your ClickHouse database. ## What is Parquet? @@ -19,9 +19,9 @@ 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: +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: - **SQLite** continues to handle transaction writes and updates - **ClickHouse** with Parquet files is optimized for fast query performance, especially with large datasets @@ -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: @@ -50,7 +50,7 @@ While SQLite is excellent for transactional workloads and small to medium datase ## Benefits for Gateway Operators -Implementing Parquet and ClickHouse alongside SQLite in your AR.IO gateway offers several key advantages: +Implementing Parquet and ClickHouse alongside SQLite in your ar.io gateway offers several key advantages: - **Dramatically improved query performance** for GraphQL endpoints, especially for large result sets - **Reduced storage requirements** through efficient columnar compression @@ -71,7 +71,7 @@ While Parquet files offer more efficient compression for the data they contain, For gateway operators, this means proper filter configuration is crucial to realize storage benefits. The primary advantage remains significantly improved query performance for large datasets, with potential space savings as a secondary benefit depending on your specific configuration. -The following sections will guide you through setting up ClickHouse with your AR.IO gateway, exporting data from SQLite to Parquet, and importing Parquet files to bootstrap your ClickHouse database. +The following sections will guide you through setting up ClickHouse with your ar.io gateway, exporting data from SQLite to Parquet, and importing Parquet files to bootstrap your ClickHouse database. The below instructions are designed to be used in a linux environment. Windows and MacOS users must modify the instructions to use the appropriate package manager/ command syntax for their platform. diff --git a/content/build/extensions/compute-unit.mdx b/content/build/extensions/compute-unit.mdx index 73b89f367..01e3ea551 100644 --- a/content/build/extensions/compute-unit.mdx +++ b/content/build/extensions/compute-unit.mdx @@ -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 @@ -177,7 +177,7 @@ You can fine-tune the CU's resource usage by adding these optional environment v - To work with the AR.IO process, `PROCESS_WASM_MEMORY_MAX_LIMIT` must be at least `17179869184` (16GB). + To work with the ar.io process, `PROCESS_WASM_MEMORY_MAX_LIMIT` must be at least `17179869184` (16GB). Note: This doesn't mean your server needs 16GB of RAM. This is the maximum memory limit the CU will support for processes. Most processes don't use their maximum allocated memory. diff --git a/content/build/extensions/grafana.mdx b/content/build/extensions/grafana.mdx index 966cfdaec..1ecd811eb 100644 --- a/content/build/extensions/grafana.mdx +++ b/content/build/extensions/grafana.mdx @@ -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"; @@ -11,7 +11,7 @@ import { BarChart3, Database, Package, Cpu } from "lucide-react"; ## Overview -AR.IO gateways track extensive performance and operational metrics using [Prometheus](https://prometheus.io/). A [Grafana](https://grafana.com/) sidecar can be deployed to visualize these metrics, providing an easy way to monitor gateway health and performance. +Ar.io gateways track extensive performance and operational metrics using [Prometheus](https://prometheus.io/). A [Grafana](https://grafana.com/) sidecar can be deployed to visualize these metrics, providing an easy way to monitor gateway health and performance. 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. @@ -139,7 +139,7 @@ server { proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_http_version 1.1; - # Forward AR.IO headers if present in the request + # Forward ar.io headers if present in the request proxy_set_header X-AR-IO-Origin $http_x_ar_io_origin; proxy_set_header X-AR-IO-Origin-Node-Release $http_x_ar_io_origin_node_release; proxy_set_header X-AR-IO-Hops $http_x_ar_io_hops; @@ -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 diff --git a/content/build/extensions/index.mdx b/content/build/extensions/index.mdx index 533f13fac..11eb09d4f 100644 --- a/content/build/extensions/index.mdx +++ b/content/build/extensions/index.mdx @@ -1,6 +1,6 @@ --- title: "Extensions & Sidecars" -description: "Modular tools that can be run alongside an AR.IO gateway to expand its capabilities or enhance the operator experience" +description: "Modular tools that can be run alongside an ar.io gateway to expand its capabilities or enhance the operator experience" --- ## What are Extensions? @@ -11,11 +11,11 @@ The full list of community extensions can be found at [gateways.ar.io/#/extensio ## What are Sidecars? -Sidecars are dockerized services that add additional functionality, APIs, and services to AR.IO gateways. They run as separate containers alongside your gateway, providing specialized capabilities. +Sidecars are dockerized services that add additional functionality, APIs, and services to ar.io gateways. They run as separate containers alongside your gateway, providing specialized capabilities. ## Getting Started with Team-Supported Sidecars -The following sidecars are developed and maintained by the AR.IO team, designed to run alongside your gateway as separate containers. +The following sidecars are developed and maintained by the ar.io team, designed to run alongside your gateway as separate containers. }> @@ -71,7 +71,7 @@ The following sidecars are developed and maintained by the AR.IO team, designed } title="Developer SDKs" - description="Integrate AR.IO services into your applications with our SDKs" + description="Integrate ar.io services into your applications with our SDKs" href="/sdks" /> diff --git a/content/build/guides/depin.mdx b/content/build/guides/depin.mdx index 305937940..353401e10 100644 --- a/content/build/guides/depin.mdx +++ b/content/build/guides/depin.mdx @@ -1,13 +1,13 @@ --- title: "Storing DePIN Data on Arweave Using Turbo" -description: "Complete guide to storing and accessing DePIN network data permanently on Arweave using Turbo and AR.IO Network" +description: "Complete guide to storing and accessing DePIN network data permanently on Arweave using Turbo and Ar.io Network" --- import { Database, Globe, Search, Upload, Tag, Code, Book } from "lucide-react"; DePIN networks require **scalable and cost-effective storage solutions** they can trust. With vast amounts of data generated by decentralized physical infrastructure networks, traditional on-chain storage is prohibitively expensive, yet networks need reliable, long-term access to their device data. -Arweave via AR.IO Network provides **chain-agnostic, permanent and immutable storage** for a one-time fee, ensuring networks can access any device data previously stored and verify it has not been tampered with. +Arweave via Ar.io Network provides **chain-agnostic, permanent and immutable storage** for a one-time fee, ensuring networks can access any device data previously stored and verify it has not been tampered with. ## Getting Started with DePIN Data Storage diff --git a/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx b/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx index 635238c9f..7e8243348 100644 --- a/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx +++ b/content/build/guides/hosting-decentralised-apps/deploying-with-arlink.mdx @@ -11,14 +11,14 @@ import { Zap, Github, Globe, Sparkles, FileCode, Rocket, GitBranch } from 'lucid ![Arlink login page showing GitHub, Wander, and MetaMask authentication options](/arlink-homepage.png) ## Introduction -In the previous guides in this series, we've used a CLI tool called `permaweb-deploy` to configure and host decentralised apps on AR.IO Network. +In the previous guides in this series, we've used a CLI tool called `permaweb-deploy` to configure and host decentralised apps on Ar.io Network. -In this guide we'll be using [Arlink](https://arlink.ar.io), a visual, web-based platform for hosting decentralised apps on AR.IO Network without needing command-line tools. +In this guide we'll be using [Arlink](https://arlink.ar.io), a visual, web-based platform for hosting decentralised apps on Ar.io Network without needing command-line tools. It offers automated builds, GitHub integration, and seamless ArNS management through an intuitive interface. -Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how AR.IO Network enables permanent, decentralised hosting with 100+ independent gateways. +Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how Ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. ## What You'll Learn @@ -143,7 +143,7 @@ Arlink enforces a **10MB max build output** and **10-minute build timeout**. For Once complete, your application is permanently deployed and accessible via: - Your chosen domain (e.g., `myapp_arlink.arweave.net`) -- Any AR.IO gateway (e.g., `myapp_arlink.g8way.io`) +- Any ar.io gateway (e.g., `myapp_arlink.g8way.io`) - Direct transaction ID {/* Screenshot: Successful deployment screen showing URL, transaction ID, and deployment stats */} @@ -158,7 +158,7 @@ Arlink provides free subdomains under the `arlink` ArNS name: - **Format**: `yourname_arlink.arweave.net` - **Cost**: Free (no ArNS purchase required) -- **Availability**: Instant, accessible via all AR.IO gateways +- **Availability**: Instant, accessible via all ar.io gateways - **Limitation**: Must be unique across all Arlink deployments ### Existing ArNS Names diff --git a/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx b/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx index aa0396456..697d8b272 100644 --- a/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx +++ b/content/build/guides/hosting-decentralised-apps/deploying-with-permaweb-deploy.mdx @@ -16,7 +16,7 @@ import { BookOpen, } from 'lucide-react'; -Permaweb-deploy is the recommended CLI tool for hosting decentralised applications on AR.IO Network. +Permaweb-deploy is the recommended CLI tool for hosting decentralised applications on Ar.io Network. It streamlines the entire deployment process by uploading your build folder to Arweave, creating Arweave manifests, and automatically updating your ArNS records in a single command. diff --git a/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx b/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx index 1ea2451fc..6593e9d11 100644 --- a/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx +++ b/content/build/guides/hosting-decentralised-apps/hosting-with-ardrive.mdx @@ -13,7 +13,7 @@ import { Upload, Globe, Code } from 'lucide-react'; Create **permanent dApps** using the ArDrive web interface. This guide shows you how to deploy your dApp or website to the permaweb using ArDrive's user-friendly interface. -Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how AR.IO Network enables permanent, decentralised hosting with 100+ independent gateways. +Check out the [series introduction](/build/guides/hosting-decentralised-apps) to learn how Ar.io Network enables permanent, decentralised hosting with 100+ independent gateways. ## What You'll Learn diff --git a/content/build/guides/hosting-decentralised-apps/index.mdx b/content/build/guides/hosting-decentralised-apps/index.mdx index 3a8bf1d4d..1708552c1 100644 --- a/content/build/guides/hosting-decentralised-apps/index.mdx +++ b/content/build/guides/hosting-decentralised-apps/index.mdx @@ -1,5 +1,5 @@ --- -title: "Hosting Decentralised Apps on AR.IO Network" +title: "Hosting Decentralised Apps on Ar.io Network" description: "Learn how to deploy permanent, censorship-resistant websites and applications to Arweave with ArNS domain integration" --- @@ -15,7 +15,7 @@ import { The goal of decentralised apps (dapps) has always been full stack. However, until now, that has not been possible due to single points of failure for hosting frontends. -AR.IO Network solves this via: +Ar.io Network solves this via: - **Permanent Storage**: Pay once and store your site forever on [Arweave](https://arweave.org/). - **Smart Domains**: a sovereign owned domain-space via [Arweave Name System (ArNS)](/learn/arns). @@ -32,7 +32,7 @@ You can repeat this by loading the `docs` subdomain for any of the ~600 active g ## What You'll Learn -In this guide series, you'll learn how to deploy and manage permanent applications on AR.IO Network. +In this guide series, you'll learn how to deploy and manage permanent applications on Ar.io Network. We'll cover the following: diff --git a/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx b/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx index da4e1fc63..5c1592d21 100644 --- a/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx +++ b/content/build/guides/hosting-decentralised-apps/using-undernames-for-versioning.mdx @@ -401,5 +401,5 @@ You now know how to manage multiple environments using ArNS undernames: - **GitHub Actions automation** for branch-based deployments - **Instant rollbacks** through the ArNS app interface -In our next guides we're explore other tools you can use to host websites on AR.IO Network without needing to configure `permaweb-deploy`. +In our next guides we're explore other tools you can use to host websites on Ar.io Network without needing to configure `permaweb-deploy`. diff --git a/content/build/guides/index.mdx b/content/build/guides/index.mdx index 7199e65dd..3d8f18e74 100644 --- a/content/build/guides/index.mdx +++ b/content/build/guides/index.mdx @@ -1,16 +1,16 @@ --- title: "Guides" -description: "Discover what you can build with Arweave and AR.IO infrastructure" +description: "Discover what you can build with Arweave and ar.io infrastructure" --- import { Card, Cards } from "fumadocs-ui/components/card"; import { Rocket, Globe, ShoppingCart } from "lucide-react"; -Explore real-world applications and use cases for **Arweave** and **AR.IO** infrastructure. These examples show what's possible with permanent data storage and decentralized web services. +Explore real-world applications and use cases for **Arweave** and **ar.io** infrastructure. These examples show what's possible with permanent data storage and decentralized web services. ## What You Can Build -**Arweave and AR.IO enable:** +**Arweave and ar.io enable:** - **Decentralized websites** - Host permanent, censorship-resistant web content - **ArNS domains** - Create and manage decentralized domain names diff --git a/content/build/guides/storing-nfts.mdx b/content/build/guides/storing-nfts.mdx index af1a26314..cd702f626 100644 --- a/content/build/guides/storing-nfts.mdx +++ b/content/build/guides/storing-nfts.mdx @@ -1,5 +1,5 @@ --- -title: "Storing NFTs on AR.IO Network" +title: "Storing NFTs on Ar.io Network" description: "Learn how to store NFT assets permanently on Arweave with guaranteed access forever using Turbo and ar:// protocol" --- @@ -8,7 +8,7 @@ import { Steps, Step } from "fumadocs-ui/components/steps"; import { Card, Cards } from "fumadocs-ui/components/card"; import { Shield, DollarSign, Globe, Image } from "lucide-react"; -Storing NFT assets on AR.IO Network ensures they're permanent, immutable and accessible, forever. +Storing NFT assets on Ar.io Network ensures they're permanent, immutable and accessible, forever. We achieve this by providing: @@ -17,18 +17,18 @@ We achieve this by providing: - **Decentralised Gateways**: a network of 100s of incentivized gateways provide access. - **Routing Protocol**: ar://wayfinder ensures an active gateway is selected for all requests. -Once your NFT assets are stored on AR.IO Network, no one can delete, edit or "rug" them. +Once your NFT assets are stored on Ar.io Network, no one can delete, edit or "rug" them. That means Creators can be confident their art will live on forever and Collectors can be confident their investment won't disappear. -## How to Store NFT assets on AR.IO Network +## How to Store NFT assets on Ar.io Network -First, it's important to understand AR.IO Network doesn't let you mint NFTs. What it does provide is permanent storage and access for the media files (images, video, animations) and metadata (artist, attributes, traits) JSON which is used in NFTs. +First, it's important to understand Ar.io Network doesn't let you mint NFTs. What it does provide is permanent storage and access for the media files (images, video, animations) and metadata (artist, attributes, traits) JSON which is used in NFTs. -To mint an NFT you'd typically store your assets and metadata via AR.IO Network and then use another service to "mint" the NFTs onchain. +To mint an NFT you'd typically store your assets and metadata via Ar.io Network and then use another service to "mint" the NFTs onchain. -This guide is targeted at developers. If you're not a developer we strongly recommend uploading to AR.IO Network via [ArDrive](https://ardrive.io), check out this amazing video guide from [Hashlips](https://x.com/Hashlipsnft): +This guide is targeted at developers. If you're not a developer we strongly recommend uploading to Ar.io Network via [ArDrive](https://ardrive.io), check out this amazing video guide from [Hashlips](https://x.com/Hashlipsnft):