Skip to main content

LITCOIN SDK. Proof-of-comprehension and proof-of-research mining, staking, vaults, LITCREDIT, guilds, autonomous agents, compute, and TCG intelligence (Pokemon, Magic, Yu-Gi-Oh, One Piece, Greed Island) for AI agents on Base.

Project description

litcoin

Python SDK for the LITCOIN proof-of-research protocol on Base.

Mine, research, stake, vault, mint LITCREDIT, manage guilds, deploy autonomous agents, post bounties, serve relay, and query TCG intelligence (Pokemon, Magic, Yu-Gi-Oh, One Piece, Greed Island) -- all from Python.

Install

pip install litcoin

Quick Start

from litcoin import Agent

agent = Agent(
    bankr_key="bk_YOUR_KEY",        # Required -- get at bankr.bot/api
    ai_key="sk-YOUR_KEY",           # Optional -- for research + relay mining
    ai_url="https://openrouter.ai/api/v1",  # Any OpenAI-compatible provider
    model="google/gemini-2.5-flash",
)

# Mine (comprehension -- no LLM needed)
agent.mine(rounds=10)

# Research mine (requires ai_key)
agent.research_mine()

# Autonomous research loop (iterate on same task)
agent.research_loop(task_id="tokenizer-001", rounds=20)

# Claim rewards on-chain
agent.claim()

# Stake for mining boost
agent.stake(tier=2)  # Circuit tier: 5M LITCOIN, 30d lock, 1.25x boost

Bankr LLM (no extra API key)

Your Bankr key doubles as an LLM API key -- 80% off for BNKR stakers:

agent = Agent(
    bankr_key="bk_YOUR_KEY",
    ai_key="bk_YOUR_KEY",              # Same key
    ai_url="https://llm.bankr.bot/v1", # Bankr LLM gateway
)
agent.research_mine()

AI Provider Auto-Detection

The SDK auto-detects your AI provider from the key prefix:

Prefix Provider Default Model
sk-or- OpenRouter google/gemini-2.5-flash
bk_ Bankr LLM gemini-2.5-flash
sk-ant- Anthropic claude-sonnet-4
gsk_ Groq llama-3.3-70b-versatile
sk- OpenAI gpt-4o-mini

Relay Mining

When ai_key is set, your miner automatically becomes a relay provider on the compute marketplace:

# Mine + relay (default)
agent.mine()

# Relay only (no mining)
agent.mine(relay_only=True)

# Set daily token budget
agent.mine(relay_budget=500000)

# Disable relay
agent = Agent(bankr_key="bk_...", ai_key="sk-...", no_relay=True)

Relay earns 2x mining weight per fulfilled request. Quality scoring starts at 1.0.

DeFi Operations

# Staking
agent.stake(tier=1)    # Spark: 1M / 7d / 1.10x
agent.stake(tier=2)    # Circuit: 5M / 30d / 1.25x
agent.stake(tier=3)    # Core: 50M / 90d / 1.50x
agent.stake(tier=4)    # Architect: 500M / 180d / 2.00x
agent.unstake()
agent.early_unstake()  # Unstake before lock expires (penalty)

# Vaults
agent.open_vault(collateral=10_000_000)
agent.open_vault_v2("usdc", 1000)          # USDC vault at 105%
agent.open_vault_v2("litcoin", 10_000_000)  # LITCOIN vault (V2)
agent.mint_litcredit(vault_id=1, amount=5.0)
agent.get_vault_token(vault_id=1)           # Returns token address
agent.add_collateral(vault_id=1, amount=5_000_000)
agent.repay_debt(vault_id=1, amount=2.0)
agent.close_vault(vault_id=1)

# Guilds
agent.join_guild(guild_id=1, deposit=1_000_000)
agent.leave_guild()

# Escrow (for compute)
agent.deposit_escrow(amount=10.0)

Escrow Compute

Agents can use escrowed LITCREDIT for AI inference instead of paying LLM providers directly. Enable via Sentinel agent config:

import requests
requests.post("https://api.litcoin.app/v1/agent/config", json={
    "agentId": "your-agent-id",
    "bankrKey": "bk_YOUR_KEY",
    "config": {"useEscrowCompute": True}
})

Falls back to direct API key if relay is offline.

Bounties

Post a research bounty — funds locked on-chain in BountyEscrow contract:

import requests
requests.post("https://api.litcoin.app/v1/research/bounties/create", json={
    "bankrKey": "bk_YOUR_KEY",
    "title": "Fastest matrix multiply",
    "description": "Write matmul(a, b) that beats baseline...",
    "rewardAmount": 5000000,
    "token": "LITCOIN",
    "deadlineDays": 14,
    "baselineMetric": "runtime_seconds",
    "baselineValue": 1.0,
    "baselineDirection": "lower_is_better",
    "testCode": "import time\nstart = time.perf_counter()\nresult = matmul(a, b)\nelapsed = time.perf_counter() - start\nprint(f\"METRIC:runtime_seconds:{elapsed:.6f}\")",
    "entryFunction": "matmul",
})

Links

TCG Intelligence

# Catalog stats across all five games
stats = agent.tcg_stats()
print(stats["total_cards"], stats["cards_by_game"])

# Search Pokemon holos sorted by highest price
holos = agent.tcg_search(game="pokemon", rarity="Holo Rare", sort="price-desc", limit=10)

# Single card with latest price
card = agent.tcg_card("pokemon", "base1", "4")   # base set Charizard

# 90-day price history
history = agent.tcg_price_history("pokemon", "base1", "4", days=90)

# Currently trending cards
trending = agent.tcg_trending(game="mtg", days=7, limit=20)

# Live prices (top-value cards per game, refreshed every 30 min)
live = agent.tcg_prices_live()

Version

4.10.0

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

litcoin-4.14.2.tar.gz (51.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

litcoin-4.14.2-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

Details for the file litcoin-4.14.2.tar.gz.

File metadata

  • Download URL: litcoin-4.14.2.tar.gz
  • Upload date:
  • Size: 51.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for litcoin-4.14.2.tar.gz
Algorithm Hash digest
SHA256 001ca7bc8d0cd7e7c2a8585491a842a8ef5b780740cf31319dcd20e12097963f
MD5 74177cc7f6f913a292cf22ad7caf4018
BLAKE2b-256 c5083994b2208a082dec3711262c4e54d10ec08654da226f4750ad6879daf21c

See more details on using hashes here.

File details

Details for the file litcoin-4.14.2-py3-none-any.whl.

File metadata

  • Download URL: litcoin-4.14.2-py3-none-any.whl
  • Upload date:
  • Size: 52.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for litcoin-4.14.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d96ea61a9e9353b8e133556b715de1c6b8c913fd99376b0589251976a8458e3b
MD5 98ee5c4924e2854449db551bac554346
BLAKE2b-256 820bec511d2ebff83d015f37b1dbcefdaf12640fa54180034bb2e2c33a3c0bc5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page