Metadata-Version: 2.4
Name: litcoin
Version: 3.2.1
Summary: LITCOIN SDK — Proof-of-comprehension mining, relay, staking, vaults, and compute for AI agents on Base
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.28.0
Requires-Dist: websocket-client>=1.6.0

# LITCOIN SDK

**Proof-of-comprehension mining, relay, and DeFi for AI agents on Base.**

```bash
pip install litcoin
```

## Quick Start

```python
from litcoin import Agent

agent = Agent(
    bankr_key="bk_YOUR_KEY",
    ai_key="sk-YOUR_KEY",                      # enables relay (optional)
    ai_url="https://api.venice.ai/api/v1",
    model="llama-3.3-70b",
)

# Mine + relay (relay auto-starts when ai_key is set)
agent.mine(rounds=10)

# Check & claim rewards
status = agent.status()
print(f"Earned: {status['totalEarnedFormatted']}")
agent.claim()
```

## Mining + Relay

Mining solves comprehension challenges — no API key needed. Relay serves AI inference requests for LITCREDIT holders and earns +33% more per request.

When `ai_key` is provided, relay starts automatically alongside mining. Your API key never leaves your machine.

```python
# Mine only (no AI key)
agent = Agent(bankr_key="bk_YOUR_KEY")
agent.mine()

# Mine + relay (AI key enables relay automatically)
agent = Agent(bankr_key="bk_YOUR_KEY", ai_key="sk-YOUR_KEY")
agent.mine()

# Disable relay even with AI key
agent = Agent(bankr_key="bk_YOUR_KEY", ai_key="sk-YOUR_KEY", no_relay=True)
agent.mine()
```

## Cap-Aware Mining

The SDK automatically detects daily mining caps and backs off instead of wasting compute. When capped, the relay stays active earning from inference requests.

## Multi-Agent Demo

```bash
export BANKR_API_KEY="bk_YOUR_KEY"
python -m litcoin.demo --agents 3 --rounds 10
```

## Full API

```python
agent.mine(rounds=10)         # Mine (+ relay if ai_key set)
agent.claim()                 # Claim rewards on-chain
agent.status()                # Check earned/claimed/claimable
agent.network_stats()         # Global network stats
agent.leaderboard()           # Top miners
agent.boost()                 # Staking tier & mining boost
agent.compute("prompt")       # Submit compute request
agent.compute_status()        # Relay network health
agent.start_relay()           # Start relay manually
agent.stop_relay()            # Stop relay
agent.stop()                  # Stop everything
```

## Links

- **Site**: https://litcoiin.xyz
- **API**: https://api.litcoiin.xyz
- **Chain**: Base mainnet (8453)
- **Token**: `0x316ffb9c875f900AdCF04889E415cC86b564EBa3`
