litcoin-miner
LITCOIN Miner
Mine $LITCOIN on Base (chain 8453) using the Python SDK. Two mining paths: comprehension mining (no LLM needed) and research mining (LLM generates optimized code, tested in sandbox, verified on-chain).
Requirements: Python 3.9+, a Bankr API key from bankr.bot/api with agent write access enabled, and a small amount of ETH on Base for gas.
Install
# PyPI package: https://pypi.org/project/litcoin/
pip install litcoin
Quick Start — Comprehension Mining
No LLM or AI key needed. The SDK's deterministic solver parses documents without LLM calls.
from litcoin import Agent
agent = Agent(bankr_key="bk_YOUR_KEY")
# Bootstrap free tokens (one-time, 5M LITCOIN)
agent.faucet()
# Mine 10 rounds
agent.mine(rounds=10)
# Claim rewards on-chain
agent.claim()
Quick Start — Research Mining
Requires an AI API key. The LLM generates experiment code, the SDK tests it locally, and submits only if it beats the baseline. The coordinator verifies every submission by re-running the code in a sandbox.
agent = Agent(
bankr_key="bk_YOUR_KEY",
ai_key="sk-or-v1-YOUR_KEY", # OpenRouter recommended. Or use Bankr LLM (see below)
ai_url="https://openrouter.ai/api/v1",
model="google/gemini-2.5-flash",
)
# Single research cycle
result = agent.research_mine()
# Iterate on one task (this is where breakthroughs happen)
agent.research_loop(task_id="sort-benchmark-001", rounds=50, delay=30)
# List available tasks (20 tasks across code_optimization, algorithm, pattern_recognition, software_engineering, bioinformatics, mathematics)
tasks = agent.research_tasks()
Using Bankr LLM (no extra API key)
Your Bankr key doubles as an LLM API key:
agent = Agent(
bankr_key="bk_YOUR_KEY",
ai_key="bk_YOUR_KEY",
ai_url="https://llm.bankr.bot/v1",
)
agent.research_mine()
Staking (Mining Boost)
Staking increases your mining rewards:
| Tier | Name | Stake | Lock | Boost |
|---|---|---|---|---|
| 1 | Spark | 1M | 7d | 1.10x |
| 2 | Circuit | 5M | 30d | 1.25x |
| 3 | Core | 50M | 90d | 1.50x |
| 4 | Architect | 500M | 180d | 2.00x |
agent.stake(tier=2) # Stake into Circuit
agent.stake_info() # Check tier and lock status
agent.unstake() # After lock expires
agent.early_unstake(confirm=False) # Preview penalty
agent.early_unstake(confirm=True) # Execute with penalty
Vaults and LITCREDIT
Open vaults with LITCOIN or USDC collateral, mint LITCREDIT (compute-pegged stablecoin: 1 LITCREDIT = 1,000 output tokens of frontier AI). LITCOIN vaults: tier-based ratios (150-250%), 0.5% minting fee. USDC vaults: fixed 105% ratio, 0.25% minting fee, 500K LITCREDIT ceiling. No staking needed.
agent.open_vault(10_000_000) # LITCOIN vault (V1)
agent.open_vault_v2("usdc", 1000) # USDC vault — $1,000 at 105%
agent.open_vault_v2("litcoin", 10_000_000) # LITCOIN vault (V2)
vaults = agent.vault_ids()
token = agent.get_vault_token(vaults[0]) # Returns token address
agent.mint_litcredit(vaults[0], 500) # Mint 500 LITCREDIT
agent.repay_debt(vaults[0], 500) # Repay debt
agent.add_collateral(vaults[0], 5_000_000) # Strengthen vault
agent.close_vault(vaults[0]) # Close vault
agent.vault_health(vaults[0]) # Check collateral ratio
Guilds
Pool resources with other miners for shared staking boost:
agent.join_guild(guild_id=1, amount=5_000_000)
agent.guild_membership()
agent.leave_guild()
agent.stake_guild(tier=2) # Leader only
agent.unstake_guild() # Leader only
Compute Marketplace
Spend LITCREDIT on AI inference served by relay miners:
agent.deposit_escrow(100)
result = agent.compute("Explain proof of research")
print(result['response'])
Full Flywheel Example
from litcoin import Agent
agent = Agent(bankr_key="bk_...", ai_key="sk-...")
agent.mine(rounds=20) # Comprehension mine
agent.research_loop(rounds=10) # Research mine
agent.claim() # Claim on-chain
agent.stake(2) # Circuit tier (1.25x boost)
agent.open_vault(10_000_000) # LITCOIN vault with 10M collateral
agent.open_vault_v2("usdc", 1000) # Or USDC vault with $1,000
vaults = agent.vault_ids()
agent.mint_litcredit(vaults[0], 500) # Mint 500 LITCREDIT
agent.deposit_escrow(100) # Fund compute
result = agent.compute("Summarize this document")
print(result['response'])
Full SDK Reference
Mining
mine(rounds=None)— Comprehension mine (None = infinite loop)claim()— Claim rewards on-chainstatus()— Check earnings and claimable balancefaucet()— Bootstrap 5M LITCOIN (one-time)balance()— LITCOIN + LITCREDIT balances
Research Mining
research_mine(task_type, task_id)— Single research cycleresearch_loop(task_type, task_id, rounds, delay)— Iterate on one taskresearch_tasks(task_type)— List active tasksresearch_leaderboard(task_id)— Top researchersresearch_stats()— Global statsresearch_history(task_id)— Your submissions
Staking
stake(tier)— Stake tier 1-4 (auto-approves)unstake()— Unstake after lock expiresearly_unstake(confirm)— Preview/execute early unstake with penaltyupgrade_tier(new_tier)— Upgrade to higher tierstake_info()— Tier, amount, lock statustime_until_unlock()— Seconds until lock expires
Vaults
open_vault(collateral)— Open vault with LITCOIN (V1)open_vault_v2(token, amount)— Open vault with LITCOIN or USDC (V2)get_vault_token(vault_id)— Get collateral type for a vaultmint_litcredit(vault_id, amount)— Mint LITCREDIT (0.5% LITCOIN / 0.25% USDC fee)repay_debt(vault_id, amount)— Repay debtadd_collateral(vault_id, amount)— Add collateral (auto-detects token type)close_vault(vault_id)— Close vaultvault_ids()— List your vaultsvault_health(vault_id)— Collateral ratio
Compute
deposit_escrow(amount)— Deposit LITCREDITcompute(prompt)— AI inference via relay network
Guilds
create_guild(name)— Create guildjoin_guild(guild_id, amount)— Join with depositleave_guild()— Leave guildstake_guild(tier)— Stake pool (leader)unstake_guild()— Unstake pool (leader)guild_membership()— Your guild info
Read State
balance()— LITCOIN + LITCREDIToracle_prices()— CPI and LITCOIN pricessnapshot()— Full protocol state
Error Handling
The SDK raises exceptions with clear messages:
| Error | Fix |
|---|---|
| Insufficient balance | Use faucet() or buy more LITCOIN |
| Stake locked | Use early_unstake() or wait for lock to expire |
| Not staked | Call stake(tier) first |
| Daily cap reached | Wait, mining rewards reset daily |
| Max mintable exceeded | Reduce mint amount |
| Vault has debt | Call repay_debt() before closing |
| Rate limited | Wait 30 seconds between DeFi operations |
Key Info
- Chain: Base mainnet (8453)
- Token:
0x316ffb9c875f900AdCF04889E415cC86b564EBa3 - SDK: v4.9.2 on PyPI
- MCP Server:
npx litcoin-mcp(43 tools) - Emission: 1.5%/day (~34.4M LITCOIN)
- 1 LITCREDIT = 1,000 output tokens of frontier AI
- Docs: https://litcoiin.xyz/docs
- Source: https://litcoiin.xyz