Merge pull request #54 from ar-io/PE-8666-402

Pe 8666 402

Author: djwhitt

content/build/run-a-gateway/manage/environment-variables.mdx

@@ -255,6 +255,40 @@ The main AR.IO Gateway service that handles data retrieval, indexing, and servin
 | `LMDB_DATA_PATH`       | string | `./data/lmdb`       | Path to LMDB data       |
 | `PARQUET_DATA_PATH`    | string | `./data/parquet`    | Path to Parquet data    |
 
+### Rate Limiter
+
+| Variable                                  | Type    | Default   | Description                         |
+| ----------------------------------------- | ------- | --------- | ----------------------------------- |
+| `ENABLE_RATE_LIMITER`                     | boolean | `false`   | Enable rate limiting system         |
+| `RATE_LIMITER_TYPE`                       | string  | `memory`  | Rate limiter type (memory or redis) |
+| `RATE_LIMITER_REDIS_ENDPOINT`             | string  | -         | Redis endpoint for rate limiter     |
+| `RATE_LIMITER_IP_TOKENS_PER_BUCKET`       | number  | `100000`  | IP bucket token capacity            |
+| `RATE_LIMITER_IP_REFILL_PER_SEC`          | number  | `20`      | IP bucket refill rate per second    |
+| `RATE_LIMITER_RESOURCE_TOKENS_PER_BUCKET` | number  | `1000000` | Resource bucket token capacity      |
+| `RATE_LIMITER_RESOURCE_REFILL_PER_SEC`    | number  | `100`     | Resource bucket refill rate         |
+| `RATE_LIMITER_IPS_AND_CIDRS_ALLOWLIST`    | string  | -         | Comma-separated IP/CIDR allowlist   |
+| `RATE_LIMITER_ARNS_ALLOWLIST`             | string  | -         | Comma-separated ArNS allowlist      |
+
+### x402 Payment Protocol
+
+| Variable                               | Type    | Default        | Description                                |
+| -------------------------------------- | ------- | -------------- | ------------------------------------------ |
+| `ENABLE_X_402_USDC_DATA_EGRESS`        | boolean | `false`        | Enable x402 USDC payments                  |
+| `X_402_USDC_NETWORK`                   | string  | -              | Base network (base-sepolia or base)        |
+| `X_402_USDC_WALLET_ADDRESS`            | string  | -              | USDC wallet address for receiving payments |
+| `X_402_USDC_FACILITATOR_URL`           | string  | -              | Payment facilitator URL                    |
+| `X_402_USDC_PER_BYTE_PRICE`            | number  | `0.0000000001` | Price per byte in USDC                     |
+| `X_402_USDC_DATA_EGRESS_MIN_PRICE`     | number  | `0.001`        | Minimum payment amount                     |
+| `X_402_USDC_DATA_EGRESS_MAX_PRICE`     | number  | `1.00`         | Maximum payment amount                     |
+| `X_402_RATE_LIMIT_CAPACITY_MULTIPLIER` | number  | `10`           | Paid token capacity multiplier             |
+| `X_402_APP_NAME`                       | string  | -              | Application name for paywall               |
+| `X_402_APP_LOGO`                       | string  | -              | Application logo URL for paywall           |
+| `X_402_CDP_CLIENT_KEY`                 | string  | -              | **PUBLIC**: CDP client key for Onramp (optional testnet, required mainnet) |
+| `CDP_API_KEY_ID`                       | string  | -              | **SECRET**: CDP API key ID for Onramp (optional testnet, required mainnet)      |
+| `CDP_API_KEY_SECRET`                   | string  | -              | **SECRET**: CDP API secret for Onramp (use CDP_API_KEY_SECRET_FILE instead)    |
+| `CDP_API_KEY_SECRET_FILE`              | string  | -              | **SECRET**: Path to CDP secret file for Onramp (takes precedence, recommended) |
+| `CHUNK_GET_BASE64_SIZE_BYTES`          | number  | `368640`       | Fixed size for chunk pricing               |
+
 ## Observer Service
 
 ### Basic Configuration

content/build/run-a-gateway/manage/index.mdx

@@ -3,7 +3,17 @@ title: "Manage your Gateway"
 description: "Comprehensive guides for advanced AR.IO Gateway operations including monitoring, optimization, content moderation, and specialized configurations"
 ---
 
-import { Database, RotateCcw, TrendingUp, Zap, Globe, Shield, Settings, Wrench } from "lucide-react";
+import {
+  Database,
+  RotateCcw,
+  TrendingUp,
+  Zap,
+  Globe,
+  Shield,
+  Settings,
+  Wrench,
+  CreditCard,
+} from "lucide-react";
 
 Master the advanced features and configurations of your AR.IO Gateway. These comprehensive guides cover everything from performance optimization to content moderation, helping you run a professional-grade gateway infrastructure.
 
@@ -39,8 +49,17 @@ Master the advanced features and configurations of your AR.IO Gateway. These com
   Configure advanced filters to efficiently process and index only the data you need, optimizing performance and resource usage.
 </Card>
 
-<Card title="Setting Apex Domain Content" href="/build/run-a-gateway/manage/setting-apex-domain" icon={<Globe className="w-6 h-6" />}>
-  Customize your gateway's root domain to serve custom content, project information, or documentation instead of default network info.
+<Card
+  title="Setting Apex Domain Content"
+  href="/build/run-a-gateway/manage/setting-apex-domain"
+  icon={<Globe className="w-6 h-6" />}
+>
+  Customize your gateway's root domain to serve custom content, project
+  information, or documentation instead of default network info.
+</Card>
+
+<Card title="x402 Payment Setup" href="/build/run-a-gateway/manage/x402-setup" icon={<CreditCard className="w-6 h-6" />}>
+  Configure x402 payment protocol to monetize data egress with frictionless cryptocurrency payments and premium access tiers.
 </Card>
 </Cards>
 
@@ -82,4 +101,3 @@ Master the advanced features and configurations of your AR.IO Gateway. These com
     failed epoch guidance, and frequently asked questions.
   </Card>
 </Cards>
-

content/build/run-a-gateway/manage/meta.json

@@ -4,11 +4,12 @@
   "pages": [
     "upgrading-a-gateway",
     "ssl-certs",
+    "environment-variables",
     "filters",
     "content-moderation",
     "index-snapshots",
     "setting-apex-domain",
-    "troubleshooting",
-    "environmental-variables"
+    "x402-setup",
+    "troubleshooting"
   ]
 }