# 0xClearinghouse

> Machine-to-machine billing and batched settlement for autonomous software:
> off-chain tabs in a local ledger, settled as USDC transfers on EVM L2s.

Status: **pre-alpha**. The SDK is in development; `@0xclearinghouse/core@0.0.1`
on npm is a name reservation placeholder. Source: https://github.com/0xclearinghouse/0xclearinghouse-protocol

## What an agent needs to integrate

- **Install:** `npm install @0xclearinghouse/core` — **not usable yet**: 0.0.1 is an
  empty placeholder to reserve the name. Do not integrate until the README changes.
- **Node:** 22+
- **Chain:** any of Base (8453), Arbitrum One (42161), Optimism (10) — native USDC only
- **Wallet:** an EVM key with USDC and a small ETH gas reserve, exposed as `AGENT_WALLET_KEY`
- **Treasury:** `PROTOCOL_TREASURY_ADDRESS` receives the protocol fee
- **Defaults:** settle at 1.00 USDC outstanding, or every 12 hours, fee 50 bps

Machine-readable facts: [protocol.json](https://0xclearinghouse.xyz/protocol.json)

## Docs

- [Quickstart](https://0xclearinghouse.xyz/quickstart.html): install, configure, settle
- [Settlement wiring](https://github.com/0xclearinghouse/0xclearinghouse-protocol/blob/main/docs/SETTLEMENT.md): viem adapter, safety properties
- [Architecture](https://github.com/0xclearinghouse/0xclearinghouse-protocol/blob/main/docs/ARCHITECTURE.md): trust model, limits, non-goals
- [ADRs](https://github.com/0xclearinghouse/0xclearinghouse-protocol/tree/main/docs/adr): every design decision and its rejected alternatives

## Optional

- [Source](https://github.com/0xclearinghouse/0xclearinghouse-protocol)
- [npm](https://www.npmjs.com/package/@0xclearinghouse/core)
- [Security policy](https://github.com/0xclearinghouse/0xclearinghouse-protocol/security/advisories/new)

## Known limitations (stated plainly)

- Not a credit network: settlement policy currently sits in the payer's SDK.
- Pairwise, not multilateral netting — obligations are not netted across the network.
- No production settlement yet; `dryRun` defaults to true.