php-lightning/lnaddress

0.8.0 2025-05-25 12:12 UTC

Requires

• php: >=8.2
• gacela-project/gacela: ^1.9
• gacela-project/router: ^0.12
• symfony/http-client: ^7.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.75
• gacela-project/phpstan-extension: ^0.3
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^9.6
• psalm/plugin-phpunit: ^0.19
• rector/rector: ^1.2
• symfony/var-dumper: ^7.2
• vimeo/psalm: ^6.11

MIT

README

PHP Lightning Address is an easy way to get a lightning address in PHP.

Usage / Development

Set up your custom config:

cp lightning-config.dist.php lightning-config.php
# or just simply the nostr.json to define the backends/user-settings
cp nostr.dist.json nostr.json

You can customize the invoice description and the success message by editing lightning-config.php:

use PhpLightning\Config\LightningConfig;

return (new LightningConfig())
    ->setDescriptionTemplate('Pay to %s on mynode')
    ->setSuccessMessage('Thanks for the payment!');

Run a local PHP server listening public/index.php

composer serve

Demo template

We prepared a demo template, so you can use this project as a dependency. The benefits from this approach is that you can update your project with composer update whenever there are new features or improvements on this lnaddress repository.

https://github.com/php-lightning/demo-lnaddress

Wiki

Check the wiki for more details: https://github.com/php-lightning/lnaddress/wiki

Contributions

Feel free to open issues & PR if you want to contribute to this project.