Connects to the Lightning Network Daemon's gRPC API known as LND
This library is being built in the wild according to these principles
- Free to use
- Developer friendly
- Modular
Arguably, the most important part is that it is unbiased.
If you want to keep it that way, and want to promote its active development, please send donations
here: bc1qwpj2nyunrvjkj7z0unk4gg3ht26h2ysh9dqtez
Thank you!
with a fresh clone of this project, run
mix deps.getcopy those files from the umbrel to the computer running the app
/home/umbrel/umbrel/lnd/tls.certmust be copied to~/.lnd/umbrel.cert- add
/home/umbrel/umbrel/lnd/data/chain/bitcoin/mainnet/readonly.macaroonto the~/.lnd - look below for the NODE environment variable that must be set when you run
iex -S mix
The package can be installed by adding lnd_client
to your list of dependencies in mix.exs:
def deps do
[
{:lnd_client, "~> 0.1.7"}
]
endThis may be used with another Elixir application or on its own using IEx.
{:lnd_client, "~> 0.1"}Whenever you start a LndClient GenServer, you need to specify the credential config.
conn_config = %LndClient.ConnConfig{
node_uri: System.get_env("BOB_NODE"),
cert_path: System.get_env("BOB_CERT"),
macaroon_path: System.get_env("BOB_MACAROON")
}LndClient.start_link(%LndClient.Config{conn_config: conn_config})
LndClient.get_info
LndClient.stopYou can start multiple GenServers by passing in the name:
LndClient.start_link(%LndClient.Config{conn_config: conn_config, name: BobLndClient})
LndClient.get_info(BobLndClient)Add this to the list of children:
children = [
# ...
] ++ LndClient.child_specs(%LndClient.Config{conn_config: conn_config})If you're going to make more than one connection to an LND, pass in the name.
children = [
# ...
] ++ LndClient.child_specs(%LndClient.Config{conn_config: alice_conn_config, name: AliceLndClient}) ++ LndClient.child_specs(%LndClient.Config{conn_config: bob_conn_config, name: BobLndClient})Then, somewhere else in your app:
LndClient.add_invoice(%Lnrpc.Invoice{value_msat: 150_000}, BobLndClient)In the root of the folder, ensure that the following env vars in the example below exist:
NODE=localhost:100009
CERT=~/path/to/tls.cert
MACAROON=~/path/to/macaroonThen iex -S mix
See if the connection was made:
LndClient.get_infoYou didn't need to call start_link because .iex.exs calls that for you.
Run mix test
Make sure protoc is properly installed. Here is how to do it on Debian.
sudo apt install -y protobuf-compiler
mix escript.install hex protobuf
asdf reshimcd proto
curl -O https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/lightning.proto
curl -O https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/routerrpc/router.proto
curl -O https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/invoicesrpc/invoices.proto
protoc --elixir_out=plugins=grpc:../lib/gRPC lightning.proto
protoc --elixir_out=plugins=grpc:../lib/gRPC router.proto
protoc --elixir_out=plugins=grpc:../lib/gRPC invoices.proto
cd ..%Routerrpc.HtlcEvent{
event: {:forward_event,
%Routerrpc.ForwardEvent{
info: %Routerrpc.HtlcInfo{
incoming_amt_msat: 11005,
incoming_timelock: 680165,
outgoing_amt_msat: 11000,
outgoing_timelock: 680125
}
}},
event_type: :FORWARD,
incoming_channel_id: 744146171265875972,
incoming_htlc_id: 87,
outgoing_channel_id: 742921315233366017,
outgoing_htlc_id: 379,
timestamp_ns: 1619026298906259040
}%Routerrpc.HtlcEvent{
event: {:forward_fail_event, %Routerrpc.ForwardFailEvent{}},
event_type: :FORWARD,
incoming_channel_id: 744146171265875972,
incoming_htlc_id: 88,
outgoing_channel_id: 742921315233366017,
outgoing_htlc_id: 380,
timestamp_ns: 1619028533664696456
}%Routerrpc.HtlcEvent{
event: {:settle_event, %Routerrpc.SettleEvent{}},
event_type: :RECEIVE,
incoming_channel_id: 744146171265875972,
incoming_htlc_id: 90,
outgoing_channel_id: 0,
outgoing_htlc_id: 0,
timestamp_ns: 1619028715648844495
}%Routerrpc.HtlcEvent{
event: {:link_fail_event,
%Routerrpc.LinkFailEvent{
failure_detail: :INVALID_KEYSEND,
failure_string: "invalid keysend parameters",
info: %Routerrpc.HtlcInfo{
incoming_amt_msat: 10000,
incoming_timelock: 680090,
outgoing_amt_msat: 0,
outgoing_timelock: 0
},
wire_failure: :INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS
}},
event_type: :RECEIVE,
incoming_channel_id: 744146171265875972,
incoming_htlc_id: 89,
outgoing_channel_id: 0,
outgoing_htlc_id: 0,
timestamp_ns: 1619028709202674659
}