sparkbtcbot-skill

Spark Bitcoin L2 wallet skill for AI agents — encrypted-at-rest seed storage, Lightning interop, L402 paywall payment, BTKN/LRC20 tokens. Works with Claude Code via the plugin marketplace, and with any other LLM agent framework via the npm package.

What is Spark?

Spark is a Bitcoin Layer 2 that lets you send and receive Bitcoin instantly with low fees. Spark-to-Spark transfers are free, and Lightning interop costs 0.15–0.25%. It is fully self-custodial — you hold your own keys via a BIP39 mnemonic — and fully interoperable with the Lightning Network. Spark currently has a small number of infrastructure providers (Signing Operators), so there is some risk of downtime, and it requires trusting that at least one operator behaves honestly during transfers.

Why Spark for Agents?

• Simple setup — Generate a mnemonic and you have a wallet. No accounts, no API keys, no approval process.
• No server required — The SDK connects directly to the Spark network. No node to run, no infrastructure to maintain.
• No channel management — Unlike Lightning, there are no channels to open, fund, or rebalance. Just send and receive.
• Low fees — Spark-to-Spark transfers are free. Lightning payments cost 0.15–0.25%. Compare that to on-chain fees of 200+ sats or card processing at 2–3%.

Capabilities

• Wallet Setup — Generate or import wallets from a BIP39 mnemonic
• BTC Balance & Deposits — Check balance, generate L1 deposit addresses, claim deposits
• Spark Transfers — Instant, zero-fee BTC transfers between Spark wallets
• Lightning Invoices — Create and pay BOLT11 invoices for Lightning compatibility
• Spark Invoices — Native invoices payable in sats or BTKN tokens
• Token Operations — Transfer BTKN/LRC20 tokens, batch transfers, token invoices
• Withdrawal — Cooperative exit back to L1 Bitcoin with fee estimation
• Message Signing — Prove identity via cryptographic signatures
• L402 Paywalls — Pay-per-request APIs via Lightning. Preview costs, pay invoices, cache tokens.

Installation

Two install paths depending on your stack.

Claude Code

claude plugin marketplace add https://github.com/echennells/sparkbtcbot-skill
claude plugin install sparkbtcbot

Native plugin install. Updates flow through claude plugin update sparkbtcbot. Claude reads SKILL.md automatically when the skill triggers.

Any other LLM agent framework (Cursor, LangChain, OpenAI Agents SDK, Aider, etc.)

npm install sparkbtcbot-skill

The package ships both the skill content (so you can load it into your LLM's context) and the encryption library (so generated code can import the helpers). Minimal use:

import { getSkillContent, getReference, listReferences } from "sparkbtcbot-skill";

// Always-loaded skill body — pass to your framework's system-prompt mechanism
const instructions = await getSkillContent();

// On-demand reference docs by name
console.log(await listReferences());
// → ['agent-class', 'architecture', 'encrypted-seed', 'extras', 'l402',
//    'lightning', 'spark-invoices', 'tokens', 'wallet']
const l402Doc = await getReference("l402");

Generated code (or your own glue) can also import the encryption helpers:

import { saveEncryptedMnemonic, loadMnemonicFromEnv } from "sparkbtcbot-skill";

await saveEncryptedMnemonic({ mnemonic, passphrase, path: "./seed.enc" });
const decrypted = await loadMnemonicFromEnv(); // reads SPARK_PASSPHRASE

The package has zero runtime dependencies beyond Node 18+ built-ins.

Local clone (for running the example scripts and tests yourself)

git clone https://github.com/echennells/sparkbtcbot-skill.git ~/.claude/skills/sparkbtcbot-skill
cd ~/.claude/skills/sparkbtcbot-skill
npm install

The Quick Start below assumes this path — useful if you want to kick the tires on the example scripts (npm run example:balance etc.) before integrating.

Quick Start

# Install dependencies (in the cloned skill directory)
cd ~/.claude/skills/sparkbtcbot-skill
npm install

# Copy env template, set SPARK_PASSPHRASE (>=12 chars)
cp .env.example .env
$EDITOR .env

# One-time setup: generate a wallet, encrypt the mnemonic at ~/.spark/seed.enc.
# This also writes a backup file (~/.spark/MNEMONIC_BACKUP_*.txt, mode 0600)
# containing the 12 words; setup prints the path.
npm run setup

# Back up the mnemonic offline (paper / password manager / hardware backup),
# then delete the backup file:
cat ~/.spark/MNEMONIC_BACKUP_*.txt   # confirm path matches what setup printed
rm  ~/.spark/MNEMONIC_BACKUP_*.txt   # AFTER you have a copy offline

# Run the examples
npm run example:balance
npm run example:payments

The mnemonic is never stored in plaintext anywhere the runtime reads. npm run setup writes an encrypted seed file (~/.spark/seed.enc, mode 0600); the runtime reads SPARK_PASSPHRASE from env and decrypts it once at boot. The backup file from setup is a one-time artifact for the user to copy from — it does not auto-delete; you rm it once you have an offline backup. See skills/sparkbtcbot/references/encrypted-seed.md for the threat model and recovery scenarios.

Example Scripts

| Script | npm script | Purpose | |--------|------------|---------| | setup-encrypted-seed.js | npm run setup | Generate wallet, encrypt mnemonic at rest | | balance-and-deposits.js | npm run example:balance | Check balance (BTC + tokens), get deposit addresses | | payment-flow.js | npm run example:payments | Lightning invoices, Spark invoices, fee estimation | | token-operations.js | npm run example:tokens | BTKN token balances, transfers, batch operations | | l402-paywalls.js | npm run example:l402 | Access L402 pay-per-request APIs via Lightning | | spark-agent.js | npm run example:agent | Complete SparkAgent class with all capabilities |

Environment Variables

| Variable | Required | Description | |----------|----------|-------------| | SPARK_PASSPHRASE | Yes | Passphrase (≥12 chars) that decrypts the seed file at boot. Set during npm run setup. | | SPARK_NETWORK | No | MAINNET (default), REGTEST, TESTNET, SIGNET | | SPARK_SEED_PATH | No | Override for the encrypted-seed file location. Defaults to ~/.spark/seed.enc. | | SPARK_ACCOUNT_NUMBER | No | BIP32 account index. Defaults: 1 (MAINNET), 0 (REGTEST) |

Dependencies

npm install @buildonspark/spark-sdk dotenv light-bolt11-decoder

Security

Passphrase + seed file = full wallet access. Either alone is useless; both together control all funds. There is no permission scoping, no spending limits, no read-only mode in the SDK.

Recommendations:

• Never expose the mnemonic or passphrase in code, logs, or version control
• Treat SPARK_PASSPHRASE like any production secret (deployment secret manager, .env in .gitignore, etc.)
• Don't bundle seed.enc into container images that ship alongside the passphrase
• Use a dedicated wallet with limited funds for each agent
• Use separate accountNumber values for different funding tiers
• Back up the mnemonic offline — the encrypted seed file is not a substitute for an offline seed backup
• For production with non-trivial balances, run sparkbtcbot-proxy — keeps the seed on a server you control and gives the agent only HTTP access via revocable scoped tokens

Resources

• Spark Docs
• Spark SDK (npm)
• Sparkscan Explorer

License

MIT