Skip to content

lnflash/pulse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Pulse v3.0.0

Keep your finger on it.

logo

A conversational AI-powered WhatsApp bot for Flash that enables Lightning Network payments through natural language.

Quick Start

Prerequisites

  • Node.js 20+
  • Redis server
  • Chrome/Chromium browser
  • Flash API access token

Local Development

# Clone and setup
git clone https://github.com/lnflash/pulse.git
cd pulse
./scripts/setup-local.sh

# Configure .env file with your API keys
# Start development server
npm run start:dev

Production Deployment

Deploy to Ubuntu VPS (22.04 or 24.04 LTS):

# Download and run setup script
wget https://raw.githubusercontent.com/lnflash/pulse/main/scripts/setup-ubuntu-vps.sh
chmod +x setup-ubuntu-vps.sh
sudo ./setup-ubuntu-vps.sh

# View logs and QR code
pulse logs

# Management commands
pulse start|stop|restart|status|update|backup

Key Features (v3.0.0)

๐Ÿค– Conversational AI Interface

  • Natural Conversations: Ask questions like "What is Flash?" or "How do I send money?"
  • Smart Onboarding: Contextual help for new users exploring features
  • No More Command Errors: Every message gets a helpful response

๐Ÿ’ธ Payment Features

  • Send and receive Lightning payments via WhatsApp
  • Phone number-based account linking with OTP verification
  • Real-time balance checking with currency conversion
  • Contact management and payment requests
  • Push notifications for received payments
  • Anonymous tips and group tip splitting

๐ŸŽ™๏ธ Voice & AI

  • Voice note support with Speech-to-Text
  • Natural language voice responses with ElevenLabs
  • AI-powered assistance with Google Gemini
  • Voice-only mode for hands-free operation

๐Ÿ”ง Technical Capabilities

  • Multi-instance WhatsApp support
  • Message normalization engine foundation
  • Platform-agnostic messaging architecture
  • Admin controls for system management

How to Use Pulse

Natural Language (NEW in v3.0!)

Just chat naturally! Try:

  • "How are you?"
  • "What is Flash?"
  • "How do I send money to a friend?"
  • "Tell me about Lightning Network"
  • "What can you do?"

Basic Commands

  • link - Connect your Flash account
  • balance - Check wallet balance
  • send [amount] to [username/phone] - Send payment
  • receive [amount] - Create Lightning invoice
  • help - Show all commands

Voice Features

  • Send voice notes for hands-free operation
  • voice on/off/only - Control voice responses
  • voice list - See available voices

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Documentation

Support

  • Create an issue on GitHub
  • WhatsApp support: Send "support" to the bot

License

MIT License - Island Bitcoin LLC

About

Keep your finger on it

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •