Enhance DCA system documentation: add detailed progress updates on completed features, current state, next steps, and technical implementation details. Include sections on SSH-based database polling, transaction processing, smart poll tracking, client management, admin interface, and database schema.
This commit is contained in:
parent
2bc9a00c47
commit
63638c089f
1 changed files with 114 additions and 1 deletions
115
CLAUDE.md
115
CLAUDE.md
|
|
@ -104,4 +104,117 @@ The global `this.g` object provides access to:
|
|||
- The `tmp/` directory contains a more developed version with DCA (Dollar Cost Averaging) functionality
|
||||
- Extensions must follow snake_case naming conventions for Python files
|
||||
- Use Quasar components (QBtn, QInput, QSelect, etc.) for UI consistency
|
||||
- Always implement proper loading states and error handling with `LNbits.utils.notifyApiError(error)`
|
||||
- Always implement proper loading states and error handling with `LNbits.utils.notifyApiError(error)`
|
||||
|
||||
## DCA System Development Progress
|
||||
|
||||
### ✅ Completed Features
|
||||
|
||||
#### **1. SSH-Based Database Polling System**
|
||||
- Implemented secure SSH connection to remote Lamassu PostgreSQL database
|
||||
- Uses subprocess-based SSH tunneling (no external Python dependencies required)
|
||||
- Connects as `postgres` user with SSH key authentication
|
||||
- Supports both password and private key SSH authentication
|
||||
- Proper SSH tunnel cleanup and error handling
|
||||
|
||||
#### **2. Transaction Processing Pipeline**
|
||||
- Fetches new cash-out transactions from Lamassu `cash_out_txs` table
|
||||
- Correctly handles commission calculation with discount support
|
||||
- Formula: `base_crypto_atoms = crypto_atoms / (1 + effective_commission)`
|
||||
- Effective commission: `commission_percentage * (100 - discount) / 100`
|
||||
- Timezone-aware processing using UTC timestamps
|
||||
|
||||
#### **3. Smart Poll Tracking**
|
||||
- Tracks `last_poll_time` and `last_successful_poll` in database
|
||||
- Prevents missed transactions during server downtime
|
||||
- First run checks last 24 hours, subsequent runs check since last successful poll
|
||||
- Proper error handling that doesn't update success time on failures
|
||||
|
||||
#### **4. DCA Client Management**
|
||||
- Full CRUD operations for DCA clients
|
||||
- Added username support for better UX (shows "johndoe" instead of "a1b2c3d4...")
|
||||
- Client balance tracking and proportional distribution calculation
|
||||
- Support for both Flow Mode and Fixed Mode DCA strategies
|
||||
|
||||
#### **5. Admin Interface**
|
||||
- Connection testing with detailed step-by-step reporting
|
||||
- Manual poll triggers for immediate transaction processing
|
||||
- Real-time poll status display with timestamps
|
||||
- Username-based client selection in forms and tables
|
||||
- Export functionality for clients and deposits data
|
||||
|
||||
#### **6. Database Schema**
|
||||
- Complete migration system (m001-m009)
|
||||
- DCA clients table with username field
|
||||
- DCA deposits and payments tracking
|
||||
- Lamassu configuration with SSH settings
|
||||
- Poll tracking timestamps
|
||||
|
||||
### 🚧 Current State
|
||||
|
||||
#### **What Works:**
|
||||
- ✅ SSH connection to Lamassu database
|
||||
- ✅ Transaction detection and fetching
|
||||
- ✅ Commission calculation (with discounts)
|
||||
- ✅ Proportional distribution calculation
|
||||
- ✅ Payment record creation in database
|
||||
- ✅ Admin interface for monitoring and management
|
||||
|
||||
#### **Database Fields Used:**
|
||||
- `crypto_atoms` - Total satoshis with commission baked in
|
||||
- `fiat` - Actual fiat dispensed (commission-free amount)
|
||||
- `commission_percentage` - Stored as decimal (e.g., 0.045 for 4.5%)
|
||||
- `discount` - Discount percentage applied to commission
|
||||
|
||||
### 📋 Next Steps / TODO
|
||||
|
||||
#### **1. Actual Bitcoin Payment Implementation**
|
||||
- Currently only records payments in database (line 572-573 in `transaction_processor.py`)
|
||||
- Need to implement actual Bitcoin transfers to client wallets
|
||||
- Integrate with LNBits payment system
|
||||
- Handle client wallet addresses/invoices
|
||||
|
||||
#### **2. Payment Status Tracking**
|
||||
- Track payment states: pending → confirmed → failed
|
||||
- Implement retry logic for failed payments
|
||||
- Payment confirmation and error handling
|
||||
|
||||
#### **3. Client Wallet Integration**
|
||||
- Store client wallet addresses or Lightning invoices
|
||||
- Implement payment delivery mechanisms
|
||||
- Handle different payment methods (on-chain, Lightning, etc.)
|
||||
|
||||
### 🔧 Technical Implementation Details
|
||||
|
||||
#### **SSH Connection Setup:**
|
||||
```bash
|
||||
# On Lamassu server:
|
||||
sudo mkdir -p /var/lib/postgresql/.ssh
|
||||
sudo echo "your-public-key" >> /var/lib/postgresql/.ssh/authorized_keys
|
||||
sudo chown -R postgres:postgres /var/lib/postgresql/.ssh
|
||||
sudo chmod 700 /var/lib/postgresql/.ssh
|
||||
sudo chmod 600 /var/lib/postgresql/.ssh/authorized_keys
|
||||
```
|
||||
|
||||
#### **Configuration:**
|
||||
- Database: `lamassu` on postgres user
|
||||
- SSH: Direct connection as postgres user (no tunneling complexity)
|
||||
- Polling: Hourly automatic + manual trigger available
|
||||
- Security: SSH key authentication, read-only database access
|
||||
|
||||
### 🐛 Known Considerations
|
||||
|
||||
- Commission calculation uses `crypto_atoms / (1 + effective_commission)` not `crypto_atoms * commission`
|
||||
- Database stores commission as decimal (0.045) not percentage (4.5)
|
||||
- Username field is optional for backward compatibility
|
||||
- Timezone handling standardized to UTC throughout system
|
||||
- SSH requires system `ssh` command (standard on Linux servers)
|
||||
|
||||
### 📁 Key Files
|
||||
|
||||
- `transaction_processor.py` - Main polling and processing logic
|
||||
- `models.py` - Data models with commission calculation
|
||||
- `crud.py` - Database operations including poll tracking
|
||||
- `migrations.py` - Schema evolution (m001-m009)
|
||||
- `static/js/index.js` - Admin interface JavaScript
|
||||
- `templates/myextension/index.html` - Admin UI templates
|
||||
Loading…
Add table
Add a link
Reference in a new issue