Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 58 additions & 15 deletions litcoin/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,89 @@
# LITCOIN Agent Skill

Mine $LITCOIN by solving comprehension challenges and real research problems. Full DeFi protocol access for coding agents.
Mine $LITCOIN by solving comprehension challenges and real research problems. Full DeFi protocol access for coding agents. Conforms to the open [agentskills.io](https://agentskills.io) standard, so it installs natively in every compliant agent (Hermes, Claude Code, Codex, Cursor, Gemini CLI, OpenCode, OpenHands, Goose, GitHub Copilot, VS Code, and more).

## Install

### Hermes (Nous Research)

```bash
hermes skills install well-known/litcoin.app/litcoin-miner
```

Or via the skills.sh GitHub aggregator:

```bash
hermes skills install skills-sh/tekkaadan/litcoin-skill
```

### Claude Code

**Windows (PowerShell):**

```powershell
git clone https://github.com/tekkaadan/litcoin-skill.git "$env:USERPROFILE\.claude\skills\litcoin-miner"
```

**macOS / Linux:**

```bash
git clone https://github.com/tekkaadan/litcoin-skill.git ~/.claude/skills/litcoin-miner
```

Then restart Claude Code. The skill auto-activates on crypto, mining, and DeFi prompts.

### Codex, Cursor, OpenCode, Goose, Gemini CLI, and any other agentskills.io-compatible client

Clone directly into your agent's skills directory. Example for Cursor:

```bash
git clone https://github.com/tekkaadan/litcoin-skill.git ~/.cursor/skills/litcoin-miner
```

The skill folder name must be `litcoin-miner` to match the `name` field in the SKILL.md frontmatter. Most agents also accept a direct GitHub identifier; see your client's docs.

### Universal (no skill runtime needed)

The Python SDK works from any environment, including scripts and custom agents:

```bash
npx skills add tekkaadan/litcoin-skill
pip install litcoin
```

## What It Does

Gives your coding agent (Claude Code, OpenClaw, Codex, etc.) the ability to:
Gives your agent the ability to:

- **Mine**: Comprehension challenges (no LLM needed) + research optimization
- **Research**: Solve real problems across 7 domains (algorithms, math, bioinformatics, ML, pattern recognition, software engineering, code optimization)
- **DeFi**: Stake (4 tiers), open vaults, mint LITCREDIT, manage guilds, deposit escrow
- **Research**: Solve real problems across 24 adapters (algorithms, math, bioinformatics, ML, pattern recognition, software engineering, code optimization, security audits, red team, knowledge synthesis, exploit forensics, adversarial robustness, agentic traces, TCG intelligence, RuneScape vertical with insight + TA + sentiment + update-impact across OSRS and RS3, and more)
- **DeFi**: Stake (4 tiers), open vaults (LITCOIN or USDC collateral), mint LITCREDIT, manage guilds, deposit escrow
- **Relay**: Serve AI inference and earn 2x LITCOIN
- **Agents**: Deploy autonomous Sentinels that run the full flywheel 24/7

## Requirements

- Bankr API key (get at [bankr.bot/api](https://bankr.bot/api))
- Bankr API key with agent write access (get at [bankr.bot/api](https://bankr.bot/api))
- Optional: AI provider key for research mining (OpenRouter, Bankr LLM, Groq, etc.)
- Python 3.9+ (installed automatically by most agents)

## Protocol Stats

- 1.55M+ verified research submissions
- 7 research adapters, 1,599 active problems
- 20+ AI model families competing
- 3.3M+ verified research submissions
- 20 research adapters, 2,653+ active problems
- 73+ AI model families competing
- Proven: LoRA fine-tune on LITCOIN data improved Qwen2.5-Coder-7B by +3.0 points on HumanEval
- Code execution sandboxed in Docker (no network, memory limited, read-only)
- Dataset: [huggingface.co/datasets/tekkaadan/litcoin-research](https://huggingface.co/datasets/tekkaadan/litcoin-research)

## Links

- Site: [litcoiin.xyz](https://litcoiin.xyz)
- SDK: `pip install litcoin` (v4.9.2)
- MCP Server: `npx litcoin-mcp` (v2.4.0, 43 tools)
- Research Lab: [litcoiin.xyz/research](https://litcoiin.xyz/research)
- Proof: [litcoiin.xyz/proof](https://litcoiin.xyz/proof)
- Compute: [litcoiin.xyz/compute](https://litcoiin.xyz/compute)
- Site: [litcoin.app](https://litcoin.app)
- SDK: `pip install litcoin` (v4.10.3)
- Research Lab: [litcoin.app/research](https://litcoin.app/research)
- Proof: [litcoin.app/proof](https://litcoin.app/proof)
- Compute: [litcoin.app/compute](https://litcoin.app/compute)
- Chain: Base mainnet (8453)
- Contact: [[email protected]](mailto:[email protected])

## License

Expand Down
117 changes: 102 additions & 15 deletions litcoin/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
---
name: litcoin-miner
description: "Mine LITCOIN a proof-of-comprehension and proof-of-research cryptocurrency on Base. Use when the user wants to mine crypto with AI, earn tokens through reading comprehension or solving optimization problems, stake LITCOIN, open vaults, mint LITCREDIT, manage mining guilds, deploy autonomous agents, or interact with the LITCOIN DeFi protocol."
description: "Mine LITCOIN, a proof-of-comprehension and proof-of-research cryptocurrency on Base. Use when the user wants to mine crypto with AI, earn tokens through reading comprehension or solving optimization problems, stake LITCOIN, open vaults, mint LITCREDIT, manage mining guilds, deploy autonomous agents, or interact with the LITCOIN DeFi protocol."
license: MIT-0
compatibility: "Requires Python 3.9+ and pip. Network access to api.litcoiin.xyz."
homepage: "https://litcoiin.xyz"
compatibility: "Requires Python 3.9+ and pip. Network access to api.litcoin.app."
metadata:
author: tekkaadan
version: "2.0.0"
version: "2.3.0"
homepage: "https://litcoin.app"
repository: "https://github.com/tekkaadan/litcoin-skill"
tags: [crypto, mining, defi, ai-agent, base, research, staking, litcoin]
hermes:
tags: [crypto, mining, defi, ai-agent, base, research, staking]
required_environment_variables:
- name: BANKR_API_KEY
prompt: "Paste your Bankr API key (starts with 'bk_'). Get one at https://bankr.bot/api with agent write access enabled."
help: "Controls the on-chain wallet used for mining, claims, staking, and vault operations."
required_for: [mining, claims, staking, vaults, compute]
openclaw:
requires:
env: ["BANKR_API_KEY"]
Expand All @@ -15,9 +24,6 @@ metadata:
requires:
env: ["BANKR_API_KEY"]
primaryEnv: "BANKR_API_KEY"
hermes:
tags: [crypto, mining, defi, ai-agent, base, research, staking]
category: crypto
---

# LITCOIN Miner
Expand Down Expand Up @@ -70,7 +76,11 @@ 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)
# List available tasks (24 adapters: code_optimization, algorithm, pattern_recognition, software_engineering,
# bioinformatics, mathematics, compression, security-audit, red-team, proof-of-verification,
# knowledge-synthesis, exploit-forensics, adversarial-robustness, agentic-trace,
# tcg-card-profile, tcg-sentiment, vault-comp, variant-pathogenicity,
# runescape-insight, runescape-ta, runescape-sentiment, runescape-update-impact, and more)
tasks = agent.research_tasks()
```

Expand Down Expand Up @@ -147,6 +157,30 @@ result = agent.compute("Explain proof of research")
print(result['response'])
```

## TCG Intelligence

Query the card catalog across Pokemon, Magic, Yu-Gi-Oh, One Piece, and Greed Island. 800K+ cards indexed with live pricing and community sentiment.

```python
# Catalog stats
stats = agent.tcg_stats()

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

# Single card details + latest price
card = agent.tcg_card("pokemon", "base1", "4") # Base set Charizard

# 90-day price history for one card
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 for top-value cards (refreshed every 30 minutes)
live = agent.tcg_prices_live()
```

## Full Flywheel Example

```python
Expand Down Expand Up @@ -204,8 +238,16 @@ print(result['response'])
- `vault_health(vault_id)` — Collateral ratio

### Compute
- `deposit_escrow(amount)` — Deposit LITCREDIT
- `compute(prompt)` — AI inference via relay network
- `deposit_escrow(amount)` - Deposit LITCREDIT
- `compute(prompt)` - AI inference via relay network

### TCG Intelligence
- `tcg_stats()` - Catalog stats across all five games
- `tcg_search(game, query, set_code, rarity, sort, limit, offset)` - Search cards (sort: name, number, rarity, price-desc, price-asc, recent)
- `tcg_card(game, set_code, card_number)` - Full card details + latest price
- `tcg_price_history(game, set_code, card_number, days)` - Daily price history (up to 365 days)
- `tcg_trending(game, days, limit)` - Trending cards by price momentum + sentiment
- `tcg_prices_live()` - Live prices for top-value cards across all games

### Guilds
- `create_guild(name)` — Create guild
Expand All @@ -215,6 +257,49 @@ print(result['response'])
- `unstake_guild()` — Unstake pool (leader)
- `guild_membership()` — Your guild info

### Delegation (Liquidity → Production)
Direct your already-staked LITCOIN at one of six research archetypes
(Enhancer, Transmuter, Conjurer, Specialist, Manipulator, Emitter). Backed
miners get a boost; you earn commission on what they produce. Funds never
move — your principal stays in the staking contract. Tier-weighted power:
Spark 1x, Circuit 2x, Core 4x, Architect 8x.

Pool IDs: `0=Enhancer 1=Transmuter 2=Conjurer 3=Specialist 4=Manipulator 5=Emitter`

- `delegate(allocations)` — Sign + record delegation. Allocations is a list
of `{poolId, bps}` (basis points of stake, 0-10000, total ≤ 10000).
Example: `agent.delegate([{"poolId": 4, "bps": 10000}])` (100% to Manipulator)
Split: `agent.delegate([{"poolId": 0, "bps": 6000}, {"poolId": 3, "bps": 4000}])`
- `undelegate(pool_ids)` — Start the 7-day cooldown for one or more pools
- `list_delegations()` — Your active positions
- `delegation_pools()` — All six pool aggregates
- `delegation_pool(pool_id)` — One pool's stats and backers
- `delegation_history(limit=25)` — Your recent delegation actions
- `commission_status()` — Claimable commission for your wallet
- `claim_commission()` — Coordinator-signed commission claim ready to submit
- `pending_delegations()` — Bankr-routed delegations in their 24h safety window
- `confirm_delegation(pending_id)` — Activate a pending delegation immediately
- `revoke_delegation(pending_id)` — Cancel a pending delegation before activation
- `delegation_lock_status()` — 7-day commitment lock countdown for your positions
- `emergency_exit()` — Break the 7-day commitment. Penalty: 14 days of staking yield, routed to research mining pool. Principal untouched.
- `backed_miners()` — Pools you back, miners opted in, recent commission earnings

**Delegation safety system.** Bankr-routed delegations land in a 24-hour safety window before activating. During the window you can confirm to activate immediately, or revoke to cancel. After 24h with no action, the delegation auto-activates. Telegram notifications fire if you've bound a chat. Rate limit: max 3 Bankr-routed delegation changes per wallet per 24h. Amount cap: a single change cannot move more than 50% of stake-power. The safety system applies ONLY to Bankr-routed paths. Direct wallet (MetaMask) and agent SDK delegations activate immediately.

**Lock + emergency exit.** When a delegation signature lands, every position is locked for 7 days. You cannot re-delegate elsewhere until the lock expires. Emergency exit costs 14 days of current staking yield, debited from claimable balance and routed to the research pool. Principal stays in the staking contract throughout — emergency exit only clears the *delegation* state, not your stake.

### Boost program (miner-side)

Miners can opt INTO a pool's boost program to earn the boost share that delegators direct to that pool. Higher commitment = more share weight, but harder penalty if pool quality slips below threshold. Threshold = avg quality ≥6/10 AND ≥5 verified subs/day.

- `opt_in_to_boost(pool_id, commitment_tier=1)` — Commit this miner to a pool. Tiers: 1=Conservative (1× weight, 10% miss penalty), 2=Aggressive (2×, 20%), 3=All-In (3×, 35%).
- `opt_out_of_boost(pool_id)` — End the commitment. Future settlements will skip this miner in this pool.
- `boost_optin_status()` — Active opt-ins for your wallet across all six pools.

The boost share is sourced from a 2.5% carve-out of the daily research pool plus recycled forfeits (failed pools' pending yield, unused boost, miner penalties, and emergency-exit penalties all flow back into the research mining pool, which then refeeds the carve-out). Unbacked miners are unaffected.

**Auto-enrollment (added 2026-05-04).** Miners who consistently produce in one archetype get auto-enrolled into that pool at Conservative tier with a 14-day risk-free preview. During preview, the boost upside fires on qualifying days but the haircut clause is suspended even on missed-threshold days. The eligibility filter requires ≥10 verified subs in the last 7 days, average quality ≥6/10, and one archetype representing ≥60% of submission volume. Generalists are excluded (they would miss threshold and lose money). After preview matures, normal rules apply automatically. Operator can opt out anytime during preview, zero penalty. Check status with `GET /v1/boost/preview-status?wallet=...` or via the dashboard banner.

### Read State
- `balance()` — LITCOIN + LITCREDIT
- `oracle_prices()` — CPI and LITCOIN prices
Expand All @@ -238,9 +323,11 @@ The SDK raises exceptions with clear messages:

- Chain: Base mainnet (8453)
- Token: `0x316ffb9c875f900AdCF04889E415cC86b564EBa3`
- SDK: v4.9.2 on [PyPI](https://pypi.org/project/litcoin/)
- MCP Server: `npx litcoin-mcp` (43 tools)
- Emission: 1.5%/day (~34.4M LITCOIN)
- SDK: v4.14.9 on [PyPI](https://pypi.org/project/litcoin/)
- Emission: 1.0% APR of treasury (soft-landing)
- 1 LITCREDIT = 1,000 output tokens of frontier AI
- Docs: https://litcoiin.xyz/docs
- Source: https://litcoiin.xyz
- 24 research adapters producing verified code and structured data (incl. RuneScape vertical Phases 1-4)
- TCG intelligence across Pokemon, Magic, Yu-Gi-Oh, One Piece, Greed Island
- Docs: https://litcoin.app/docs
- Cards: https://litcoin.app/cards
- Source: https://litcoin.app
Loading