LND API Reference
Welcome to the API reference documentation for LND, the Lightning Network
Daemon.
This site features API documentation for command line arguments, gRPC in
Python /
Javascript, and a REST proxy.
It is intended for those who already understand how to work with LND. If this is
your first time or you need a refresher, you may consider perusing our LND
developer site featuring a tutorial, resources and guides at
dev.lightning.community.
If you prefer to just read code, the original rpc.proto file from which
the gRPC documentation was generated can be found in the lnd Github
repo.
Lastly, keep in mind that the code examples will differ slightly based on your
operating system and specific setup. The LND_HOMEDIR used in the gRPC examples
is ~/.lnd/ for Linux or ~/Library/Application Support/Lnd/tls.cert for Mac
GenSeed
Simple RPC
GenSeed is the first method that should be used to instantiate a new lnd instance. This method allows a caller to generate a new aezeed cipher seed given an optional passphrase. If provided, the passphrase will be necessary to decrypt the cipherseed to expose the internal wallet seed. Once the cipherseed is obtained and verified by the user, the InitWallet method should be used to commit the newly generated seed, and create the wallet.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.GenSeedRequest(
aezeed_passphrase=<YOUR_PARAM>,
seed_entropy=<YOUR_PARAM>,
)
>>> response = stub.GenSeed(request)
>>> response
{
cipher_seed_mnemonic: <string>,
enciphered_seed: <bytes>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.genSeed({
aezeed_passphrase: <YOUR_PARAM>,
seed_entropy: <YOUR_PARAM>,
}, function(err, response) {
console.log('GenSeed: ' + response);
})
{
cipher_seed_mnemonic: <string>,
enciphered_seed: <bytes>,
}
gRPC Request: GenSeedRequest
| Field |
Type |
Label |
Description |
| aezeed_passphrase |
bytes |
optional |
aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed. |
| seed_entropy |
bytes |
optional |
seed_entropy is an optional 16-bytes generated via CSPRNG. If not specified, then a fresh set of randomness will be used to create the seed. |
gRPC Response: GenSeedResponse
| Field |
Type |
Label |
Description |
| cipher_seed_mnemonic |
string |
repeated |
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This field is optional, as if not provided, then the daemon will generate a new cipher seed for the user. Otherwise, then the daemon will attempt to recover the wallet state linked to this cipher seed. |
| enciphered_seed |
bytes |
optional |
enciphered_seed are the raw aezeed cipher seed bytes. This is the raw cipher text before run through our mnemonic encoding scheme. |
InitWallet
Simple RPC
InitWallet is used when lnd is starting up for the first time to fully initialize the daemon and its internal wallet. At the very least a wallet password must be provided. This will be used to encrypt sensitive material on disk. In the case of a recovery scenario, the user can also specify their aezeed mnemonic and passphrase. If set, then the daemon will use this prior state to initialize its internal wallet. Alternatively, this can be used along with the GenSeed RPC to obtain a seed, then present it to the user. Once it has been verified by the user, the seed can be fed into this RPC in order to commit the new wallet.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.InitWalletRequest(
wallet_password=<YOUR_PARAM>,
cipher_seed_mnemonic=<YOUR_PARAM>,
aezeed_passphrase=<YOUR_PARAM>,
)
>>> response = stub.InitWallet(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.initWallet({
wallet_password: <YOUR_PARAM>,
cipher_seed_mnemonic: <YOUR_PARAM>,
aezeed_passphrase: <YOUR_PARAM>,
}, function(err, response) {
console.log('InitWallet: ' + response);
})
{}
gRPC Request: InitWalletRequest
| Field |
Type |
Label |
Description |
| wallet_password |
bytes |
optional |
wallet_password is the passphrase that should be used to encrypt the wallet. This MUST be at least 8 chars in length. After creation, this password is required to unlock the daemon. |
| cipher_seed_mnemonic |
string |
repeated |
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed. |
| aezeed_passphrase |
bytes |
optional |
aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed. |
gRPC Response: InitWalletResponse
This response is empty.
UnlockWallet
Simple RPC
UnlockWallet is used at startup of lnd to provide a password to unlock the wallet database.
# The unlock command is used to decrypt lnd's wallet state in order to
# start up. This command MUST be run after booting up lnd before it's
# able to carry out its duties. An exception is if a user is running with
# --noencryptwallet, then a default passphrase will be used.
$ lncli unlock [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.UnlockWalletRequest(
wallet_password=<YOUR_PARAM>,
)
>>> response = stub.UnlockWallet(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.unlockWallet({
wallet_password: <YOUR_PARAM>,
}, function(err, response) {
console.log('UnlockWallet: ' + response);
})
{}
gRPC Request: UnlockWalletRequest
| Field |
Type |
Label |
Description |
| wallet_password |
bytes |
optional |
wallet_password should be the current valid passphrase for the daemon. This will be required to decrypt on-disk material that the daemon requires to function properly. |
gRPC Response: UnlockWalletResponse
This response is empty.
WalletBalance
Simple RPC
WalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.
$ lncli walletbalance [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.WalletBalanceRequest()
>>> response = stub.WalletBalance(request)
>>> response
{
total_balance: <int64>,
confirmed_balance: <int64>,
unconfirmed_balance: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.walletBalance({}, function(err, response) {
console.log('WalletBalance: ' + response);
})
{
total_balance: <int64>,
confirmed_balance: <int64>,
unconfirmed_balance: <int64>,
}
gRPC Request: WalletBalanceRequest
This request has no parameters.
gRPC Response: WalletBalanceResponse
| Field |
Type |
Label |
Description |
| total_balance |
int64 |
optional |
The balance of the wallet |
| confirmed_balance |
int64 |
optional |
The confirmed balance of a wallet(with >= 1 confirmations) |
| unconfirmed_balance |
int64 |
optional |
The unconfirmed balance of a wallet(with 0 confirmations) |
ChannelBalance
Simple RPC
ChannelBalance returns the total funds available across all open channels in satoshis.
$ lncli channelbalance [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ChannelBalanceRequest()
>>> response = stub.ChannelBalance(request)
>>> response
{
balance: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.channelBalance({}, function(err, response) {
console.log('ChannelBalance: ' + response);
})
{
balance: <int64>,
}
gRPC Request: ChannelBalanceRequest
This request has no parameters.
gRPC Response: ChannelBalanceResponse
| Field |
Type |
Label |
Description |
| balance |
int64 |
optional |
Sum of channels balances denominated in satoshis |
GetTransactions
Simple RPC
GetTransactions returns a list describing all the known transactions relevant to the wallet.
# List all transactions an address of the wallet was involved in.
$ lncli listchaintxns [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.GetTransactionsRequest()
>>> response = stub.GetTransactions(request)
>>> response
{
transactions: <Transaction>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.getTransactions({}, function(err, response) {
console.log('GetTransactions: ' + response);
})
{
transactions: <Transaction>,
}
gRPC Request: GetTransactionsRequest
This request has no parameters.
gRPC Response: TransactionDetails
| Field |
Type |
Label |
Description |
| transactions |
Transaction |
repeated |
The list of transactions relevant to the wallet. |
Transaction
| Field |
Type |
Label |
Description |
| tx_hash |
string |
optional |
The transaction hash |
| amount |
int64 |
optional |
The transaction ammount, denominated in satoshis |
| num_confirmations |
int32 |
optional |
The number of confirmations |
| block_hash |
string |
optional |
The hash of the block this transaction was included in |
| block_height |
int32 |
optional |
The height of the block this transaction was included in |
| time_stamp |
int64 |
optional |
Timestamp of this transaction |
| total_fees |
int64 |
optional |
Fees paid for this transaction |
| dest_addresses |
string |
repeated |
Addresses that received funds for this transaction |
SendCoins
Simple RPC
SendCoins executes a request to send coins to a particular address. Unlike SendMany, this RPC call only allows creating a single output at a time. If neither target_conf, or sat_per_byte are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.
# Send amt coins in satoshis to the BASE58 encoded bitcoin address addr.
# Fees used when sending the transaction can be specified via the --conf_target, or
# --sat_per_byte optional flags.
# Positional arguments and flags can be used interchangeably but not at the same time!
$ lncli sendcoins [command options] addr amt
# --addr value the BASE58 encoded bitcoin address to send coins to on-chain
# --amt value the number of bitcoin denominated in satoshis to send (default: 0)
# --conf_target value (optional) the number of blocks that the transaction *should* confirm in, will be used for fee estimation (default: 0)
# --sat_per_byte value (optional) a manual fee expressed in sat/byte that should be used when crafting the transaction (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.SendCoinsRequest(
addr=<YOUR_PARAM>,
amount=<YOUR_PARAM>,
target_conf=<YOUR_PARAM>,
sat_per_byte=<YOUR_PARAM>,
)
>>> response = stub.SendCoins(request)
>>> response
{
txid: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.sendCoins({
addr: <YOUR_PARAM>,
amount: <YOUR_PARAM>,
target_conf: <YOUR_PARAM>,
sat_per_byte: <YOUR_PARAM>,
}, function(err, response) {
console.log('SendCoins: ' + response);
})
{
txid: <string>,
}
gRPC Request: SendCoinsRequest
| Field |
Type |
Label |
Description |
| addr |
string |
optional |
The address to send coins to |
| amount |
int64 |
optional |
The amount in satoshis to send |
| target_conf |
int32 |
optional |
The target number of blocks that this transaction should be confirmed by. |
| sat_per_byte |
int64 |
optional |
A manual fee rate set in sat/byte that should be used when crafting the transaction. |
gRPC Response: SendCoinsResponse
| Field |
Type |
Label |
Description |
| txid |
string |
optional |
The transaction ID of the transaction |
SubscribeTransactions
Response-streaming RPC
SubscribeTransactions creates a uni-directional stream from the server to the client in which any newly discovered transactions relevant to the wallet are sent over.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.GetTransactionsRequest()
>>> for response in stub.SubscribeTransactions(request):
# Do something
print response
{
tx_hash: <string>,
amount: <int64>,
num_confirmations: <int32>,
block_hash: <string>,
block_height: <int32>,
time_stamp: <int64>,
total_fees: <int64>,
dest_addresses: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.subscribeTransactions({})
> call.on('data', function(message) {
console.log(message);
});
> call.on('end', function() {
// The server has finished sending
console.log("END");
});
> call.on('status', function(status) {
// Process status
console.log("Current status: " + status);
});
{
tx_hash: <string>,
amount: <int64>,
num_confirmations: <int32>,
block_hash: <string>,
block_height: <int32>,
time_stamp: <int64>,
total_fees: <int64>,
dest_addresses: <string>,
}
gRPC Request: GetTransactionsRequest
This request has no parameters.
gRPC Response: Transaction (Streaming)
| Field |
Type |
Label |
Description |
| tx_hash |
string |
optional |
The transaction hash |
| amount |
int64 |
optional |
The transaction ammount, denominated in satoshis |
| num_confirmations |
int32 |
optional |
The number of confirmations |
| block_hash |
string |
optional |
The hash of the block this transaction was included in |
| block_height |
int32 |
optional |
The height of the block this transaction was included in |
| time_stamp |
int64 |
optional |
Timestamp of this transaction |
| total_fees |
int64 |
optional |
Fees paid for this transaction |
| dest_addresses |
string |
repeated |
Addresses that received funds for this transaction |
SendMany
Simple RPC
SendMany handles a request for a transaction that creates multiple specified outputs in parallel. If neither target_conf, or sat_per_byte are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.
# Create and broadcast a transaction paying the specified amount(s) to the passed address(es).
# The send-json-string' param decodes addresses and the amount to send
# respectively in the following format:
# '{"ExampleAddr": NumCoinsInSatoshis, "SecondAddr": NumCoins}'
$ lncli sendmany [command options] send-json-string [--conf_target=N] [--sat_per_byte=P]
# --conf_target value (optional) the number of blocks that the transaction *should* confirm in, will be used for fee estimation (default: 0)
# --sat_per_byte value (optional) a manual fee expressed in sat/byte that should be used when crafting the transaction (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.SendManyRequest(
AddrToAmount=<YOUR_PARAM>,
target_conf=<YOUR_PARAM>,
sat_per_byte=<YOUR_PARAM>,
)
>>> response = stub.SendMany(request)
>>> response
{
txid: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.sendMany({
AddrToAmount: <YOUR_PARAM>,
target_conf: <YOUR_PARAM>,
sat_per_byte: <YOUR_PARAM>,
}, function(err, response) {
console.log('SendMany: ' + response);
})
{
txid: <string>,
}
gRPC Request: SendManyRequest
| Field |
Type |
Label |
Description |
| AddrToAmount |
AddrToAmountEntry |
repeated |
The map from addresses to amounts |
| target_conf |
int32 |
optional |
The target number of blocks that this transaction should be confirmed by. |
| sat_per_byte |
int64 |
optional |
A manual fee rate set in sat/byte that should be used when crafting the transaction. |
AddrToAmountEntry
| Field |
Type |
Label |
Description |
| key |
string |
optional |
|
| value |
int64 |
optional |
|
gRPC Response: SendManyResponse
| Field |
Type |
Label |
Description |
| txid |
string |
optional |
The id of the transaction |
NewAddress
Simple RPC
NewAddress creates a new address under control of the local wallet.
# Generate a wallet new address. Address-types has to be one of:
# - p2wkh: Pay to witness key hash
# - np2wkh: Pay to nested witness key hash
$ lncli newaddress address-type
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.NewAddressRequest(
type=<YOUR_PARAM>,
)
>>> response = stub.NewAddress(request)
>>> response
{
address: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.newAddress({
type: <YOUR_PARAM>,
}, function(err, response) {
console.log('NewAddress: ' + response);
})
{
address: <string>,
}
gRPC Request: NewAddressRequest
AddressType has to be one of: - p2wkh: Pay to witness key hash (WITNESS_PUBKEY_HASH = 0) - np2wkh: Pay to nested witness key hash (NESTED_PUBKEY_HASH = 1) - p2pkh: Pay to public key hash (PUBKEY_HASH = 2)
| Field |
Type |
Label |
Description |
| type |
AddressType |
optional |
The address type |
gRPC Response: NewAddressResponse
| Field |
Type |
Label |
Description |
| address |
string |
optional |
The newly generated wallet address |
NewWitnessAddress
Simple RPC
NewWitnessAddress creates a new witness address under control of the local wallet.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.NewWitnessAddressRequest()
>>> response = stub.NewWitnessAddress(request)
>>> response
{
address: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.newWitnessAddress({}, function(err, response) {
console.log('NewWitnessAddress: ' + response);
})
{
address: <string>,
}
gRPC Request: NewWitnessAddressRequest
This request has no parameters.
gRPC Response: NewAddressResponse
| Field |
Type |
Label |
Description |
| address |
string |
optional |
The newly generated wallet address |
SignMessage
Simple RPC
SignMessage signs a message with this node’s private key. The returned signature string is zbase32 encoded and pubkey recoverable, meaning that only the message digest and signature are needed for verification.
# Sign msg with the resident node's private key.
# Returns the signature as a zbase32 string.
# Positional arguments and flags can be used interchangeably but not at the same time!
$ lncli signmessage [command options] msg
# --msg value the message to sign
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.SignMessageRequest(
msg=<YOUR_PARAM>,
)
>>> response = stub.SignMessage(request)
>>> response
{
signature: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.signMessage({
msg: <YOUR_PARAM>,
}, function(err, response) {
console.log('SignMessage: ' + response);
})
{
signature: <string>,
}
gRPC Request: SignMessageRequest
| Field |
Type |
Label |
Description |
| msg |
bytes |
optional |
The message to be signed |
gRPC Response: SignMessageResponse
| Field |
Type |
Label |
Description |
| signature |
string |
optional |
The signature for the given message |
VerifyMessage
Simple RPC
VerifyMessage verifies a signature over a msg. The signature must be zbase32 encoded and signed by an active node in the resident node’s channel database. In addition to returning the validity of the signature, VerifyMessage also returns the recovered pubkey from the signature.
# Verify that the message was signed with a properly-formed signature
# The signature must be zbase32 encoded and signed with the private key of
# an active node in the resident node's channel database.
# Positional arguments and flags can be used interchangeably but not at the same time!
$ lncli verifymessage [command options] msg signature
# --msg value the message to verify
# --sig value the zbase32 encoded signature of the message
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.VerifyMessageRequest(
msg=<YOUR_PARAM>,
signature=<YOUR_PARAM>,
)
>>> response = stub.VerifyMessage(request)
>>> response
{
valid: <bool>,
pubkey: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.verifyMessage({
msg: <YOUR_PARAM>,
signature: <YOUR_PARAM>,
}, function(err, response) {
console.log('VerifyMessage: ' + response);
})
{
valid: <bool>,
pubkey: <string>,
}
gRPC Request: VerifyMessageRequest
| Field |
Type |
Label |
Description |
| msg |
bytes |
optional |
The message over which the signature is to be verified |
| signature |
string |
optional |
The signature to be verified over the given message |
gRPC Response: VerifyMessageResponse
| Field |
Type |
Label |
Description |
| valid |
bool |
optional |
Whether the signature was valid over the given message |
| pubkey |
string |
optional |
The pubkey recovered from the signature |
ConnectPeer
Simple RPC
ConnectPeer attempts to establish a connection to a remote peer. This is at the networking level, and is used for communication between nodes. This is distinct from establishing a channel with a peer.
$ lncli connect [command options] <pubkey>@host
# --perm If set, the daemon will attempt to persistently connect to the target peer.
# If not, the call will be synchronous.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ConnectPeerRequest(
addr=<YOUR_PARAM>,
perm=<YOUR_PARAM>,
)
>>> response = stub.ConnectPeer(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.connectPeer({
addr: <YOUR_PARAM>,
perm: <YOUR_PARAM>,
}, function(err, response) {
console.log('ConnectPeer: ' + response);
})
{}
gRPC Request: ConnectPeerRequest
| Field |
Type |
Label |
Description |
| addr |
LightningAddress |
optional |
Lightning address of the peer, in the format <pubkey>@host |
| perm |
bool |
optional |
If set, the daemon will attempt to persistently connect to the target peer. Otherwise, the call will be synchronous. |
LightningAddress
| Field |
Type |
Label |
Description |
| pubkey |
string |
optional |
The identity pubkey of the Lightning node |
| host |
string |
optional |
The network location of the lightning node, e.g. 69.69.69.69:1337 or localhost:10011 |
gRPC Response: ConnectPeerResponse
This response is empty.
DisconnectPeer
Simple RPC
DisconnectPeer attempts to disconnect one peer from another identified by a given pubKey. In the case that we currently have a pending or active channel with the target peer, then this action will be not be allowed.
$ lncli disconnect [command options] <pubkey>
# --node_key value The hex-encoded compressed public key of the peer to disconnect from
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.DisconnectPeerRequest(
pub_key=<YOUR_PARAM>,
)
>>> response = stub.DisconnectPeer(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.disconnectPeer({
pub_key: <YOUR_PARAM>,
}, function(err, response) {
console.log('DisconnectPeer: ' + response);
})
{}
gRPC Request: DisconnectPeerRequest
| Field |
Type |
Label |
Description |
| pub_key |
string |
optional |
The pubkey of the node to disconnect from |
gRPC Response: DisconnectPeerResponse
This response is empty.
ListPeers
Simple RPC
ListPeers returns a verbose listing of all currently active peers.
$ lncli listpeers [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ListPeersRequest()
>>> response = stub.ListPeers(request)
>>> response
{
peers: <Peer>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.listPeers({}, function(err, response) {
console.log('ListPeers: ' + response);
})
{
peers: <Peer>,
}
gRPC Request: ListPeersRequest
This request has no parameters.
gRPC Response: ListPeersResponse
| Field |
Type |
Label |
Description |
| peers |
Peer |
repeated |
The list of currently connected peers |
Peer
| Field |
Type |
Label |
Description |
| pub_key |
string |
optional |
The identity pubkey of the peer |
| address |
string |
optional |
Network address of the peer; eg 127.0.0.1:10011 |
| bytes_sent |
uint64 |
optional |
Bytes of data transmitted to this peer |
| bytes_recv |
uint64 |
optional |
Bytes of data transmitted from this peer |
| sat_sent |
int64 |
optional |
Satoshis sent to this peer |
| sat_recv |
int64 |
optional |
Satoshis received from this peer |
| inbound |
bool |
optional |
A channel is inbound if the counterparty initiated the channel |
| ping_time |
int64 |
optional |
Ping time to this peer |
GetInfo
Simple RPC
GetInfo returns general information concerning the lightning node including it’s identity pubkey, alias, the chains it is connected to, and information concerning the number of open+pending channels.
$ lncli getinfo [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.GetInfoRequest()
>>> response = stub.GetInfo(request)
>>> response
{
identity_pubkey: <string>,
alias: <string>,
num_pending_channels: <uint32>,
num_active_channels: <uint32>,
num_peers: <uint32>,
block_height: <uint32>,
block_hash: <string>,
synced_to_chain: <bool>,
testnet: <bool>,
chains: <string>,
uris: <string>,
best_header_timestamp: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.getInfo({}, function(err, response) {
console.log('GetInfo: ' + response);
})
{
identity_pubkey: <string>,
alias: <string>,
num_pending_channels: <uint32>,
num_active_channels: <uint32>,
num_peers: <uint32>,
block_height: <uint32>,
block_hash: <string>,
synced_to_chain: <bool>,
testnet: <bool>,
chains: <string>,
uris: <string>,
best_header_timestamp: <int64>,
}
gRPC Request: GetInfoRequest
This request has no parameters.
gRPC Response: GetInfoResponse
| Field |
Type |
Label |
Description |
| identity_pubkey |
string |
optional |
The identity pubkey of the current node. |
| alias |
string |
optional |
If applicable, the alias of the current node, e.g. “bob” |
| num_pending_channels |
uint32 |
optional |
Number of pending channels |
| num_active_channels |
uint32 |
optional |
Number of active channels |
| num_peers |
uint32 |
optional |
Number of peers |
| block_height |
uint32 |
optional |
The node’s current view of the height of the best block |
| block_hash |
string |
optional |
The node’s current view of the hash of the best block |
| synced_to_chain |
bool |
optional |
Whether the wallet’s view is synced to the main chain |
| testnet |
bool |
optional |
Whether the current node is connected to testnet |
| chains |
string |
repeated |
A list of active chains the node is connected to |
| uris |
string |
repeated |
The URIs of the current node. |
| best_header_timestamp |
int64 |
optional |
Timestamp of the block best known to the wallet |
PendingChannels
Simple RPC
PendingChannels returns a list of all the channels that are currently considered “pending”. A channel is pending if it has finished the funding workflow and is waiting for confirmations for the funding txn, or is in the process of closure, either initiated cooperatively or non-cooperatively.
$ lncli pendingchannels [command options] [arguments...]
# --open, -o display the status of new pending channels
# --close, -c display the status of channels being closed
# --all, -a display the status of channels in the process of being opened or closed
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.PendingChannelsRequest()
>>> response = stub.PendingChannels(request)
>>> response
{
total_limbo_balance: <int64>,
pending_open_channels: <PendingOpenChannel>,
pending_closing_channels: <ClosedChannel>,
pending_force_closing_channels: <ForceClosedChannel>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.pendingChannels({}, function(err, response) {
console.log('PendingChannels: ' + response);
})
{
total_limbo_balance: <int64>,
pending_open_channels: <PendingOpenChannel>,
pending_closing_channels: <ClosedChannel>,
pending_force_closing_channels: <ForceClosedChannel>,
}
gRPC Request: PendingChannelsRequest
This request has no parameters.
gRPC Response: PendingChannelsResponse
| Field |
Type |
Label |
Description |
| total_limbo_balance |
int64 |
optional |
The balance in satoshis encumbered in pending channels |
| pending_open_channels |
PendingOpenChannel |
repeated |
Channels pending opening |
| pending_closing_channels |
ClosedChannel |
repeated |
Channels pending closing |
| pending_force_closing_channels |
ForceClosedChannel |
repeated |
Channels pending force closing |
PendingOpenChannel
| Field |
Type |
Label |
Description |
| channel |
PendingChannel |
optional |
The pending channel |
| confirmation_height |
uint32 |
optional |
The height at which this channel will be confirmed |
| commit_fee |
int64 |
optional |
The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart. |
| commit_weight |
int64 |
optional |
The weight of the commitment transaction |
| fee_per_kw |
int64 |
optional |
The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open. |
ClosedChannel
| Field |
Type |
Label |
Description |
| channel |
PendingChannel |
optional |
The pending channel to be closed |
| closing_txid |
string |
optional |
The transaction id of the closing transaction |
ForceClosedChannel
| Field |
Type |
Label |
Description |
| channel |
PendingChannel |
optional |
The pending channel to be force closed |
| closing_txid |
string |
optional |
The transaction id of the closing transaction |
| limbo_balance |
int64 |
optional |
The balance in satoshis encumbered in this pending channel |
| maturity_height |
uint32 |
optional |
The height at which funds can be sweeped into the wallet |
| blocks_til_maturity |
int32 |
optional |
|
| recovered_balance |
int64 |
optional |
The total value of funds successfully recovered from this channel |
| pending_htlcs |
PendingHTLC |
repeated |
|
ListChannels
Simple RPC
ListChannels returns a description of all the open channels that this node is a participant in.
$ lncli listchannels [command options] [arguments...]
# --active_only, -a only list channels which are currently active
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ListChannelsRequest()
>>> response = stub.ListChannels(request)
>>> response
{
channels: <ActiveChannel>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.listChannels({}, function(err, response) {
console.log('ListChannels: ' + response);
})
{
channels: <ActiveChannel>,
}
gRPC Request: ListChannelsRequest
This request has no parameters.
gRPC Response: ListChannelsResponse
| Field |
Type |
Label |
Description |
| channels |
ActiveChannel |
repeated |
The list of active channels |
ActiveChannel
| Field |
Type |
Label |
Description |
| active |
bool |
optional |
Whether this channel is active or not |
| remote_pubkey |
string |
optional |
The identity pubkey of the remote node |
| channel_point |
string |
optional |
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice’s version of the commitment transaction. |
| chan_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
| capacity |
int64 |
optional |
The total amount of funds held in this channel |
| local_balance |
int64 |
optional |
This node’s current balance in this channel |
| remote_balance |
int64 |
optional |
The counterparty’s current balance in this channel |
| commit_fee |
int64 |
optional |
The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart. |
| commit_weight |
int64 |
optional |
The weight of the commitment transaction |
| fee_per_kw |
int64 |
optional |
The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open. |
| unsettled_balance |
int64 |
optional |
The unsettled balance in this channel |
| total_satoshis_sent |
int64 |
optional |
The total number of satoshis we’ve sent within this channel. |
| total_satoshis_received |
int64 |
optional |
The total number of satoshis we’ve received within this channel. |
| num_updates |
uint64 |
optional |
The total number of updates conducted within this channel. |
| pending_htlcs |
HTLC |
repeated |
The list of active, uncleared HTLCs currently pending within the channel. |
| csv_delay |
uint32 |
optional |
The CSV delay expressed in relative blocks. If the channel is force closed, we’ll need to wait for this many blocks before we can regain our funds. |
OpenChannelSync
Simple RPC
OpenChannelSync is a synchronous version of the OpenChannel RPC call. This call is meant to be consumed by clients to the REST proxy. As with all other sync calls, all byte slices are intended to be populated as hex encoded strings.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.OpenChannelRequest(
node_pubkey=<YOUR_PARAM>,
node_pubkey_string=<YOUR_PARAM>,
local_funding_amount=<YOUR_PARAM>,
push_sat=<YOUR_PARAM>,
target_conf=<YOUR_PARAM>,
sat_per_byte=<YOUR_PARAM>,
private=<YOUR_PARAM>,
min_htlc_msat=<YOUR_PARAM>,
)
>>> response = stub.OpenChannelSync(request)
>>> response
{
funding_txid_bytes: <bytes>,
funding_txid_str: <string>,
output_index: <uint32>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.openChannelSync({
node_pubkey: <YOUR_PARAM>,
node_pubkey_string: <YOUR_PARAM>,
local_funding_amount: <YOUR_PARAM>,
push_sat: <YOUR_PARAM>,
target_conf: <YOUR_PARAM>,
sat_per_byte: <YOUR_PARAM>,
private: <YOUR_PARAM>,
min_htlc_msat: <YOUR_PARAM>,
}, function(err, response) {
console.log('OpenChannelSync: ' + response);
})
{
funding_txid_bytes: <bytes>,
funding_txid_str: <string>,
output_index: <uint32>,
}
gRPC Request: OpenChannelRequest
| Field |
Type |
Label |
Description |
| node_pubkey |
bytes |
optional |
The pubkey of the node to open a channel with |
| node_pubkey_string |
string |
optional |
The hex encoded pubkey of the node to open a channel with |
| local_funding_amount |
int64 |
optional |
The number of satoshis the wallet should commit to the channel |
| push_sat |
int64 |
optional |
The number of satoshis to push to the remote side as part of the initial commitment state |
| target_conf |
int32 |
optional |
The target number of blocks that the closure transaction should be confirmed by. |
| sat_per_byte |
int64 |
optional |
A manual fee rate set in sat/byte that should be used when crafting the closure transaction. |
| private |
bool |
optional |
Whether this channel should be private, not announced to the greater network. |
| min_htlc_msat |
int64 |
optional |
The minimum value in millisatoshi we will require for incoming HTLCs on the channel. |
gRPC Response: ChannelPoint
| Field |
Type |
Label |
Description |
| funding_txid_bytes |
bytes |
optional |
Txid of the funding transaction |
| funding_txid_str |
string |
optional |
Hex-encoded string representing the funding transaction |
| output_index |
uint32 |
optional |
The index of the output of the funding transaction |
OpenChannel
Response-streaming RPC
OpenChannel attempts to open a singly funded channel specified in the request to a remote peer. Users are able to specify a target number of blocks that the funding transaction should be confirmed in, or a manual fee rate to us for the funding transaction. If neither are specified, then a lax block confirmation target is used.
# Attempt to open a new channel to an existing peer with the key node-key
# optionally blocking until the channel is 'open'.
# One can also connect to a node before opening a new channel to it by
# setting its host:port via the --connect argument. For this to work,
# the node_key must be provided, rather than the peer_id. This is optional.
# The channel will be initialized with local-amt satoshis local and push-amt
# satoshis for the remote node. Once the channel is open, a channelPoint (txid:vout)
# of the funding output is returned.
# One can manually set the fee to be used for the funding transaction via either
# the --conf_target or --sat_per_byte arguments. This is optional.
$ lncli openchannel [command options] node-key local-amt push-amt
# --node_key value the identity public key of the target node/peer serialized in compressed format
# --connect value (optional) the host:port of the target node
# --local_amt value the number of satoshis the wallet should commit to the channel (default: 0)
# --push_amt value the number of satoshis to push to the remote side as part of the initial commitment state (default: 0)
# --block block and wait until the channel is fully open
# --conf_target value (optional) the number of blocks that the transaction *should* confirm in, will be used for fee estimation (default: 0)
# --sat_per_byte value (optional) a manual fee expressed in sat/byte that should be used when crafting the transaction (default: 0)
# --private make the channel private, such that it won't be announced to the greater network, and nodes other than the two channel endpoints must be explicitly told about it to be able to route through it
# --min_htlc_msat value (optional) the minimum value we will require for incoming HTLCs on the channel (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.OpenChannelRequest(
node_pubkey=<YOUR_PARAM>,
node_pubkey_string=<YOUR_PARAM>,
local_funding_amount=<YOUR_PARAM>,
push_sat=<YOUR_PARAM>,
target_conf=<YOUR_PARAM>,
sat_per_byte=<YOUR_PARAM>,
private=<YOUR_PARAM>,
min_htlc_msat=<YOUR_PARAM>,
)
>>> for response in stub.OpenChannel(request):
# Do something
print response
{
chan_pending: <PendingUpdate>,
confirmation: <ConfirmationUpdate>,
chan_open: <ChannelOpenUpdate>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.openChannel({
node_pubkey: <YOUR_PARAM>,
node_pubkey_string: <YOUR_PARAM>,
local_funding_amount: <YOUR_PARAM>,
push_sat: <YOUR_PARAM>,
target_conf: <YOUR_PARAM>,
sat_per_byte: <YOUR_PARAM>,
private: <YOUR_PARAM>,
min_htlc_msat: <YOUR_PARAM>,
})
> call.on('data', function(message) {
console.log(message);
});
> call.on('end', function() {
// The server has finished sending
console.log("END");
});
> call.on('status', function(status) {
// Process status
console.log("Current status: " + status);
});
{
chan_pending: <PendingUpdate>,
confirmation: <ConfirmationUpdate>,
chan_open: <ChannelOpenUpdate>,
}
gRPC Request: OpenChannelRequest
| Field |
Type |
Label |
Description |
| node_pubkey |
bytes |
optional |
The pubkey of the node to open a channel with |
| node_pubkey_string |
string |
optional |
The hex encoded pubkey of the node to open a channel with |
| local_funding_amount |
int64 |
optional |
The number of satoshis the wallet should commit to the channel |
| push_sat |
int64 |
optional |
The number of satoshis to push to the remote side as part of the initial commitment state |
| target_conf |
int32 |
optional |
The target number of blocks that the closure transaction should be confirmed by. |
| sat_per_byte |
int64 |
optional |
A manual fee rate set in sat/byte that should be used when crafting the closure transaction. |
| private |
bool |
optional |
Whether this channel should be private, not announced to the greater network. |
| min_htlc_msat |
int64 |
optional |
The minimum value in millisatoshi we will require for incoming HTLCs on the channel. |
gRPC Response: OpenStatusUpdate (Streaming)
| Field |
Type |
Label |
Description |
| chan_pending |
PendingUpdate |
optional |
|
| confirmation |
ConfirmationUpdate |
optional |
|
| chan_open |
ChannelOpenUpdate |
optional |
|
PendingUpdate
| Field |
Type |
Label |
Description |
| txid |
bytes |
optional |
|
| output_index |
uint32 |
optional |
|
ConfirmationUpdate
| Field |
Type |
Label |
Description |
| block_sha |
bytes |
optional |
|
| block_height |
int32 |
optional |
|
| num_confs_left |
uint32 |
optional |
|
ChannelOpenUpdate
| Field |
Type |
Label |
Description |
| channel_point |
ChannelPoint |
optional |
|
CloseChannel
Response-streaming RPC
CloseChannel attempts to close an active channel identified by its channel outpoint (ChannelPoint). The actions of this method can additionally be augmented to attempt a force close after a timeout period in the case of an inactive peer. If a non-force close (cooperative closure) is requested, then the user can specify either a target number of blocks until the closure transaction is confirmed, or a manual fee rate. If neither are specified, then a default lax, block confirmation target is used.
# Close an existing channel. The channel can be closed either cooperatively,
# or unilaterally (--force).
# A unilateral channel closure means that the latest commitment
# transaction will be broadcast to the network. As a result, any settled
# funds will be time locked for a few blocks before they can be swept int
# lnd's wallet.
# In the case of a cooperative closure, One can manually set the fee to
# be used for the closing transaction via either the --conf_target or
# --sat_per_byte arguments. This will be the starting value used during
# fee negotiation. This is optional.
$ lncli closechannel [command options] funding_txid [output_index [time_limit]]
# --funding_txid value the txid of the channel's funding transaction
# --output_index value the output index for the funding output of the funding transaction (default: 0)
# --time_limit value a relative deadline afterwhich the attempt should be abandoned
# --force after the time limit has passed, attempt an uncooperative closure
# --block block until the channel is closed
# --conf_target value (optional) the number of blocks that the transaction *should* confirm in, will be used for fee estimation (default: 0)
# --sat_per_byte value (optional) a manual fee expressed in sat/byte that should be used when crafting the transaction (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.CloseChannelRequest(
channel_point=<YOUR_PARAM>,
force=<YOUR_PARAM>,
target_conf=<YOUR_PARAM>,
sat_per_byte=<YOUR_PARAM>,
)
>>> for response in stub.CloseChannel(request):
# Do something
print response
{
close_pending: <PendingUpdate>,
confirmation: <ConfirmationUpdate>,
chan_close: <ChannelCloseUpdate>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.closeChannel({
channel_point: <YOUR_PARAM>,
force: <YOUR_PARAM>,
target_conf: <YOUR_PARAM>,
sat_per_byte: <YOUR_PARAM>,
})
> call.on('data', function(message) {
console.log(message);
});
> call.on('end', function() {
// The server has finished sending
console.log("END");
});
> call.on('status', function(status) {
// Process status
console.log("Current status: " + status);
});
{
close_pending: <PendingUpdate>,
confirmation: <ConfirmationUpdate>,
chan_close: <ChannelCloseUpdate>,
}
gRPC Request: CloseChannelRequest
| Field |
Type |
Label |
Description |
| channel_point |
ChannelPoint |
optional |
The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice’s version of the commitment transaction. |
| force |
bool |
optional |
If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast. |
| target_conf |
int32 |
optional |
The target number of blocks that the closure transaction should be confirmed by. |
| sat_per_byte |
int64 |
optional |
A manual fee rate set in sat/byte that should be used when crafting the closure transaction. |
ChannelPoint
| Field |
Type |
Label |
Description |
| funding_txid_bytes |
bytes |
optional |
Txid of the funding transaction |
| funding_txid_str |
string |
optional |
Hex-encoded string representing the funding transaction |
| output_index |
uint32 |
optional |
The index of the output of the funding transaction |
gRPC Response: CloseStatusUpdate (Streaming)
| Field |
Type |
Label |
Description |
| close_pending |
PendingUpdate |
optional |
|
| confirmation |
ConfirmationUpdate |
optional |
|
| chan_close |
ChannelCloseUpdate |
optional |
|
PendingUpdate
| Field |
Type |
Label |
Description |
| txid |
bytes |
optional |
|
| output_index |
uint32 |
optional |
|
ConfirmationUpdate
| Field |
Type |
Label |
Description |
| block_sha |
bytes |
optional |
|
| block_height |
int32 |
optional |
|
| num_confs_left |
uint32 |
optional |
|
ChannelCloseUpdate
| Field |
Type |
Label |
Description |
| closing_txid |
bytes |
optional |
|
| success |
bool |
optional |
|
SendPayment
Bidirectional-streaming RPC
SendPayment dispatches a bi-directional streaming RPC for sending payments through the Lightning Network. A single RPC invocation creates a persistent bi-directional stream allowing clients to rapidly send payments through the Lightning Network with a single persistent connection.
# Send a payment over Lightning. One can either specify the full
# parameters of the payment, or just use a payment request which encodes
# all the payment details.
# If payment isn't manually specified, then only a payment request needs
# to be passed using the --pay_req argument.
# If the payment *is* manually specified, then all four alternative
# arguments need to be specified in order to complete the payment:
# * --dest=N
# * --amt=A
# * --final_cltv_delta=T
# * --payment_hash=H
# The --debug_send flag is provided for usage *purely* in test
# environments. If specified, then the payment hash isn't required, as
# it'll use the hash of all zeroes. This mode allows one to quickly test
# payment connectivity without having to create an invoice at the
# destination.
$ lncli sendpayment [command options] dest amt payment_hash final_cltv_delta | --pay_req=[payment request]
# --dest value, -d value the compressed identity pubkey of the payment recipient
# --amt value, -a value number of satoshis to send (default: 0)
# --payment_hash value, -r value the hash to use within the payment's HTLC
# --debug_send use the debug rHash when sending the HTLC
# --pay_req value a zpay32 encoded payment request to fulfill
# --final_cltv_delta value the number of blocks the last hop has to reveal the preimage (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
# Define a generator that returns an Iterable of SendRequest objects
>>> def request_generator():
# Initialization code here
print("Starting up")
while True:
# Params here can be set as arguments to the generator
request = ln.SendRequest(
dest=<YOUR_PARAM>,
dest_string=<YOUR_PARAM>,
amt=<YOUR_PARAM>,
payment_hash=<YOUR_PARAM>,
payment_hash_string=<YOUR_PARAM>,
payment_request=<YOUR_PARAM>,
final_cltv_delta=<YOUR_PARAM>,
)
yield request
# Do things between iterations here
>>> request_iterable = request_generator()
>>> for response in stub.SendPayment(request_iterable):
# Do something
print response
{
payment_error: <string>,
payment_preimage: <bytes>,
payment_route: <Route>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.sendPayment({});
> call.on('data', function(message) {
console.log(message);
});
> call.write({
dest: <YOUR_PARAM>,
dest_string: <YOUR_PARAM>,
amt: <YOUR_PARAM>,
payment_hash: <YOUR_PARAM>,
payment_hash_string: <YOUR_PARAM>,
payment_request: <YOUR_PARAM>,
final_cltv_delta: <YOUR_PARAM>,
});
{
payment_error: <string>,
payment_preimage: <bytes>,
payment_route: <Route>,
}
gRPC Request: SendRequest (Streaming)
| Field |
Type |
Label |
Description |
| dest |
bytes |
optional |
The identity pubkey of the payment recipient |
| dest_string |
string |
optional |
The hex-encoded identity pubkey of the payment recipient |
| amt |
int64 |
optional |
Number of satoshis to send. |
| payment_hash |
bytes |
optional |
The hash to use within the payment’s HTLC |
| payment_hash_string |
string |
optional |
The hex-encoded hash to use within the payment’s HTLC |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| final_cltv_delta |
int32 |
optional |
The CLTV delta from the current height that should be used to set the timelock for the final hop. |
gRPC Response: SendResponse (Streaming)
| Field |
Type |
Label |
Description |
| payment_error |
string |
optional |
|
| payment_preimage |
bytes |
optional |
|
| payment_route |
Route |
optional |
|
Route
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.
| Field |
Type |
Label |
Description |
| total_time_lock |
uint32 |
optional |
The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment. |
| total_fees |
int64 |
optional |
The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don’t need to pay a fee it ourself. |
| total_amt |
int64 |
optional |
The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees. |
| hops |
Hop |
repeated |
Contains details concerning the specific forwarding details at each hop. |
SendPaymentSync
Simple RPC
SendPaymentSync is the synchronous non-streaming version of SendPayment. This RPC is intended to be consumed by clients of the REST proxy. Additionally, this RPC expects the destination’s public key and the payment hash (if any) to be encoded as hex strings.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.SendRequest(
dest=<YOUR_PARAM>,
dest_string=<YOUR_PARAM>,
amt=<YOUR_PARAM>,
payment_hash=<YOUR_PARAM>,
payment_hash_string=<YOUR_PARAM>,
payment_request=<YOUR_PARAM>,
final_cltv_delta=<YOUR_PARAM>,
)
>>> response = stub.SendPaymentSync(request)
>>> response
{
payment_error: <string>,
payment_preimage: <bytes>,
payment_route: <Route>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.sendPaymentSync({
dest: <YOUR_PARAM>,
dest_string: <YOUR_PARAM>,
amt: <YOUR_PARAM>,
payment_hash: <YOUR_PARAM>,
payment_hash_string: <YOUR_PARAM>,
payment_request: <YOUR_PARAM>,
final_cltv_delta: <YOUR_PARAM>,
}, function(err, response) {
console.log('SendPaymentSync: ' + response);
})
{
payment_error: <string>,
payment_preimage: <bytes>,
payment_route: <Route>,
}
gRPC Request: SendRequest
| Field |
Type |
Label |
Description |
| dest |
bytes |
optional |
The identity pubkey of the payment recipient |
| dest_string |
string |
optional |
The hex-encoded identity pubkey of the payment recipient |
| amt |
int64 |
optional |
Number of satoshis to send. |
| payment_hash |
bytes |
optional |
The hash to use within the payment’s HTLC |
| payment_hash_string |
string |
optional |
The hex-encoded hash to use within the payment’s HTLC |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| final_cltv_delta |
int32 |
optional |
The CLTV delta from the current height that should be used to set the timelock for the final hop. |
gRPC Response: SendResponse
| Field |
Type |
Label |
Description |
| payment_error |
string |
optional |
|
| payment_preimage |
bytes |
optional |
|
| payment_route |
Route |
optional |
|
Route
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.
| Field |
Type |
Label |
Description |
| total_time_lock |
uint32 |
optional |
The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment. |
| total_fees |
int64 |
optional |
The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don’t need to pay a fee it ourself. |
| total_amt |
int64 |
optional |
The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees. |
| hops |
Hop |
repeated |
Contains details concerning the specific forwarding details at each hop. |
AddInvoice
Simple RPC
AddInvoice attempts to add a new invoice to the invoice database. Any duplicated invoices are rejected, therefore all invoices must have a unique payment preimage.
# Add a new invoice, expressing intent for a future payment.
# Invoices without an amount can be created by not supplying any
# parameters or providing an amount of 0. These invoices allow the payee
# to specify the amount of satoshis they wish to send.
$ lncli addinvoice [command options] value preimage
# --memo value a description of the payment to attach along with the invoice (default="")
# --receipt value an optional cryptographic receipt of payment
# --preimage value the hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. If not set, a random preimage will be created.
# --amt value the amt of satoshis in this invoice (default: 0)
# --description_hash value SHA-256 hash of the description of the payment. Used if the purpose of payment cannot naturally fit within the memo. If provided this will be used instead of the description(memo) field in the encoded invoice.
# --fallback_addr value fallback on-chain address that can be used in case the lightning payment fails
# --expiry value the invoice's expiry time in seconds. If not specified an expiry of 3600 seconds (1 hour) is implied. (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.Invoice(
memo=<YOUR_PARAM>,
receipt=<YOUR_PARAM>,
r_preimage=<YOUR_PARAM>,
r_hash=<YOUR_PARAM>,
value=<YOUR_PARAM>,
settled=<YOUR_PARAM>,
creation_date=<YOUR_PARAM>,
settle_date=<YOUR_PARAM>,
payment_request=<YOUR_PARAM>,
description_hash=<YOUR_PARAM>,
expiry=<YOUR_PARAM>,
fallback_addr=<YOUR_PARAM>,
cltv_expiry=<YOUR_PARAM>,
)
>>> response = stub.AddInvoice(request)
>>> response
{
r_hash: <bytes>,
payment_request: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.addInvoice({
memo: <YOUR_PARAM>,
receipt: <YOUR_PARAM>,
r_preimage: <YOUR_PARAM>,
r_hash: <YOUR_PARAM>,
value: <YOUR_PARAM>,
settled: <YOUR_PARAM>,
creation_date: <YOUR_PARAM>,
settle_date: <YOUR_PARAM>,
payment_request: <YOUR_PARAM>,
description_hash: <YOUR_PARAM>,
expiry: <YOUR_PARAM>,
fallback_addr: <YOUR_PARAM>,
cltv_expiry: <YOUR_PARAM>,
}, function(err, response) {
console.log('AddInvoice: ' + response);
})
{
r_hash: <bytes>,
payment_request: <string>,
}
gRPC Request: Invoice
| Field |
Type |
Label |
Description |
| memo |
string |
optional |
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice’s creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used. |
| receipt |
bytes |
optional |
An optional cryptographic receipt of payment |
| r_preimage |
bytes |
optional |
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage |
| r_hash |
bytes |
optional |
The hash of the preimage |
| value |
int64 |
optional |
The value of this invoice in satoshis |
| settled |
bool |
optional |
Whether this invoice has been fulfilled |
| creation_date |
int64 |
optional |
When this invoice was created |
| settle_date |
int64 |
optional |
When this invoice was settled |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| description_hash |
bytes |
optional |
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. |
| expiry |
int64 |
optional |
Payment request expiry time in seconds. Default is 3600 (1 hour). |
| fallback_addr |
string |
optional |
Fallback on-chain address. |
| cltv_expiry |
uint64 |
optional |
Delta to use for the time-lock of the CLTV extended to the final hop. |
gRPC Response: AddInvoiceResponse
| Field |
Type |
Label |
Description |
| r_hash |
bytes |
optional |
|
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
ListInvoices
Simple RPC
ListInvoices returns a list of all the invoices currently stored within the database. Any active debug invoices are ignored.
$ lncli listinvoices [command options] [arguments...]
# --pending_only toggles if all invoices should be returned, or only those that are currently unsettled
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ListInvoiceRequest(
pending_only=<YOUR_PARAM>,
)
>>> response = stub.ListInvoices(request)
>>> response
{
invoices: <Invoice>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.listInvoices({
pending_only: <YOUR_PARAM>,
}, function(err, response) {
console.log('ListInvoices: ' + response);
})
{
invoices: <Invoice>,
}
gRPC Request: ListInvoiceRequest
| Field |
Type |
Label |
Description |
| pending_only |
bool |
optional |
Toggles if all invoices should be returned, or only those that are currently unsettled. |
gRPC Response: ListInvoiceResponse
| Field |
Type |
Label |
Description |
| invoices |
Invoice |
repeated |
|
Invoice
| Field |
Type |
Label |
Description |
| memo |
string |
optional |
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice’s creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used. |
| receipt |
bytes |
optional |
An optional cryptographic receipt of payment |
| r_preimage |
bytes |
optional |
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage |
| r_hash |
bytes |
optional |
The hash of the preimage |
| value |
int64 |
optional |
The value of this invoice in satoshis |
| settled |
bool |
optional |
Whether this invoice has been fulfilled |
| creation_date |
int64 |
optional |
When this invoice was created |
| settle_date |
int64 |
optional |
When this invoice was settled |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| description_hash |
bytes |
optional |
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. |
| expiry |
int64 |
optional |
Payment request expiry time in seconds. Default is 3600 (1 hour). |
| fallback_addr |
string |
optional |
Fallback on-chain address. |
| cltv_expiry |
uint64 |
optional |
Delta to use for the time-lock of the CLTV extended to the final hop. |
LookupInvoice
Simple RPC
LookupInvoice attempts to look up an invoice according to its payment hash. The passed payment hash must be exactly 32 bytes, if not, an error is returned.
$ lncli lookupinvoice [command options] rhash
# --rhash value the 32 byte payment hash of the invoice to query for, the hash should be a hex-encoded string
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.PaymentHash(
r_hash_str=<YOUR_PARAM>,
r_hash=<YOUR_PARAM>,
)
>>> response = stub.LookupInvoice(request)
>>> response
{
memo: <string>,
receipt: <bytes>,
r_preimage: <bytes>,
r_hash: <bytes>,
value: <int64>,
settled: <bool>,
creation_date: <int64>,
settle_date: <int64>,
payment_request: <string>,
description_hash: <bytes>,
expiry: <int64>,
fallback_addr: <string>,
cltv_expiry: <uint64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.lookupInvoice({
r_hash_str: <YOUR_PARAM>,
r_hash: <YOUR_PARAM>,
}, function(err, response) {
console.log('LookupInvoice: ' + response);
})
{
memo: <string>,
receipt: <bytes>,
r_preimage: <bytes>,
r_hash: <bytes>,
value: <int64>,
settled: <bool>,
creation_date: <int64>,
settle_date: <int64>,
payment_request: <string>,
description_hash: <bytes>,
expiry: <int64>,
fallback_addr: <string>,
cltv_expiry: <uint64>,
}
gRPC Request: PaymentHash
| Field |
Type |
Label |
Description |
| r_hash_str |
string |
optional |
The hex-encoded payment hash of the invoice to be looked up. The passed payment hash must be exactly 32 bytes, otherwise an error is returned. |
| r_hash |
bytes |
optional |
The payment hash of the invoice to be looked up. |
gRPC Response: Invoice
| Field |
Type |
Label |
Description |
| memo |
string |
optional |
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice’s creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used. |
| receipt |
bytes |
optional |
An optional cryptographic receipt of payment |
| r_preimage |
bytes |
optional |
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage |
| r_hash |
bytes |
optional |
The hash of the preimage |
| value |
int64 |
optional |
The value of this invoice in satoshis |
| settled |
bool |
optional |
Whether this invoice has been fulfilled |
| creation_date |
int64 |
optional |
When this invoice was created |
| settle_date |
int64 |
optional |
When this invoice was settled |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| description_hash |
bytes |
optional |
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. |
| expiry |
int64 |
optional |
Payment request expiry time in seconds. Default is 3600 (1 hour). |
| fallback_addr |
string |
optional |
Fallback on-chain address. |
| cltv_expiry |
uint64 |
optional |
Delta to use for the time-lock of the CLTV extended to the final hop. |
SubscribeInvoices
Response-streaming RPC
SubscribeInvoices returns a uni-directional stream (sever -> client) for notifying the client of newly added/settled invoices.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.InvoiceSubscription()
>>> for response in stub.SubscribeInvoices(request):
# Do something
print response
{
memo: <string>,
receipt: <bytes>,
r_preimage: <bytes>,
r_hash: <bytes>,
value: <int64>,
settled: <bool>,
creation_date: <int64>,
settle_date: <int64>,
payment_request: <string>,
description_hash: <bytes>,
expiry: <int64>,
fallback_addr: <string>,
cltv_expiry: <uint64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.subscribeInvoices({})
> call.on('data', function(message) {
console.log(message);
});
> call.on('end', function() {
// The server has finished sending
console.log("END");
});
> call.on('status', function(status) {
// Process status
console.log("Current status: " + status);
});
{
memo: <string>,
receipt: <bytes>,
r_preimage: <bytes>,
r_hash: <bytes>,
value: <int64>,
settled: <bool>,
creation_date: <int64>,
settle_date: <int64>,
payment_request: <string>,
description_hash: <bytes>,
expiry: <int64>,
fallback_addr: <string>,
cltv_expiry: <uint64>,
}
gRPC Request: InvoiceSubscription
This request has no parameters.
gRPC Response: Invoice (Streaming)
| Field |
Type |
Label |
Description |
| memo |
string |
optional |
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice’s creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used. |
| receipt |
bytes |
optional |
An optional cryptographic receipt of payment |
| r_preimage |
bytes |
optional |
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage |
| r_hash |
bytes |
optional |
The hash of the preimage |
| value |
int64 |
optional |
The value of this invoice in satoshis |
| settled |
bool |
optional |
Whether this invoice has been fulfilled |
| creation_date |
int64 |
optional |
When this invoice was created |
| settle_date |
int64 |
optional |
When this invoice was settled |
| payment_request |
string |
optional |
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. |
| description_hash |
bytes |
optional |
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. |
| expiry |
int64 |
optional |
Payment request expiry time in seconds. Default is 3600 (1 hour). |
| fallback_addr |
string |
optional |
Fallback on-chain address. |
| cltv_expiry |
uint64 |
optional |
Delta to use for the time-lock of the CLTV extended to the final hop. |
DecodePayReq
Simple RPC
DecodePayReq takes an encoded payment request string and attempts to decode it, returning a full description of the conditions encoded within the payment request.
# Decode the passed payment request revealing the destination, payment hash and value of the payment request
$ lncli decodepayreq [command options] pay_req
# --pay_req value the bech32 encoded payment request
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.PayReqString(
pay_req=<YOUR_PARAM>,
)
>>> response = stub.DecodePayReq(request)
>>> response
{
destination: <string>,
payment_hash: <string>,
num_satoshis: <int64>,
timestamp: <int64>,
expiry: <int64>,
description: <string>,
description_hash: <string>,
fallback_addr: <string>,
cltv_expiry: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.decodePayReq({
pay_req: <YOUR_PARAM>,
}, function(err, response) {
console.log('DecodePayReq: ' + response);
})
{
destination: <string>,
payment_hash: <string>,
num_satoshis: <int64>,
timestamp: <int64>,
expiry: <int64>,
description: <string>,
description_hash: <string>,
fallback_addr: <string>,
cltv_expiry: <int64>,
}
gRPC Request: PayReqString
| Field |
Type |
Label |
Description |
| pay_req |
string |
optional |
The payment request string to be decoded |
gRPC Response: PayReq
| Field |
Type |
Label |
Description |
| destination |
string |
optional |
|
| payment_hash |
string |
optional |
|
| num_satoshis |
int64 |
optional |
|
| timestamp |
int64 |
optional |
|
| expiry |
int64 |
optional |
|
| description |
string |
optional |
|
| description_hash |
string |
optional |
|
| fallback_addr |
string |
optional |
|
| cltv_expiry |
int64 |
optional |
|
ListPayments
Simple RPC
ListPayments returns a list of all outgoing payments.
$ lncli listpayments [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ListPaymentsRequest()
>>> response = stub.ListPayments(request)
>>> response
{
payments: <Payment>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.listPayments({}, function(err, response) {
console.log('ListPayments: ' + response);
})
{
payments: <Payment>,
}
gRPC Request: ListPaymentsRequest
This request has no parameters.
gRPC Response: ListPaymentsResponse
| Field |
Type |
Label |
Description |
| payments |
Payment |
repeated |
The list of payments |
Payment
| Field |
Type |
Label |
Description |
| payment_hash |
string |
optional |
The payment hash |
| value |
int64 |
optional |
The value of the payment in satoshis |
| creation_date |
int64 |
optional |
The date of this payment |
| path |
string |
repeated |
The path this payment took |
| fee |
int64 |
optional |
The fee paid for this payment in satoshis |
| payment_preimage |
string |
optional |
The payment preimage |
DeleteAllPayments
Simple RPC
DeleteAllPayments deletes all outgoing payments from DB.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.DeleteAllPaymentsRequest()
>>> response = stub.DeleteAllPayments(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.deleteAllPayments({}, function(err, response) {
console.log('DeleteAllPayments: ' + response);
})
{}
gRPC Request: DeleteAllPaymentsRequest
This request has no parameters.
gRPC Response: DeleteAllPaymentsResponse
This response is empty.
DescribeGraph
Simple RPC
DescribeGraph returns a description of the latest graph state from the point of view of the node. The graph information is partitioned into two components: all the nodes/vertexes, and all the edges that connect the vertexes themselves. As this is a directed graph, the edges also contain the node directional specific routing policy which includes: the time lock delta, fee information, etc.
# Prints a human readable version of the known channel graph from the PoV of the node
$ lncli describegraph [command options] [arguments...]
# --render If set, then an image of graph will be generated and displayed. The generated image is stored within the current directory with a file name of 'graph.svg'
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ChannelGraphRequest()
>>> response = stub.DescribeGraph(request)
>>> response
{
nodes: <LightningNode>,
edges: <ChannelEdge>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.describeGraph({}, function(err, response) {
console.log('DescribeGraph: ' + response);
})
{
nodes: <LightningNode>,
edges: <ChannelEdge>,
}
gRPC Request: ChannelGraphRequest
This request has no parameters.
gRPC Response: ChannelGraph
Returns a new instance of the directed channel graph.
| Field |
Type |
Label |
Description |
| nodes |
LightningNode |
repeated |
The list of LightningNodes in this channel graph |
| edges |
ChannelEdge |
repeated |
The list of ChannelEdges in this channel graph |
LightningNode
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge.
| Field |
Type |
Label |
Description |
| last_update |
uint32 |
optional |
|
| pub_key |
string |
optional |
|
| alias |
string |
optional |
|
| addresses |
NodeAddress |
repeated |
|
| color |
string |
optional |
|
ChannelEdge
A fully authenticated channel along with all its unique attributes. Once an authenticated channel announcement has been processed on the network, then a instance of ChannelEdgeInfo encapsulating the channels attributes is stored. The other portions relevant to routing policy of a channel are stored within a ChannelEdgePolicy for each direction of the channel.
| Field |
Type |
Label |
Description |
| channel_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
| chan_point |
string |
optional |
|
| last_update |
uint32 |
optional |
|
| node1_pub |
string |
optional |
|
| node2_pub |
string |
optional |
|
| capacity |
int64 |
optional |
|
| node1_policy |
RoutingPolicy |
optional |
|
| node2_policy |
RoutingPolicy |
optional |
|
GetChanInfo
Simple RPC
GetChanInfo returns the latest authenticated network announcement for the given channel identified by its channel ID: an 8-byte integer which uniquely identifies the location of transaction’s funding output within the blockchain.
# Prints out the latest authenticated state for a particular channel
$ lncli getchaninfo [command options] chan_id
# --chan_id value the 8-byte compact channel ID to query for (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ChanInfoRequest(
chan_id=<YOUR_PARAM>,
)
>>> response = stub.GetChanInfo(request)
>>> response
{
channel_id: <uint64>,
chan_point: <string>,
last_update: <uint32>,
node1_pub: <string>,
node2_pub: <string>,
capacity: <int64>,
node1_policy: <RoutingPolicy>,
node2_policy: <RoutingPolicy>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.getChanInfo({
chan_id: <YOUR_PARAM>,
}, function(err, response) {
console.log('GetChanInfo: ' + response);
})
{
channel_id: <uint64>,
chan_point: <string>,
last_update: <uint32>,
node1_pub: <string>,
node2_pub: <string>,
capacity: <int64>,
node1_policy: <RoutingPolicy>,
node2_policy: <RoutingPolicy>,
}
gRPC Request: ChanInfoRequest
| Field |
Type |
Label |
Description |
| chan_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
gRPC Response: ChannelEdge
A fully authenticated channel along with all its unique attributes. Once an authenticated channel announcement has been processed on the network, then a instance of ChannelEdgeInfo encapsulating the channels attributes is stored. The other portions relevant to routing policy of a channel are stored within a ChannelEdgePolicy for each direction of the channel.
| Field |
Type |
Label |
Description |
| channel_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
| chan_point |
string |
optional |
|
| last_update |
uint32 |
optional |
|
| node1_pub |
string |
optional |
|
| node2_pub |
string |
optional |
|
| capacity |
int64 |
optional |
|
| node1_policy |
RoutingPolicy |
optional |
|
| node2_policy |
RoutingPolicy |
optional |
|
RoutingPolicy
| Field |
Type |
Label |
Description |
| time_lock_delta |
uint32 |
optional |
|
| min_htlc |
int64 |
optional |
|
| fee_base_msat |
int64 |
optional |
|
| fee_rate_milli_msat |
int64 |
optional |
|
RoutingPolicy
| Field |
Type |
Label |
Description |
| time_lock_delta |
uint32 |
optional |
|
| min_htlc |
int64 |
optional |
|
| fee_base_msat |
int64 |
optional |
|
| fee_rate_milli_msat |
int64 |
optional |
|
GetNodeInfo
Simple RPC
GetNodeInfo returns the latest advertised, aggregated, and authenticated channel information for the specified node identified by its public key.
# Prints out the latest authenticated node state for an advertised node
$ lncli getnodeinfo [command options] [arguments...]
# --pub_key value the 33-byte hex-encoded compressed public of the target node
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.NodeInfoRequest(
pub_key=<YOUR_PARAM>,
)
>>> response = stub.GetNodeInfo(request)
>>> response
{
node: <LightningNode>,
num_channels: <uint32>,
total_capacity: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.getNodeInfo({
pub_key: <YOUR_PARAM>,
}, function(err, response) {
console.log('GetNodeInfo: ' + response);
})
{
node: <LightningNode>,
num_channels: <uint32>,
total_capacity: <int64>,
}
gRPC Request: NodeInfoRequest
| Field |
Type |
Label |
Description |
| pub_key |
string |
optional |
The 33-byte hex-encoded compressed public of the target node |
gRPC Response: NodeInfo
| Field |
Type |
Label |
Description |
| node |
LightningNode |
optional |
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge. |
| num_channels |
uint32 |
optional |
|
| total_capacity |
int64 |
optional |
|
LightningNode
An individual vertex/node within the channel graph. A node is connected to other nodes by one or more channel edges emanating from it. As the graph is directed, a node will also have an incoming edge attached to it for each outgoing edge.
| Field |
Type |
Label |
Description |
| last_update |
uint32 |
optional |
|
| pub_key |
string |
optional |
|
| alias |
string |
optional |
|
| addresses |
NodeAddress |
repeated |
|
| color |
string |
optional |
|
QueryRoutes
Simple RPC
QueryRoutes attempts to query the daemon’s Channel Router for a possible route to a target destination capable of carrying a specific amount of satoshis. The retuned route contains the full details required to craft and send an HTLC, also including the necessary information that should be present within the Sphinx packet encapsulated within the HTLC.
# Queries the channel router for a potential path to the destination that has sufficient flow for the amount including fees
$ lncli queryroutes [command options] dest amt
# --dest value the 33-byte hex-encoded public key for the payment destination
# --amt value the amount to send expressed in satoshis (default: 0)
# --num_max_routes value the max number of routes to be returned (default: 10) (default: 10)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.QueryRoutesRequest(
pub_key=<YOUR_PARAM>,
amt=<YOUR_PARAM>,
num_routes=<YOUR_PARAM>,
)
>>> response = stub.QueryRoutes(request)
>>> response
{
routes: <Route>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.queryRoutes({
pub_key: <YOUR_PARAM>,
amt: <YOUR_PARAM>,
num_routes: <YOUR_PARAM>,
}, function(err, response) {
console.log('QueryRoutes: ' + response);
})
{
routes: <Route>,
}
gRPC Request: QueryRoutesRequest
| Field |
Type |
Label |
Description |
| pub_key |
string |
optional |
The 33-byte hex-encoded public key for the payment destination |
| amt |
int64 |
optional |
The amount to send expressed in satoshis |
| num_routes |
int32 |
optional |
The max number of routes to return. |
gRPC Response: QueryRoutesResponse
| Field |
Type |
Label |
Description |
| routes |
Route |
repeated |
|
Route
A path through the channel graph which runs over one or more channels in succession. This struct carries all the information required to craft the Sphinx onion packet, and send the payment along the first hop in the path. A route is only selected as valid if all the channels have sufficient capacity to carry the initial payment amount after fees are accounted for.
| Field |
Type |
Label |
Description |
| total_time_lock |
uint32 |
optional |
The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment. |
| total_fees |
int64 |
optional |
The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don’t need to pay a fee it ourself. |
| total_amt |
int64 |
optional |
The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees. |
| hops |
Hop |
repeated |
Contains details concerning the specific forwarding details at each hop. |
GetNetworkInfo
Simple RPC
GetNetworkInfo returns some basic stats about the known channel graph from the point of view of the node.
# Returns a set of statistics pertaining to the known channel graph
$ lncli getnetworkinfo [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.NetworkInfoRequest()
>>> response = stub.GetNetworkInfo(request)
>>> response
{
graph_diameter: <uint32>,
avg_out_degree: <double>,
max_out_degree: <uint32>,
num_nodes: <uint32>,
num_channels: <uint32>,
total_network_capacity: <int64>,
avg_channel_size: <double>,
min_channel_size: <int64>,
max_channel_size: <int64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.getNetworkInfo({}, function(err, response) {
console.log('GetNetworkInfo: ' + response);
})
{
graph_diameter: <uint32>,
avg_out_degree: <double>,
max_out_degree: <uint32>,
num_nodes: <uint32>,
num_channels: <uint32>,
total_network_capacity: <int64>,
avg_channel_size: <double>,
min_channel_size: <int64>,
max_channel_size: <int64>,
}
gRPC Request: NetworkInfoRequest
This request has no parameters.
gRPC Response: NetworkInfo
| Field |
Type |
Label |
Description |
| graph_diameter |
uint32 |
optional |
|
| avg_out_degree |
double |
optional |
|
| max_out_degree |
uint32 |
optional |
|
| num_nodes |
uint32 |
optional |
|
| num_channels |
uint32 |
optional |
|
| total_network_capacity |
int64 |
optional |
|
| avg_channel_size |
double |
optional |
|
| min_channel_size |
int64 |
optional |
|
| max_channel_size |
int64 |
optional |
|
StopDaemon
Simple RPC
StopDaemon will send a shutdown request to the interrupt handler, triggering a graceful shutdown of the daemon.
# Gracefully stop all daemon subsystems before stopping the daemon itself.
# This is equivalent to stopping it using CTRL-C.
$ lncli stop [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.StopRequest()
>>> response = stub.StopDaemon(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.stopDaemon({}, function(err, response) {
console.log('StopDaemon: ' + response);
})
{}
gRPC Request: StopRequest
This request has no parameters.
gRPC Response: StopResponse
This response is empty.
SubscribeChannelGraph
Response-streaming RPC
SubscribeChannelGraph launches a streaming RPC that allows the caller to receive notifications upon any changes to the channel graph topology from the point of view of the responding node. Events notified include: new nodes coming online, nodes updating their authenticated attributes, new channels being advertised, updates in the routing policy for a directional channel edge, and when channels are closed on-chain.
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.GraphTopologySubscription()
>>> for response in stub.SubscribeChannelGraph(request):
# Do something
print response
{
node_updates: <NodeUpdate>,
channel_updates: <ChannelEdgeUpdate>,
closed_chans: <ClosedChannelUpdate>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> var call = lightning.subscribeChannelGraph({})
> call.on('data', function(message) {
console.log(message);
});
> call.on('end', function() {
// The server has finished sending
console.log("END");
});
> call.on('status', function(status) {
// Process status
console.log("Current status: " + status);
});
{
node_updates: <NodeUpdate>,
channel_updates: <ChannelEdgeUpdate>,
closed_chans: <ClosedChannelUpdate>,
}
gRPC Request: GraphTopologySubscription
This request has no parameters.
gRPC Response: GraphTopologyUpdate (Streaming)
| Field |
Type |
Label |
Description |
| node_updates |
NodeUpdate |
repeated |
|
| channel_updates |
ChannelEdgeUpdate |
repeated |
|
| closed_chans |
ClosedChannelUpdate |
repeated |
|
NodeUpdate
| Field |
Type |
Label |
Description |
| addresses |
string |
repeated |
|
| identity_key |
string |
optional |
|
| global_features |
bytes |
optional |
|
| alias |
string |
optional |
|
ChannelEdgeUpdate
| Field |
Type |
Label |
Description |
| chan_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
| chan_point |
ChannelPoint |
optional |
|
| capacity |
int64 |
optional |
|
| routing_policy |
RoutingPolicy |
optional |
|
| advertising_node |
string |
optional |
|
| connecting_node |
string |
optional |
|
ClosedChannelUpdate
| Field |
Type |
Label |
Description |
| chan_id |
uint64 |
optional |
The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel. |
| capacity |
int64 |
optional |
|
| closed_height |
uint32 |
optional |
|
| chan_point |
ChannelPoint |
optional |
|
DebugLevel
Simple RPC
DebugLevel allows a caller to programmatically set the logging verbosity of lnd. The logging can be targeted according to a coarse daemon-wide logging level, or in a granular fashion to specify the logging for a target sub-system.
# Logging level for all subsystems {trace, debug, info, warn, error, critical}
# You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set the log level for individual subsystems
# Use show to list available subsystems
$ lncli debuglevel [command options] [arguments...]
# --show if true, then the list of available sub-systems will be printed out
# --level value the level specification to target either a coarse logging level, or granular set of specific sub-systems with logging levels for each
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.DebugLevelRequest(
show=<YOUR_PARAM>,
level_spec=<YOUR_PARAM>,
)
>>> response = stub.DebugLevel(request)
>>> response
{
sub_systems: <string>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.debugLevel({
show: <YOUR_PARAM>,
level_spec: <YOUR_PARAM>,
}, function(err, response) {
console.log('DebugLevel: ' + response);
})
{
sub_systems: <string>,
}
gRPC Request: DebugLevelRequest
| Field |
Type |
Label |
Description |
| show |
bool |
optional |
|
| level_spec |
string |
optional |
|
gRPC Response: DebugLevelResponse
| Field |
Type |
Label |
Description |
| sub_systems |
string |
optional |
|
FeeReport
Simple RPC
FeeReport allows the caller to obtain a report detailing the current fee schedule enforced by the node globally for each channel.
# Returns the current fee policies of all active channels.
# Fee policies can be updated using the updatechanpolicy command.
$ lncli feereport [arguments...]
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.FeeReportRequest()
>>> response = stub.FeeReport(request)
>>> response
{
channel_fees: <ChannelFeeReport>,
day_fee_sum: <uint64>,
week_fee_sum: <uint64>,
month_fee_sum: <uint64>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.feeReport({}, function(err, response) {
console.log('FeeReport: ' + response);
})
{
channel_fees: <ChannelFeeReport>,
day_fee_sum: <uint64>,
week_fee_sum: <uint64>,
month_fee_sum: <uint64>,
}
gRPC Request: FeeReportRequest
This request has no parameters.
gRPC Response: FeeReportResponse
| Field |
Type |
Label |
Description |
| channel_fees |
ChannelFeeReport |
repeated |
An array of channel fee reports which describes the current fee schedule for each channel. |
| day_fee_sum |
uint64 |
optional |
The total amount of fee revenue (in satoshis) the switch has collected over the past 24 hrs. |
| week_fee_sum |
uint64 |
optional |
The total amount of fee revenue (in satoshis) the switch has collected over the past 1 week. |
| month_fee_sum |
uint64 |
optional |
The total amount of fee revenue (in satoshis) the switch has collected over the past 1 month. |
ChannelFeeReport
| Field |
Type |
Label |
Description |
| chan_point |
string |
optional |
The channel that this fee report belongs to. |
| base_fee_msat |
int64 |
optional |
The base fee charged regardless of the number of milli-satoshis sent. |
| fee_per_mil |
int64 |
optional |
The amount charged per milli-satoshis transferred expressed in millionths of a satoshi. |
| fee_rate |
double |
optional |
The effective fee rate in milli-satoshis. Computed by dividing the fee_per_mil value by 1 million. |
UpdateChannelPolicy
Simple RPC
UpdateChannelPolicy allows the caller to update the fee schedule and channel policies for all channels globally, or a particular channel.
# Updates the channel policy for all channels, or just a particular channel
# identified by its channel point. The update will be committed, and
# broadcast to the rest of the network within the next batch.
# Channel points are encoded as: funding_txid:output_index
$ lncli updatechanpolicy [command options] base_fee_msat fee_rate time_lock_delta [channel_point]
# --base_fee_msat value the base fee in milli-satoshis that will be charged for each forwarded HTLC, regardless of payment size (default: 0)
# --fee_rate value the fee rate that will be charged proportionally based on the value of each forwarded HTLC, the lowest possible rate is 0.000001
# --time_lock_delta value the CLTV delta that will be applied to all forwarded HTLCs (default: 0)
# --chan_point value The channel whose fee policy should be updated, if nil the policies for all channels will be updated. Takes the form of: txid:output_index
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.PolicyUpdateRequest(
global=<YOUR_PARAM>,
chan_point=<YOUR_PARAM>,
base_fee_msat=<YOUR_PARAM>,
fee_rate=<YOUR_PARAM>,
time_lock_delta=<YOUR_PARAM>,
)
>>> response = stub.UpdateChannelPolicy(request)
>>> response
{}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.updateChannelPolicy({
global: <YOUR_PARAM>,
chan_point: <YOUR_PARAM>,
base_fee_msat: <YOUR_PARAM>,
fee_rate: <YOUR_PARAM>,
time_lock_delta: <YOUR_PARAM>,
}, function(err, response) {
console.log('UpdateChannelPolicy: ' + response);
})
{}
gRPC Request: PolicyUpdateRequest
| Field |
Type |
Label |
Description |
| global |
bool |
optional |
If set, then this update applies to all currently active channels. |
| chan_point |
ChannelPoint |
optional |
If set, this update will target a specific channel. |
| base_fee_msat |
int64 |
optional |
The base fee charged regardless of the number of milli-satoshis sent. |
| fee_rate |
double |
optional |
The effective fee rate in milli-satoshis. The precision of this value goes up to 6 decimal places, so 1e-6. |
| time_lock_delta |
uint32 |
optional |
The required timelock delta for HTLCs forwarded over the channel. |
ChannelPoint
| Field |
Type |
Label |
Description |
| funding_txid_bytes |
bytes |
optional |
Txid of the funding transaction |
| funding_txid_str |
string |
optional |
Hex-encoded string representing the funding transaction |
| output_index |
uint32 |
optional |
The index of the output of the funding transaction |
gRPC Response: PolicyUpdateResponse
This response is empty.
ForwardingHistory
Simple RPC
ForwardingHistory allows the caller to query the htlcswitch for a record of all HTLC’s forwarded within the target time range, and integer offset within that time range. If no time-range is specified, then the first chunk of the past 24 hrs of forwarding history are returned. A list of forwarding events are returned. The size of each forwarding event is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB. As a result each message can only contain 50k entries. Each response has the index offset of the last entry. The index offset can be provided to the request to allow the caller to skip a series of records.
# Query the htlc switch's internal forwarding log for all completed
# payment circuits (HTLCs) over a particular time range (--start_time and
# --end_time). The start and end times are meant to be expressed in
# seconds since the Unix epoch. If a start and end time aren't provided,
# then events over the past 24 hours are queried for.
# The max number of events returned is 50k. The default number is 100,
# callers can use the --max_events param to modify this value.
# Finally, callers can skip a series of events using the --index_offset
# parameter. Each response will contain the offset index of the last
# entry. Using this callers can manually paginate within a time slice.
$ lncli fwdinghistory [command options] start_time [end_time] [index_offset] [max_events]
# --start_time value the starting time for the query, expressed in seconds since the unix epoch (default: 0)
# --end_time value the end time for the query, expressed in seconds since the unix epoch (default: 0)
# --index_offset value the number of events to skip (default: 0)
# --max_events value the max number of events to return (default: 0)
>>> import rpc_pb2 as ln, rpc_pb2_grpc as lnrpc
>>> import grpc
>>> cert = open('LND_HOMEDIR/tls.cert').read()
>>> creds = grpc.ssl_channel_credentials(cert)
>>> channel = grpc.secure_channel('localhost:10009', creds)
>>> stub = lnrpc.LightningStub(channel)
>>> request = ln.ForwardingHistoryRequest(
start_time=<YOUR_PARAM>,
end_time=<YOUR_PARAM>,
index_offset=<YOUR_PARAM>,
num_max_events=<YOUR_PARAM>,
)
>>> response = stub.ForwardingHistory(request)
>>> response
{
forwarding_events: <ForwardingEvent>,
last_offset_index: <uint32>,
}
> var grpc = require('grpc');
> var fs = require('fs');
> var lndCert = fs.readFileSync("LND_HOMEDIR/tls.cert");
> var credentials = grpc.credentials.createSsl(lndCert);
> var lnrpcDescriptor = grpc.load("rpc.proto");
> var lnrpc = lnrpcDescriptor.lnrpc;
> var lightning = new lnrpc.Lightning('localhost:10009', credentials);
> call = lightning.forwardingHistory({
start_time: <YOUR_PARAM>,
end_time: <YOUR_PARAM>,
index_offset: <YOUR_PARAM>,
num_max_events: <YOUR_PARAM>,
}, function(err, response) {
console.log('ForwardingHistory: ' + response);
})
{
forwarding_events: <ForwardingEvent>,
last_offset_index: <uint32>,
}
gRPC Request: ForwardingHistoryRequest
| Field |
Type |
Label |
Description |
| start_time |
uint64 |
optional |
Start time is the starting point of the forwarding history request. All records beyond this point will be included, respecting the end time, and the index offset. |
| end_time |
uint64 |
optional |
End time is the end point of the forwarding history request. The response will carry at most 50k records between the start time and the end time. The index offset can be used to implement pagination. |
| index_offset |
uint32 |
optional |
Index offset is the offset in the time series to start at. As each response can only contain 50k records, callers can use this to skip around within a packed time series. |
| num_max_events |
uint32 |
optional |
The max number of events to return in the response to this query. |
gRPC Response: ForwardingHistoryResponse
| Field |
Type |
Label |
Description |
| forwarding_events |
ForwardingEvent |
repeated |
A list of forwarding events from the time slice of the time series specified in the request. |
| last_offset_index |
uint32 |
optional |
The index of the last time in the set of returned forwarding events. Can be used to seek further, pagination style. |
ForwardingEvent
| Field |
Type |
Label |
Description |
| timestamp |
uint64 |
optional |
Timestamp is the time (unix epoch offset) that this circuit was completed. |
| chan_id_in |
uint64 |
optional |
The incoming channel ID that carried the HTLC that created the circuit. |
| chan_id_out |
uint64 |
optional |
The outgoing channel ID that carried the preimage that completed the circuit. |
| amt_in |
uint64 |
optional |
The total amount of the incoming HTLC that created half the circuit. |
| amt_out |
uint64 |
optional |
The total amount of the outgoign HTLC that created the second half of the circuit. |
| fee |
uint64 |
optional |
The total fee that this payment circuit carried. |
