@arkade-os/skill 0.1.0

package/README.md

@@ -0,0 +1,116 @@
+# @arkade-os/skill
+
+Arkade SDK skills for agent integration - send and receive Bitcoin over Arkade, onchain via onboard/offboard, Lightning Network via Boltz, and swap USDC/USDT via LendaSwap.
+
+## Features
+
+- **Bitcoin on Arkade**: Instant offchain Bitcoin transactions
+- **Onchain Payments**: Get paid onchain (onboard) and pay onchain (offboard)
+- **Lightning Network**: Pay and receive via Boltz submarine swaps
+- **Stablecoin Swaps**: Trade BTC for USDC/USDT on Polygon, Ethereum, Arbitrum
+- **CLI for Agents**: Command-line interface designed for MoltBot and other agents
+
+**Default Server:** https://arkade.computer
+
+## Installation
+
+```bash
+npm install @arkade-os/skill
+# or
+pnpm add @arkade-os/skill
+```
+
+## Quick Start
+
+### CLI Usage
+
+```bash
+# Initialize wallet
+arkade init <private-key-hex>
+
+# Check balance
+arkade balance
+
+# Send Bitcoin
+arkade send <ark-address> 50000
+
+# Create Lightning invoice
+arkade ln-invoice 25000 "Coffee payment"
+
+# Pay Lightning invoice
+arkade ln-pay lnbc...
+```
+
+### SDK Usage
+
+```typescript
+import { Wallet, SingleKey } from "@arkade-os/sdk";
+import {
+  ArkadeBitcoinSkill,
+  ArkaLightningSkill,
+  LendaSwapSkill,
+} from "@arkade-os/skill";
+
+// Create wallet
+const wallet = await Wallet.create({
+  identity: SingleKey.fromHex(privateKeyHex),
+  arkServerUrl: "https://arkade.computer",
+});
+
+// Bitcoin operations
+const bitcoin = new ArkadeBitcoinSkill(wallet);
+const balance = await bitcoin.getBalance();
+await bitcoin.send({ address: "ark1...", amount: 50000 });
+
+// Lightning operations
+const lightning = new ArkaLightningSkill({ wallet, network: "bitcoin" });
+const invoice = await lightning.createInvoice({ amount: 25000 });
+
+// Stablecoin swaps
+const lendaswap = new LendaSwapSkill({ wallet, apiKey: "..." });
+const quote = await lendaswap.getQuoteBtcToStablecoin(100000, "usdc_pol");
+```
+
+## Available Skills
+
+| Skill | Description |
+|-------|-------------|
+| `ArkadeBitcoinSkill` | Send/receive BTC via Arkade offchain, get paid onchain (onboard), pay onchain (offboard) |
+| `ArkaLightningSkill` | Lightning payments via Boltz swaps |
+| `LendaSwapSkill` | USDC/USDT swaps via LendaSwap |
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `init <key> [url]` | Initialize wallet |
+| `address` | Show Ark address |
+| `boarding-address` | Show boarding address |
+| `balance` | Show balance breakdown |
+| `send <addr> <amt>` | Send sats |
+| `history` | Transaction history |
+| `onboard` | Get paid onchain: convert received onchain BTC to offchain |
+| `offboard <addr>` | Pay onchain: send offchain BTC to an onchain address |
+| `ln-invoice <amt>` | Create Lightning invoice |
+| `ln-pay <bolt11>` | Pay Lightning invoice |
+| `ln-fees` | Show swap fees |
+| `ln-limits` | Show swap limits |
+| `swap-quote <amt> <from> <to>` | Get stablecoin quote |
+| `swap-to-stable <amt> <token> <chain> <addr>` | Swap BTC to stablecoin |
+| `swap-to-btc <amt> <token> <chain> <addr>` | Swap stablecoin to BTC |
+| `swap-status <id>` | Check swap status |
+| `swap-pending` | Show pending swaps |
+| `swap-pairs` | Show trading pairs |
+
+## Configuration
+
+- **Data:** `~/.arkade-wallet/config.json`
+- **Env:** `LENDASWAP_API_KEY` for stablecoin swaps
+
+## Documentation
+
+See [SKILL.md](./SKILL.md) for detailed agent integration documentation.
+
+## License
+
+MIT

package/SKILL.md

@@ -0,0 +1,269 @@
+---
+name: arkade
+description: Send and receive Bitcoin over Arkade (offchain), onchain (via onboard/offboard), and Lightning. Swap USDC/USDT stablecoins.
+read_when:
+  - user wants to send or receive Bitcoin
+  - user mentions Arkade, Ark, or offchain Bitcoin
+  - user wants to use Lightning Network
+  - user wants to swap BTC for stablecoins (USDC, USDT)
+  - user wants to on-ramp or off-ramp Bitcoin
+  - user wants to get paid onchain or pay someone onchain
+  - user mentions boarding address or VTXOs
+  - user wants instant Bitcoin payments
+metadata:
+  emoji: "₿"
+  requires:
+    - private key (64 hex characters)
+    - LENDASWAP_API_KEY (for stablecoin swaps)
+---
+
+# Arkade Skill
+
+Send and receive Bitcoin over Arkade (offchain), onchain (via onboard/offboard), and Lightning Network.
+Swap between BTC and stablecoins (USDC/USDT) via LendaSwap.
+
+**Payment methods:**
+- **Offchain (Arkade)**: Instant transactions between Arkade wallets
+- **Onchain**: Get paid onchain via boarding address (onboard), pay onchain via offboard
+- **Lightning**: Pay and receive via Boltz submarine swaps
+
+**Default Server:** https://arkade.computer
+
+## Installation
+
+```bash
+npm install @arkade-os/skill
+# or
+pnpm add @arkade-os/skill
+```
+
+## CLI Commands
+
+### Wallet Management
+
+```bash
+# Initialize wallet with private key (default server: arkade.computer)
+arkade init <private-key-hex>
+
+# Initialize with custom server
+arkade init <private-key-hex> https://custom-server.com
+
+# Show Ark address (for receiving offchain Bitcoin)
+arkade address
+
+# Show boarding address (for onchain deposits)
+arkade boarding-address
+
+# Show balance breakdown
+arkade balance
+```
+
+### Bitcoin Transactions
+
+```bash
+# Send sats to an Ark address
+arkade send <ark-address> <amount-sats>
+
+# Example: Send 50,000 sats
+arkade send ark1qxyz... 50000
+
+# View transaction history
+arkade history
+```
+
+### Onchain Payments (Onboard/Offboard)
+
+```bash
+# Get paid onchain: Receive BTC to your boarding address, then onboard to Arkade
+# Step 1: Get your boarding address
+arkade boarding-address
+
+# Step 2: Have someone send BTC to your boarding address
+
+# Step 3: Onboard the received BTC to make it available offchain
+arkade onboard
+
+# Pay onchain: Send offchain BTC to any onchain Bitcoin address
+arkade offboard <btc-address>
+
+# Example: Pay someone at bc1 address
+arkade offboard bc1qxyz...
+```
+
+### Lightning Network
+
+```bash
+# Create a Lightning invoice to receive payment
+arkade ln-invoice <amount-sats> [description]
+
+# Example: Create invoice for 25,000 sats
+arkade ln-invoice 25000 "Coffee payment"
+
+# Pay a Lightning invoice
+arkade ln-pay <bolt11-invoice>
+
+# Show swap fees
+arkade ln-fees
+
+# Show swap limits
+arkade ln-limits
+
+# Show pending swaps
+arkade ln-pending
+```
+
+### Stablecoin Swaps (LendaSwap)
+
+Requires `LENDASWAP_API_KEY` environment variable.
+
+```bash
+# Get quote for BTC to stablecoin swap
+arkade swap-quote <amount-sats> <from> <to>
+
+# Example: Quote 100,000 sats to USDC on Polygon
+arkade swap-quote 100000 btc_arkade usdc_pol
+
+# Show available trading pairs
+arkade swap-pairs
+```
+
+**Supported Tokens:**
+- `btc_arkade` - Bitcoin on Arkade
+- `usdc_pol` - USDC on Polygon
+- `usdc_eth` - USDC on Ethereum
+- `usdc_arb` - USDC on Arbitrum
+- `usdt_pol` - USDT on Polygon
+- `usdt_eth` - USDT on Ethereum
+- `usdt_arb` - USDT on Arbitrum
+
+## SDK Usage
+
+```typescript
+import { Wallet, SingleKey } from "@arkade-os/sdk";
+import {
+  ArkadeBitcoinSkill,
+  ArkaLightningSkill,
+  LendaSwapSkill,
+} from "@arkade-os/skill";
+
+// Create wallet (default server: arkade.computer)
+const wallet = await Wallet.create({
+  identity: SingleKey.fromHex(privateKeyHex),
+  arkServerUrl: "https://arkade.computer",
+});
+
+// === Bitcoin Operations ===
+const bitcoin = new ArkadeBitcoinSkill(wallet);
+
+// Get addresses
+const arkAddress = await bitcoin.getArkAddress();
+const boardingAddress = await bitcoin.getBoardingAddress();
+
+// Check balance
+const balance = await bitcoin.getBalance();
+console.log("Total:", balance.total, "sats");
+console.log("Offchain available:", balance.offchain.available, "sats");
+console.log("Onchain pending:", balance.onchain.total, "sats");
+
+// Send Bitcoin
+const result = await bitcoin.send({
+  address: recipientArkAddress,
+  amount: 50000,
+});
+console.log("Sent! TX:", result.txid);
+
+// === Lightning Operations ===
+const lightning = new ArkaLightningSkill({
+  wallet,
+  network: "bitcoin",
+});
+
+// Create invoice
+const invoice = await lightning.createInvoice({
+  amount: 25000,
+  description: "Coffee payment",
+});
+console.log("Invoice:", invoice.bolt11);
+
+// Pay invoice
+const payment = await lightning.payInvoice({
+  bolt11: "lnbc...",
+});
+console.log("Paid! Preimage:", payment.preimage);
+
+// === Stablecoin Swaps ===
+const lendaswap = new LendaSwapSkill({
+  wallet,
+  apiKey: process.env.LENDASWAP_API_KEY,
+});
+
+// Get quote
+const quote = await lendaswap.getQuoteBtcToStablecoin(100000, "usdc_pol");
+console.log("You'll receive:", quote.targetAmount, "USDC");
+
+// Execute swap
+const swap = await lendaswap.swapBtcToStablecoin({
+  targetAddress: "0x...", // EVM address
+  targetToken: "usdc_pol",
+  targetChain: "polygon",
+  sourceAmount: 100000,
+});
+console.log("Swap ID:", swap.swapId);
+```
+
+## Configuration
+
+**Data Storage:** `~/.arkade-wallet/config.json`
+
+**Environment Variables:**
+- `LENDASWAP_API_KEY` - Required for stablecoin swaps
+
+## Skill Interfaces
+
+### ArkadeBitcoinSkill
+
+- `getArkAddress()` - Get Ark address for receiving offchain payments
+- `getBoardingAddress()` - Get boarding address for receiving onchain payments
+- `getBalance()` - Get balance breakdown
+- `send(params)` - Send Bitcoin to Ark address (offchain)
+- `getTransactionHistory()` - Get transaction history
+- `onboard(params)` - Get paid onchain: convert onchain BTC to offchain
+- `offboard(params)` - Pay onchain: send offchain BTC to any onchain address
+- `waitForIncomingFunds(timeout?)` - Wait for incoming funds
+
+### ArkaLightningSkill
+
+- `createInvoice(params)` - Create Lightning invoice
+- `payInvoice(params)` - Pay Lightning invoice
+- `getFees()` - Get swap fees
+- `getLimits()` - Get swap limits
+- `getPendingSwaps()` - Get pending swaps
+- `getSwapHistory()` - Get swap history
+- `isAvailable()` - Check if Lightning is available
+
+### LendaSwapSkill
+
+- `getQuoteBtcToStablecoin(amount, token)` - Quote BTC to stablecoin
+- `getQuoteStablecoinToBtc(amount, token)` - Quote stablecoin to BTC
+- `swapBtcToStablecoin(params)` - Swap BTC to stablecoin
+- `swapStablecoinToBtc(params)` - Swap stablecoin to BTC
+- `getSwapStatus(swapId)` - Get swap status
+- `getPendingSwaps()` - Get pending swaps
+- `getSwapHistory()` - Get swap history
+- `getAvailablePairs()` - Get available trading pairs
+- `claimSwap(swapId)` - Claim completed swap
+- `refundSwap(swapId)` - Refund expired swap
+
+## Networks
+
+Arkade supports multiple networks:
+- `bitcoin` - Bitcoin mainnet
+- `testnet` - Bitcoin testnet
+- `signet` - Bitcoin signet
+- `regtest` - Local regtest
+- `mutinynet` - Mutiny signet
+
+## Support
+
+- GitHub: https://github.com/arkade-os/skill
+- Documentation: https://docs.arkade.computer