Add Wallet Module documentation and WebSocket integration
- Introduced comprehensive documentation for the new Wallet Module, detailing its purpose, features, and key components. - Added WebSocket integration documentation, outlining real-time balance updates, connection management, and error handling. - Updated README and module index files to include references to the Wallet Module, enhancing overall module visibility and accessibility. These changes improve the clarity and usability of the Wallet Module, providing developers with essential information for implementation and integration.
This commit is contained in:
parent
832bf4d4ca
commit
71cec00bfc
6 changed files with 1748 additions and 1 deletions
|
|
@ -74,6 +74,34 @@ interface ModulePlugin {
|
|||
|
||||
**See:** [[base-module/index|📖 Base Module Documentation]]
|
||||
|
||||
### **Wallet Module** 💰
|
||||
**Purpose:** Lightning Network wallet management with real-time updates
|
||||
**Location:** `src/modules/wallet/`
|
||||
**Dependencies:** `['base']`
|
||||
|
||||
**Features:**
|
||||
- **Real-time Balance Updates** - WebSocket connection to LNbits for instant balance sync
|
||||
- **Payment Processing** - Send to Lightning invoices, addresses, and LNURL endpoints
|
||||
- **Transaction Management** - Comprehensive history with real-time transaction updates
|
||||
- **Payment Links** - Create LNURL payment links and Lightning addresses for receiving
|
||||
- **Multi-wallet Support** - Manage multiple wallets with automatic selection
|
||||
- **Battery Optimization** - Pauses WebSocket when app not visible to save battery
|
||||
|
||||
**Key Components:**
|
||||
- SendDialog for payment sending interface
|
||||
- ReceiveDialog for payment link creation
|
||||
- TransactionList with real-time updates
|
||||
- BalanceDisplay with WebSocket synchronization
|
||||
- PayLinkManager for LNURL link management
|
||||
|
||||
**WebSocket Integration:**
|
||||
- Real-time balance updates via LNbits WebSocket API
|
||||
- Smart unit conversion handling (sats/millisats)
|
||||
- Automatic reconnection with exponential backoff
|
||||
- VisibilityService integration for mobile battery optimization
|
||||
|
||||
**See:** [[wallet-module/index|📖 Wallet Module Documentation]]
|
||||
|
||||
### **Nostr Feed Module** 📰
|
||||
**Purpose:** Social feed and content discovery
|
||||
**Location:** `src/modules/nostr-feed/`
|
||||
|
|
@ -369,7 +397,8 @@ async dispose(): Promise<void> {
|
|||
|
||||
### Module Documentation
|
||||
- **[[base-module/index|🏗️ Base Module]]** - Core infrastructure services
|
||||
- **[[chat-module/index|💬 Chat Module]]** - Encrypted messaging system
|
||||
- **[[wallet-module/index|💰 Wallet Module]]** - Lightning wallet with real-time updates
|
||||
- **[[chat-module/index|💬 Chat Module]]** - Encrypted messaging system
|
||||
- **[[events-module/index|🎟️ Events Module]]** - Lightning event ticketing
|
||||
- **[[market-module/index|🛒 Market Module]]** - Nostr marketplace
|
||||
- **[[nostr-feed-module/index|📰 Nostr Feed]]** - Social feed functionality
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue