lightning-address

What problem does it solve?

Developers integrating Lightning addresses often struggle to resolve an address to a live LNURL-pay endpoint and generate valid BOLT11 invoices. This Skill provides a complete pattern for validating addresses, resolving endpoints, enforcing min/max amounts, attaching optional comments, and retrieving invoices via the callback URL.

Core Features & Use Cases

• Address validation: Ensure Lightning addresses follow the username@domain format before any network calls.
• LNURL-pay resolution: Resolve to a pay metadata endpoint and read min/max bounds and callback URL.
• Invoice generation: Request a BOLT11 invoice from the provider with the desired amount and optional comment.
• UI integration: Support displaying the address in a wallet UI and generating QR codes for easy payments.
• Use Case: Build a payment flow in a wallet app that reads an address, asks for an amount within provider limits, optionally includes a note, and presents a ready-to-pay invoice.

Quick Start

• Validate the Lightning address with isValidLightningAddress(address).
• Resolve the address to LNURL-pay metadata via resolveLightningAddress(address).
• Ensure amount is within min/max bounds and optionally include a comment.
• Call getInvoiceFromLightningAddress with the address, amountSats, and optional comment to obtain a BOLT11 invoice.