@mcpsovereign/sdk 0.1.0 → 0.2.0

package/dist/wallet/lnd-setup.js

@@ -0,0 +1,501 @@
+/**
+ * Automated LND Setup for mcpSovereign
+ *
+ * This module handles:
+ * 1. Docker installation check
+ * 2. LND container deployment (Neutrino mode - no full node needed)
+ * 3. Wallet creation
+ * 4. Credential extraction
+ * 5. Configuration for SDK
+ *
+ * Based on the same setup used for mcpsovereign.com
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+import { spawn, exec } from 'child_process';
+import { promisify } from 'util';
+const execAsync = promisify(exec);
+// ============================================================
+// DEFAULT CONFIG
+// ============================================================
+const DEFAULT_CONFIG = {
+    containerName: 'sovereign-agent-lnd',
+    network: 'mainnet',
+    alias: 'SovereignAgent',
+    restPort: 8089,
+    grpcPort: 10009,
+    p2pPort: 9735,
+    dataDir: path.join(process.env.HOME || '.', '.sovereign-lnd')
+};
+// ============================================================
+// DOCKER COMPOSE TEMPLATE
+// ============================================================
+function generateDockerCompose(config) {
+    return `# Generated by mcpSovereign SDK
+# LND Lightning Node (Neutrino mode - no full Bitcoin node required)
+
+services:
+  lnd:
+    image: lightninglabs/lnd:v0.18.0-beta
+    container_name: ${config.containerName}
+    restart: unless-stopped
+    volumes:
+      - ${config.dataDir}:/root/.lnd
+    ports:
+      - "${config.p2pPort}:9735"
+      - "${config.grpcPort}:10009"
+      - "${config.restPort}:8080"
+    command: >
+      lnd
+      --bitcoin.active
+      --bitcoin.${config.network}
+      --bitcoin.node=neutrino
+      --neutrino.addpeer=btcd-mainnet.lightning.computer
+      --neutrino.addpeer=mainnet1-btcd.zaphq.io
+      --neutrino.addpeer=mainnet2-btcd.zaphq.io
+      --fee.url=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
+      --alias=${config.alias}
+      --rpclisten=0.0.0.0:10009
+      --restlisten=0.0.0.0:8080
+      --tlsextradomain=${config.containerName}
+      --tlsextraip=0.0.0.0
+      --accept-keysend
+      --accept-amp
+      --gc-canceled-invoices-on-startup
+    networks:
+      - sovereign-net
+
+networks:
+  sovereign-net:
+    driver: bridge
+`;
+}
+// ============================================================
+// SYSTEM CHECKS
+// ============================================================
+async function checkDocker() {
+    try {
+        const { stdout } = await execAsync('docker --version');
+        const version = stdout.trim();
+        // Check if Docker daemon is running
+        try {
+            await execAsync('docker ps');
+            return { installed: true, running: true, version };
+        }
+        catch {
+            return { installed: true, running: false, version };
+        }
+    }
+    catch {
+        return { installed: false, running: false };
+    }
+}
+async function checkDockerCompose() {
+    try {
+        await execAsync('docker compose version');
+        return true;
+    }
+    catch {
+        try {
+            await execAsync('docker-compose --version');
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+// ============================================================
+// LND SETUP CLASS
+// ============================================================
+export class LNDSetup {
+    config;
+    logs = [];
+    constructor(config = {}) {
+        this.config = { ...DEFAULT_CONFIG, ...config };
+    }
+    log(message) {
+        this.logs.push(`[${new Date().toISOString()}] ${message}`);
+        console.log(message);
+    }
+    /**
+     * Check if system is ready for LND setup
+     */
+    async checkPrerequisites() {
+        this.log('Checking prerequisites...');
+        // Check Docker
+        const docker = await checkDocker();
+        this.log(`Docker: ${docker.installed ? 'Installed' : 'Not installed'} ${docker.running ? '(running)' : '(not running)'}`);
+        // Check Docker Compose
+        const compose = await checkDockerCompose();
+        this.log(`Docker Compose: ${compose ? 'Available' : 'Not available'}`);
+        // Check disk space (Neutrino needs ~1GB, we'll ask for 5GB to be safe)
+        let diskSpace = { available: 0, required: 5 * 1024 * 1024 * 1024, sufficient: false };
+        try {
+            const { stdout } = await execAsync(`df -B1 ${this.config.dataDir} 2>/dev/null || df -B1 ${process.env.HOME || '.'}`);
+            const lines = stdout.trim().split('\n');
+            if (lines.length > 1) {
+                const parts = lines[1].split(/\s+/);
+                diskSpace.available = parseInt(parts[3]) || 0;
+                diskSpace.sufficient = diskSpace.available > diskSpace.required;
+            }
+        }
+        catch {
+            diskSpace.sufficient = true; // Assume OK if we can't check
+        }
+        this.log(`Disk space: ${Math.round(diskSpace.available / 1024 / 1024 / 1024)}GB available`);
+        return {
+            ready: docker.installed && docker.running && compose && diskSpace.sufficient,
+            docker,
+            compose,
+            diskSpace
+        };
+    }
+    /**
+     * Install Docker if not present (Linux only)
+     */
+    async installDocker() {
+        this.log('Attempting to install Docker...');
+        const platform = process.platform;
+        if (platform !== 'linux') {
+            this.log(`Automatic Docker installation not supported on ${platform}.`);
+            this.log('Please install Docker manually:');
+            this.log('  macOS: https://docs.docker.com/desktop/install/mac-install/');
+            this.log('  Windows: https://docs.docker.com/desktop/install/windows-install/');
+            return false;
+        }
+        try {
+            // Use Docker's official install script
+            this.log('Running Docker install script...');
+            await execAsync('curl -fsSL https://get.docker.com | sh');
+            // Add current user to docker group
+            const user = process.env.USER || 'root';
+            await execAsync(`sudo usermod -aG docker ${user}`);
+            // Start Docker service
+            await execAsync('sudo systemctl start docker');
+            await execAsync('sudo systemctl enable docker');
+            this.log('Docker installed successfully!');
+            this.log('NOTE: You may need to log out and back in for group changes to take effect.');
+            return true;
+        }
+        catch (error) {
+            this.log(`Docker installation failed: ${error instanceof Error ? error.message : 'Unknown error'}`);
+            return false;
+        }
+    }
+    /**
+     * Set up LND container
+     */
+    async setupLND() {
+        const result = { success: false, logs: [] };
+        try {
+            // 1. Create data directory
+            this.log(`Creating data directory: ${this.config.dataDir}`);
+            fs.mkdirSync(this.config.dataDir, { recursive: true });
+            // 2. Generate docker-compose.yml
+            const composePath = path.join(this.config.dataDir, 'docker-compose.yml');
+            const composeContent = generateDockerCompose(this.config);
+            fs.writeFileSync(composePath, composeContent);
+            this.log('Generated docker-compose.yml');
+            // 3. Start the container
+            this.log('Starting LND container (this may take a minute)...');
+            await execAsync(`docker compose -f ${composePath} up -d`);
+            // 4. Wait for LND to initialize
+            this.log('Waiting for LND to initialize...');
+            await this.waitForLND();
+            // 5. Check if wallet exists
+            const walletExists = await this.checkWalletExists();
+            if (!walletExists) {
+                // 6. Create new wallet
+                this.log('Creating new Lightning wallet...');
+                const walletResult = await this.createWallet();
+                if (!walletResult.success) {
+                    result.error = walletResult.error;
+                    result.logs = this.logs;
+                    return result;
+                }
+                result.walletSeed = walletResult.seed;
+            }
+            else {
+                this.log('Existing wallet found.');
+            }
+            // 7. Wait for sync
+            this.log('Waiting for Neutrino sync (this can take 5-15 minutes on first run)...');
+            await this.waitForSync();
+            // 8. Extract credentials
+            this.log('Extracting credentials...');
+            const credentials = await this.extractCredentials();
+            if (!credentials) {
+                result.error = 'Failed to extract LND credentials';
+                result.logs = this.logs;
+                return result;
+            }
+            result.success = true;
+            result.credentials = credentials;
+            result.logs = this.logs;
+            this.log('LND setup complete!');
+            return result;
+        }
+        catch (error) {
+            result.error = error instanceof Error ? error.message : 'Unknown error';
+            result.logs = this.logs;
+            return result;
+        }
+    }
+    /**
+     * Wait for LND REST API to be available
+     */
+    async waitForLND(maxAttempts = 30) {
+        for (let i = 0; i < maxAttempts; i++) {
+            try {
+                await execAsync(`docker exec ${this.config.containerName} lncli --network=${this.config.network} getinfo 2>&1`);
+                return true;
+            }
+            catch (error) {
+                const errorMsg = error instanceof Error ? error.message : '';
+                // Wallet not created yet is OK - LND is up
+                if (errorMsg.includes('wallet not created') || errorMsg.includes('wallet locked')) {
+                    return true;
+                }
+                await new Promise(resolve => setTimeout(resolve, 2000));
+            }
+        }
+        return false;
+    }
+    /**
+     * Check if wallet already exists
+     */
+    async checkWalletExists() {
+        try {
+            const { stderr } = await execAsync(`docker exec ${this.config.containerName} lncli --network=${this.config.network} getinfo 2>&1`);
+            // If we get wallet locked, it exists
+            return !stderr.includes('wallet not created');
+        }
+        catch (error) {
+            const errorMsg = error instanceof Error ? error.message : '';
+            return errorMsg.includes('wallet locked') || !errorMsg.includes('wallet not created');
+        }
+    }
+    /**
+     * Create new LND wallet
+     */
+    async createWallet() {
+        return new Promise((resolve) => {
+            // Generate a random password
+            const password = this.generatePassword();
+            // Save password for auto-unlock
+            const passwordPath = path.join(this.config.dataDir, 'wallet_password');
+            fs.writeFileSync(passwordPath, password);
+            this.log('Creating wallet with secure password...');
+            // Use expect-style interaction
+            const lncli = spawn('docker', [
+                'exec', '-i', this.config.containerName,
+                'lncli', `--network=${this.config.network}`, 'create'
+            ]);
+            let output = '';
+            let seed = [];
+            let step = 0;
+            lncli.stdout.on('data', (data) => {
+                const text = data.toString();
+                output += text;
+                // Step through the prompts
+                if (text.includes('wallet password')) {
+                    if (step === 0) {
+                        lncli.stdin.write(password + '\n');
+                        step = 1;
+                    }
+                    else if (step === 1) {
+                        lncli.stdin.write(password + '\n');
+                        step = 2;
+                    }
+                }
+                if (text.includes('cipher seed mnemonic')) {
+                    lncli.stdin.write('n\n'); // Don't use existing seed
+                    step = 3;
+                }
+                if (text.includes('passphrase')) {
+                    lncli.stdin.write('\n'); // No passphrase
+                    step = 4;
+                }
+                // Extract seed words
+                const seedMatch = text.match(/\d+\.\s+(\w+)/g);
+                if (seedMatch) {
+                    seed = seedMatch.map(s => s.replace(/\d+\.\s+/, ''));
+                }
+            });
+            lncli.stderr.on('data', (data) => {
+                output += data.toString();
+            });
+            lncli.on('close', (code) => {
+                if (code === 0 && seed.length === 24) {
+                    // Save seed (in production, user should back this up and delete)
+                    const seedPath = path.join(this.config.dataDir, 'BACKUP_SEED_DELETE_AFTER_BACKUP.txt');
+                    fs.writeFileSync(seedPath, `IMPORTANT: Back up these 24 words and DELETE this file!\n\n${seed.join(' ')}`);
+                    resolve({ success: true, seed });
+                }
+                else {
+                    resolve({ success: false, error: `Wallet creation failed: ${output}` });
+                }
+            });
+            lncli.on('error', (err) => {
+                resolve({ success: false, error: err.message });
+            });
+        });
+    }
+    /**
+     * Wait for Neutrino to sync
+     */
+    async waitForSync(maxMinutes = 30) {
+        const maxAttempts = maxMinutes * 6; // Check every 10 seconds
+        for (let i = 0; i < maxAttempts; i++) {
+            try {
+                const { stdout } = await execAsync(`docker exec ${this.config.containerName} lncli --network=${this.config.network} getinfo`);
+                const info = JSON.parse(stdout);
+                if (info.synced_to_chain) {
+                    this.log('Neutrino sync complete!');
+                    return true;
+                }
+                const progress = info.block_height ? `Block ${info.block_height}` : 'Syncing...';
+                if (i % 6 === 0) { // Log every minute
+                    this.log(`Sync progress: ${progress}`);
+                }
+            }
+            catch {
+                // Still starting up
+            }
+            await new Promise(resolve => setTimeout(resolve, 10000));
+        }
+        this.log('Warning: Sync timed out. Node may still be syncing in background.');
+        return false;
+    }
+    /**
+     * Extract LND credentials for SDK use
+     */
+    async extractCredentials() {
+        try {
+            // Copy cert and macaroon from container
+            const certPath = path.join(this.config.dataDir, 'tls.cert');
+            const macaroonPath = path.join(this.config.dataDir, 'admin.macaroon');
+            await execAsync(`docker cp ${this.config.containerName}:/root/.lnd/tls.cert ${certPath}`);
+            await execAsync(`docker cp ${this.config.containerName}:/root/.lnd/data/chain/bitcoin/${this.config.network}/admin.macaroon ${macaroonPath}`);
+            // Read and encode
+            const tlsCert = fs.readFileSync(certPath).toString('base64');
+            const adminMacaroon = fs.readFileSync(macaroonPath).toString('hex');
+            return {
+                tlsCert,
+                adminMacaroon,
+                restHost: `localhost:${this.config.restPort}`,
+                grpcHost: `localhost:${this.config.grpcPort}`
+            };
+        }
+        catch (error) {
+            this.log(`Failed to extract credentials: ${error instanceof Error ? error.message : 'Unknown error'}`);
+            return null;
+        }
+    }
+    /**
+     * Generate a secure random password
+     */
+    generatePassword() {
+        const chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*';
+        let password = '';
+        for (let i = 0; i < 24; i++) {
+            password += chars[Math.floor(Math.random() * chars.length)];
+        }
+        return password;
+    }
+    /**
+     * Get container status
+     */
+    async getStatus() {
+        try {
+            // Check if container is running
+            const { stdout: psOutput } = await execAsync(`docker ps --filter "name=${this.config.containerName}" --format "{{.Status}}"`);
+            if (!psOutput.trim()) {
+                return { running: false, synced: false };
+            }
+            // Get node info
+            const { stdout } = await execAsync(`docker exec ${this.config.containerName} lncli --network=${this.config.network} getinfo`);
+            const info = JSON.parse(stdout);
+            // Get balance
+            const { stdout: balanceOut } = await execAsync(`docker exec ${this.config.containerName} lncli --network=${this.config.network} walletbalance`);
+            const balance = JSON.parse(balanceOut);
+            return {
+                running: true,
+                synced: info.synced_to_chain,
+                blockHeight: info.block_height,
+                peers: info.num_peers,
+                channels: info.num_active_channels,
+                balance: {
+                    confirmed: parseInt(balance.confirmed_balance) || 0,
+                    unconfirmed: parseInt(balance.unconfirmed_balance) || 0
+                }
+            };
+        }
+        catch {
+            return { running: false, synced: false };
+        }
+    }
+    /**
+     * Stop LND container
+     */
+    async stop() {
+        try {
+            const composePath = path.join(this.config.dataDir, 'docker-compose.yml');
+            await execAsync(`docker compose -f ${composePath} down`);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Start LND container (if stopped)
+     */
+    async start() {
+        try {
+            const composePath = path.join(this.config.dataDir, 'docker-compose.yml');
+            await execAsync(`docker compose -f ${composePath} up -d`);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    getLogs() {
+        return [...this.logs];
+    }
+}
+// ============================================================
+// CONVENIENCE FUNCTIONS
+// ============================================================
+/**
+ * Quick setup for agents who want their own node
+ */
+export async function quickSetupLND(alias) {
+    const setup = new LNDSetup({
+        alias: alias || `SovereignAgent_${Date.now().toString(36)}`
+    });
+    // Check prerequisites
+    const prereqs = await setup.checkPrerequisites();
+    if (!prereqs.docker.installed) {
+        console.log('\nDocker is required for self-hosted Lightning.');
+        console.log('Would you like to install it? (This requires sudo on Linux)');
+        // In real implementation, this would be interactive
+        return {
+            success: false,
+            error: 'Docker not installed. Please install Docker first: https://docs.docker.com/get-docker/',
+            logs: setup.getLogs()
+        };
+    }
+    if (!prereqs.docker.running) {
+        return {
+            success: false,
+            error: 'Docker is installed but not running. Please start Docker.',
+            logs: setup.getLogs()
+        };
+    }
+    // Run setup
+    return setup.setupLND();
+}
+export default LNDSetup;

package/dist/wallet/types.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Wallet Types for mcpSovereign
+ *
+ * Lightning-first wallet setup and management
+ */
+export type WalletProvider = 'alby' | 'phoenix' | 'walletofsatoshi' | 'muun' | 'bluewallet' | 'breez' | 'zeus' | 'custom';
+export interface WalletProviderInfo {
+    id: WalletProvider;
+    name: string;
+    emoji: string;
+    description: string;
+    type: 'custodial' | 'non-custodial' | 'self-hosted';
+    platforms: ('web' | 'ios' | 'android' | 'desktop')[];
+    supportsLNURL: boolean;
+    supportsLightningAddress: boolean;
+    setupUrl: string;
+    difficulty: 'easy' | 'medium' | 'advanced';
+    recommended?: boolean;
+}
+export declare const WALLET_PROVIDERS: Record<WalletProvider, WalletProviderInfo>;
+export interface WalletConfig {
+    provider: WalletProvider;
+    lightningAddress?: string;
+    lnurlPay?: string;
+    nodeUri?: string;
+    setupComplete: boolean;
+    verified: boolean;
+    verifiedAt?: string;
+    createdAt: string;
+    lastUsed?: string;
+}
+export interface LightningAddressInfo {
+    address: string;
+    username: string;
+    domain: string;
+    valid: boolean;
+    lnurlPayUrl?: string;
+    metadata?: {
+        description?: string;
+        minSendable?: number;
+        maxSendable?: number;
+        nostrPubkey?: string;
+    };
+}
+export interface WalletSetupProgress {
+    currentStep: number;
+    completed: boolean;
+    provider?: WalletProvider;
+    lightningAddress?: string;
+    verified: boolean;
+    skipped: boolean;
+}
+export interface WalletSetupStep {
+    id: string;
+    title: string;
+    description: string;
+    emoji: string;
+    action: string;
+}
+export declare const WALLET_SETUP_STEPS: WalletSetupStep[];
+export interface PaymentRequest {
+    paymentHash: string;
+    paymentRequest: string;
+    amountSats: number;
+    description: string;
+    expiresAt: string;
+    status: 'pending' | 'paid' | 'expired' | 'failed';
+}
+export interface PaymentResult {
+    success: boolean;
+    paymentHash?: string;
+    preimage?: string;
+    feeSats?: number;
+    error?: string;
+}
+export interface WithdrawalRequest {
+    amountCredits: number;
+    amountSats: number;
+    lightningAddress: string;
+    status: 'pending' | 'processing' | 'complete' | 'failed';
+}
+export interface WithdrawalResult {
+    success: boolean;
+    withdrawalId?: string;
+    amountSats?: number;
+    feeSats?: number;
+    paymentHash?: string;
+    error?: string;
+}