khan202122 / LightningPay

Bitcoin Lightning Network Payment library

LightningPay

Bitcoin Lightning Network Payment .NET library

Features

• Get balance (Documentation)
• Create an invoice (Documentation)
• Check payment (Documentation)
• Pay an invoice (Documentation)

Packages

• LightningPay.Abstractions : Interfaces and model used by LightningPay
• LightningPay : Core library with all Lightning clients
• LightningPay.DependencyInjection : Extension methods for .NET DI

See Which package to use ? for more details.

Integration

Connect to your lightning nodes :

• LND (Documentation)
• C-Lightning (Documentation)
• Eclair (Documentation)
• Charge (Not supported yet)

Or with custodial solution for lightning (without having a node of your own) :

• LNDHub / BlueWallet (Documentation)
• LNBits (Documentation)

Extend

With LightningPay, you can easly extend your client by add extension methods to the ILightningClient interface.

See the full documentation here.

Samples

Need for code samples ? Go here : Lightning samples

Documentation

Lightning Documentation

Local test

You can use our docker-compose file to test the LightningPay clients.

Continuous Integration

LightningPay build reports

Contributing

We appreciate new contributions.

• Non developer : You found a bug or have an suggestion for a new feature ? Don't hesitate to create an issue
• Developer : develop branch is the principal branch for development. This branch is protected. You must create a pull request and target this branch for code validation.

Credits..

Many thanks to the BTCPayServer.Lightning project that inspiring us.