PCOINPayServer.Lightning.Common
1.3.22
dotnet add package PCOINPayServer.Lightning.Common --version 1.3.22
NuGet\Install-Package PCOINPayServer.Lightning.Common -Version 1.3.22
<PackageReference Include="PCOINPayServer.Lightning.Common" Version="1.3.22" />
paket add PCOINPayServer.Lightning.Common --version 1.3.22
#r "nuget: PCOINPayServer.Lightning.Common, 1.3.22"
// Install PCOINPayServer.Lightning.Common as a Cake Addin #addin nuget:?package=PCOINPayServer.Lightning.Common&version=1.3.22 // Install PCOINPayServer.Lightning.Common as a Cake Tool #tool nuget:?package=PCOINPayServer.Lightning.Common&version=1.3.22
A C# library for Lightning Network clients
Introduction
This library is meant to facilitate the development of Lightning Network based apps written in C#. Its main goal isn't to perfectly implement client API of all lightning node implementation, but to provide a common abstraction that can be used to support many implementations at once.
The most important packages are:
PCOINPayServer.Lightning.Common
contains the common abstractions shared between those implementation.PCOINPayServer.Lightning.All
containsLightningClientFactory
which can convert a connection string to an instance ofILightningClient
.
If your app depends on ILightningClient
directly, you will be able to support those different lightning implementations out of the box.
Here is a description of all packages:
PCOINPayServer.Lightning.All
super package which reference all the othersPCOINPayServer.Lightning.Common
exposes common classes andILightningClient
PCOINPayServer.Lightning.LND
exposes easy to use LND clientsPCOINPayServer.Lightning.CLightning
exposes easy to use clightning clientsPCOINPayServer.Lightning.Charge
exposes easy to use Charge clientsPCOINPayServer.Lightning.Eclair
exposes easy to use Eclair clientsPCOINPayServer.Lightning.LNbank
exposes easy to use LNbank clientsPCOINPayServer.Lightning.LNDhub
exposes easy to use LNDhub clients
If you develop an app, we advise you to reference PCOINPayServer.Lightning.All
.
If you develop a library, we advise you to reference PCOINPayServer.Lightning.Common
.
You can also use our BOLT11PaymentRequest
to parse BOLT11 invoices. (See example).
How to use
Click on the nuget button of the package interesting you, and follow the instruction to add it to your project. For .NET Core Apps, you need to enter this in your project's folder:
dotnet add package PCOINPayServer.Lightning.All
You have two ways to use this library:
- Either you want your code to works with all lightning implementation (right now LND, Charge, CLightning)
- Or you want your code to work on a particular lightning implementation
Using the generic interface
This is done by using LightningClientFactory
and the common interface ILightningClient
.
string connectionString = "...";
ILightningClientFactory factory = new LightningClientFactory(Network.Main);
ILightningClient client = factory.Create(connectionString);
LightningInvoice invoice = await client.CreateInvoice(10000, "CanCreateInvoice", TimeSpan.FromMinutes(5));
ILightningClient
is an interface which abstract the underlying implementation with a common interface.
The connectionString
encapsulates the necessary information PCOINPay needs to connect to your Lightning node, we currently support:
clightning
via TCP or unix domain socket connectionlightning charge
via HTTPSLND
via the REST proxyEclair
via their new REST APILNbank
via REST APILNDhub
via their REST API
Examples
type=clightning;server=unix://root/.lightning/lightning-rpc
type=clightning;server=tcp://1.1.1.1:27743/
type=lnd-rest;server=http://mylnd:8080/;macaroonfilepath=/root/.lnd/admin.macaroon;allowinsecure=true
type=lnd-rest;server=https://mylnd:8080/;macaroon=abef263adfe...
type=lnd-rest;server=https://mylnd:8080/;macaroon=abef263adfe...;certthumbprint=abef263adfe...
type=lnd-rest;server=https://mylnd:8080/;macaroonfilepath=/root/.lnd/admin.macaroon;certfilepath=/var/lib/lnd/tls.cert
type=charge;server=https://charge:8080/;api-token=myapitoken...
type=charge;server=https://charge:8080/;cookiefilepath=/path/to/cookie...
type=eclair;server=http://127.0.0.1:4570;password=eclairpass
type=eclair;server=http://127.0.0.1:4570;password=eclairpass;bitcoin-host=bitcoin.host;bitcoin-auth=btcpass
type=lnbank;server=http://lnbank:5000;api-token=myapitoken;allowinsecure=true
type=lnbank;server=https://mypcoinpay.com/lnbank;api-token=myapitoken
type=lndhub;server=https://login:password@lndhub.io
Eclair notes
Note that bitcoin-host
and bitcoin-auth
are optional, only useful if you want to call ILightningClient.GetDepositAddress
on Eclair.
We expect this won't be needed in the future.
LND notes
Unless the LND certificate is trusted by your machine you need to set the server authentication scheme for LND by specifying one of: certthumbprint
, certfilepath
, allowinsecure=true
.
certfilepath
and certthumbprint
are equivalent in terms of security but differ in their practical usage.
certfilepath
reads a file on your file system so unless you set up some kind of file syncing you can not use it for remote connections.
The advantage is that if the certificate is updated (and synced in case of a remote machine) no more reconfiguration is required for RPC connections to continue to work.
It is therefore the recommended option if you can use it.
The certthumbprint
to connect to your LND node can be obtained through this command line:
openssl x509 -noout -fingerprint -sha256 -in /root/.lnd/tls.cert | sed -e 's/.*=//;s/://g'
allowinsecure=true
just blindly accepts any server connection and is therefore not secure unless used in tightly controlled environments.
E.g. host is the same machine or is accessed over an encrypted tunnel, assuming no untrusted entities can bind the specified port.
LNDhub notes
You can also use the lndhub://
URL, which can be retrieved e.g. from the BlueWallet Export/Backup screen.
The library turns it into the expected type=lndhub
connection string format.
Using implementation specific class
If you want to leverage specific lightning network implementation, either instanciate directly ChargeClient
, LndClient
or CLightningClient
, or cast the ILightningClient
object returned by LightningClientFactory
.
How to test
You first need to run all the dependencies with docker-compose:
cd tests
docker-compose up
Then you can run and debug the tests with Visual Studio or Visual Studio Code.
If you want to use command line:
cd tests
dotnet test
Licence
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- NBitcoin (>= 7.0.24)
- Newtonsoft.Json (>= 13.0.1)
-
net6.0
- NBitcoin (>= 7.0.24)
- Newtonsoft.Json (>= 13.0.1)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on PCOINPayServer.Lightning.Common:
Package | Downloads |
---|---|
PCOINPayServer.Lightning.CLightning
Client library for c-lightning to build Lightning Network Apps in C#. |
|
PCOINPayServer.Lightning.Eclair
Client library for Eclair to build Lightning Network Apps in C#. |
|
PCOINPayServer.Lightning.LNBank
Client library for LNBank to build Lightning Network Apps in C#. |
|
PCOINPayServer.Lightning.LNDhub
Client library for BlueWallet LNDhub to build Lightning Network Apps in C#. |
|
PCOINPayServer.Lightning.LND
Client library for LND to build Lightning Network Apps in C#. |
GitHub repositories
This package is not used by any popular GitHub repositories.