Skip to content

replit.md

Latest commit

 

History

History
41 lines (37 loc) · 2.22 KB

replit.md

File metadata and controls

41 lines (37 loc) · 2.22 KB

Lexe Wrapper

Overview

A simple Python utility for integrating with the Lexe Bitcoin Lightning Network wallet. This wrapper simplifies the setup and management of the Lexe Sidecar SDK by handling the common gotchas like binary download, process management, credentials handling, and health checking.

Recent Changes

  • V2.2.2 Released (September 12, 2025) - Documentation fixes:
    • Fixed confusing WRONG/CORRECT example that showed identical code
    • Clarified that index field is an alphanumeric string, not integer
  • V2.2.1 Released (September 12, 2025) - Documentation clarification:
    • Clarified that requests is automatically installed as a dependency
    • Added note for developers copying code without installing the package
  • V2.2.0 Released (September 12, 2025) - Documentation improvements:
    • Added health check as critical first step after starting sidecar
    • Simplified QR code generation to JavaScript-only examples
    • Removed confusing server-side Python QR generation options
    • Clarified that QR codes contain invoice text string only
  • V2.1.0 Released (September 12, 2025) - Added QR code examples
  • V2.0.1 Released (September 12, 2025) - Critical fixes:
    • Fixed remaining V1 API references in examples
    • Added version enforcement for sidecar binary updates
    • Ensures old v0.2.0 binaries are updated to v0.3.0
  • V2.0.0 Released (September 12, 2025) - Major breaking changes:
    • Updated to support Lexe Sidecar V2 API
    • All API endpoints changed from /v1/ to /v2/
    • Payment response structure simplified (no nested "payment" object)
    • Updated to download latest sidecar binary v0.3.0
  • Initial implementation completed (September 4, 2025)

User Preferences

  • Focus on simplicity and clean interfaces
  • Use the Lexe Sidecar API directly without additional abstraction layers
  • Provide clear documentation for developers and coding agents

Project Architecture

  • lexe_manager.py: Main LexeManager class for sidecar management
  • cli.py: Command-line interface for testing and demonstration
  • Uses Python standard library and minimal dependencies (only requests)
  • Downloads latest Lexe sidecar binary automatically
  • Handles base64 credential encoding and validation
  • Manages sidecar subprocess lifecycle