Skip to content

README.md

Latest commit

 

History

History
98 lines (74 loc) · 4.93 KB

README.md

File metadata and controls

98 lines (74 loc) · 4.93 KB

OmniClaw Documentation

OmniClaw is a policy-controlled payment layer for agents, applications, and machine services.

Use this index to choose the right integration path.

Choose Your Path

Role Start Here What You Build
Agent buyer Agent Getting Started An agent that pays through omniclaw-cli
Python buyer Developer Guide A backend service that pays programmatically
Vendor / enterprise seller Developer Guide A FastAPI service with paid endpoints through the SDK
Infrastructure team Operator CLI Financial Policy Engine, policies, and facilitators
Maintainer Production Readiness Proof checklist and ship status

Buyer Guides

Guide Use Case
Agent Getting Started Configure an agent with omniclaw-cli
CLI Reference Full generated omniclaw-cli command reference
Developer Guide Pay with the Python SDK
API Reference SDK methods, request shapes, and payment APIs

Seller Guides

Guide Use Case
Developer Guide Add production paid FastAPI routes with client.sell()
B2B SDK Integration Enterprise SDK deployment with Circle, Thirdweb, or self-hosted exact
Vendor Integration Production-style vendor API integration
Business Compute Payment-gated compute service
CLI Reference Agent-facing paid service flow with omniclaw-cli serve

Machine Payment Examples

Example Demonstrates
B2B SDK Integration Enterprise buyer/seller SDK integration
Machine to Machine One automated service paying another
Machine to Vendor Agent buyer paying a vendor-owned API
Local Economy Local buyer/seller stack with Docker
External x402 Facilitator x402.org exact settlement on Base Sepolia
Thirdweb HTTP Facilitator Thirdweb HTTP facilitator integration
Arc Marketplace Showcase Visual vendor kiosk with Arc Testnet x402 exact settlement

Arc Testnet Quickstart

Run the full Arc marketplace showcase with Docker-reachable service IPs:

bash scripts/start_arc_marketplace_showcase_docker.sh

The buyer key must hold Arc Testnet USDC for the selected paid product, and the seller/facilitator key must hold Arc Testnet gas. The launcher prints balances, product URLs, the exact OmniClaw config, and a lower-cost $0.10 proof endpoint when the buyer wallet is not funded for the $0.25 product.

The showcase UI also has a built-in mini buyer agent, so the full demo can run directly from the browser. The kiosk backend proxies inspect/pay actions into the buyer Financial Policy Engine while keeping the policy token server-side.

Defaults:

Service URL
Browser UI http://127.0.0.1:8020
Vendor kiosk http://172.18.0.51:8020
Buyer policy engine http://172.18.0.52:8080
Exact facilitator http://172.18.0.50:4022

For setup details and ArcLens submission notes, see Arc Marketplace Showcase.

Operator and Production Docs

Document Covers
Operator CLI omniclaw server, omniclaw setup, omniclaw facilitator exact
Policy Reference Tokens, wallets, budgets, recipient rules, confirmations
Facilitators Circle Gateway, x402.org, Thirdweb, self-hosted exact
Production Readiness Live proof status and release checklist
Production Hardening Deployment controls, Redis, nonce, security settings

Architecture and Reference

Document Covers
Architecture and Features Core design, route selection, guards, settlement paths
Architecture Diagram System overview
Compliance Architecture Compliance and control framing
CCTP Usage Circle CCTP notes
ERC-804 Spec Trust-related specification notes

Project Files

File Purpose
CHANGELOG Release history
CONTRIBUTING Development and PR workflow
SECURITY Security reporting
ROADMAP Built status and planned work