public static final class LightningGrpc.LightningFutureStub extends io.grpc.stub.AbstractFutureStub<LightningGrpc.LightningFutureStub>
Lightning is the main RPC server of the daemon.
Modifier and Type | Method and Description |
---|---|
com.google.common.util.concurrent.ListenableFuture<LightningApi.AbandonChannelResponse> |
abandonChannel(LightningApi.AbandonChannelRequest request)
lncli: `abandonchannel`
AbandonChannel removes all channel state from the database except for a
close summary.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.AddInvoiceResponse> |
addInvoice(LightningApi.Invoice request)
lncli: `addinvoice`
AddInvoice attempts to add a new invoice to the invoice database.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.BakeMacaroonResponse> |
bakeMacaroon(LightningApi.BakeMacaroonRequest request)
lncli: `bakemacaroon`
BakeMacaroon allows the creation of a new macaroon with custom read and
write permissions.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.BatchOpenChannelResponse> |
batchOpenChannel(LightningApi.BatchOpenChannelRequest request)
lncli: `batchopenchannel`
BatchOpenChannel attempts to open multiple single-funded channels in a
single transaction in an atomic way.
|
protected LightningGrpc.LightningFutureStub |
build(io.grpc.Channel channel,
io.grpc.CallOptions callOptions) |
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelBalanceResponse> |
channelBalance(LightningApi.ChannelBalanceRequest request)
lncli: `channelbalance`
ChannelBalance returns a report on the total funds across all open channels,
categorized in local/remote, pending local/remote and unsettled local/remote
balances.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.CheckMacPermResponse> |
checkMacaroonPermissions(LightningApi.CheckMacPermRequest request)
CheckMacaroonPermissions checks whether a request follows the constraints
imposed on the macaroon and that the macaroon is authorized to follow the
provided permissions.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ClosedChannelsResponse> |
closedChannels(LightningApi.ClosedChannelsRequest request)
lncli: `closedchannels`
ClosedChannels returns a description of all the closed channels that
this node was a participant in.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ConnectPeerResponse> |
connectPeer(LightningApi.ConnectPeerRequest request)
lncli: `connect`
ConnectPeer attempts to establish a connection to a remote peer.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.DebugLevelResponse> |
debugLevel(LightningApi.DebugLevelRequest request)
lncli: `debuglevel`
DebugLevel allows a caller to programmatically set the logging verbosity of
lnd.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.PayReq> |
decodePayReq(LightningApi.PayReqString request)
lncli: `decodepayreq`
DecodePayReq takes an encoded payment request string and attempts to decode
it, returning a full description of the conditions encoded within the
payment request.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.DeleteAllPaymentsResponse> |
deleteAllPayments(LightningApi.DeleteAllPaymentsRequest request)
DeleteAllPayments deletes all outgoing payments from DB.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.DeleteMacaroonIDResponse> |
deleteMacaroonID(LightningApi.DeleteMacaroonIDRequest request)
lncli: `deletemacaroonid`
DeleteMacaroonID deletes the specified macaroon ID and invalidates all
macaroons derived from that ID.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.DeletePaymentResponse> |
deletePayment(LightningApi.DeletePaymentRequest request)
DeletePayment deletes an outgoing payment from DB.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelGraph> |
describeGraph(LightningApi.ChannelGraphRequest request)
lncli: `describegraph`
DescribeGraph returns a description of the latest graph state from the
point of view of the node.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.DisconnectPeerResponse> |
disconnectPeer(LightningApi.DisconnectPeerRequest request)
lncli: `disconnect`
DisconnectPeer attempts to disconnect one peer from another identified by a
given pubKey.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.EstimateFeeResponse> |
estimateFee(LightningApi.EstimateFeeRequest request)
lncli: `estimatefee`
EstimateFee asks the chain backend to estimate the fee rate and total fees
for a transaction that pays to multiple specified outputs.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChanBackupSnapshot> |
exportAllChannelBackups(LightningApi.ChanBackupExportRequest request)
ExportAllChannelBackups returns static channel backups for all existing
channels known to lnd.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelBackup> |
exportChannelBackup(LightningApi.ExportChannelBackupRequest request)
lncli: `exportchanbackup`
ExportChannelBackup attempts to return an encrypted static channel backup
for the target channel identified by it channel point.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.FeeReportResponse> |
feeReport(LightningApi.FeeReportRequest request)
lncli: `feereport`
FeeReport allows the caller to obtain a report detailing the current fee
schedule enforced by the node globally for each channel.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ForwardingHistoryResponse> |
forwardingHistory(LightningApi.ForwardingHistoryRequest request)
lncli: `fwdinghistory`
ForwardingHistory allows the caller to query the htlcswitch for a record of
all HTLCs forwarded within the target time range, and integer offset
within that time range, for a maximum number of events.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.FundingStateStepResp> |
fundingStateStep(LightningApi.FundingTransitionMsg request)
FundingStateStep is an advanced funding related call that allows the caller
to either execute some preparatory steps for a funding workflow, or
manually progress a funding workflow.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelEdge> |
getChanInfo(LightningApi.ChanInfoRequest request)
lncli: `getchaninfo`
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.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.GetInfoResponse> |
getInfo(LightningApi.GetInfoRequest request)
lncli: `getinfo`
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.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.NetworkInfo> |
getNetworkInfo(LightningApi.NetworkInfoRequest request)
lncli: `getnetworkinfo`
GetNetworkInfo returns some basic stats about the known channel graph from
the point of view of the node.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.NodeInfo> |
getNodeInfo(LightningApi.NodeInfoRequest request)
lncli: `getnodeinfo`
GetNodeInfo returns the latest advertised, aggregated, and authenticated
channel information for the specified node identified by its public key.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.NodeMetricsResponse> |
getNodeMetrics(LightningApi.NodeMetricsRequest request)
lncli: `getnodemetrics`
GetNodeMetrics returns node metrics calculated from the graph.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.GetRecoveryInfoResponse> |
getRecoveryInfo(LightningApi.GetRecoveryInfoRequest request)
lncli: `getrecoveryinfo`
GetRecoveryInfo returns information concerning the recovery mode including
whether it's in a recovery mode, whether the recovery is finished, and the
progress made so far.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.TransactionDetails> |
getTransactions(LightningApi.GetTransactionsRequest request)
lncli: `listchaintxns`
GetTransactions returns a list describing all the known transactions
relevant to the wallet.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListAliasesResponse> |
listAliases(LightningApi.ListAliasesRequest request)
lncli: `listaliases`
ListAliases returns the set of all aliases that have ever existed with
their confirmed SCID (if it exists) and/or the base SCID (in the case of
zero conf).
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListChannelsResponse> |
listChannels(LightningApi.ListChannelsRequest request)
lncli: `listchannels`
ListChannels returns a description of all the open channels that this node
is a participant in.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListInvoiceResponse> |
listInvoices(LightningApi.ListInvoiceRequest request)
lncli: `listinvoices`
ListInvoices returns a list of all the invoices currently stored within the
database.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListMacaroonIDsResponse> |
listMacaroonIDs(LightningApi.ListMacaroonIDsRequest request)
lncli: `listmacaroonids`
ListMacaroonIDs returns all root key IDs that are in use.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPaymentsResponse> |
listPayments(LightningApi.ListPaymentsRequest request)
lncli: `listpayments`
ListPayments returns a list of all outgoing payments.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPeersResponse> |
listPeers(LightningApi.ListPeersRequest request)
lncli: `listpeers`
ListPeers returns a verbose listing of all currently active peers.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPermissionsResponse> |
listPermissions(LightningApi.ListPermissionsRequest request)
lncli: `listpermissions`
ListPermissions lists all RPC method URIs and their required macaroon
permissions to access them.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ListUnspentResponse> |
listUnspent(LightningApi.ListUnspentRequest request)
lncli: `listunspent`
Deprecated, use walletrpc.ListUnspent instead.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.LookupHtlcResolutionResponse> |
lookupHtlcResolution(LightningApi.LookupHtlcResolutionRequest request)
LookupHtlcResolution retrieves a final htlc resolution from the database.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.Invoice> |
lookupInvoice(LightningApi.PaymentHash request)
lncli: `lookupinvoice`
LookupInvoice attempts to look up an invoice according to its payment hash.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.NewAddressResponse> |
newAddress(LightningApi.NewAddressRequest request)
lncli: `newaddress`
NewAddress creates a new address under control of the local wallet.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelPoint> |
openChannelSync(LightningApi.OpenChannelRequest request)
OpenChannelSync is a synchronous version of the OpenChannel RPC call.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.PendingChannelsResponse> |
pendingChannels(LightningApi.PendingChannelsRequest request)
lncli: `pendingchannels`
PendingChannels returns a list of all the channels that are currently
considered "pending".
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.QueryRoutesResponse> |
queryRoutes(LightningApi.QueryRoutesRequest request)
lncli: `queryroutes`
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.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.RestoreBackupResponse> |
restoreChannelBackups(LightningApi.RestoreChanBackupRequest request)
lncli: `restorechanbackup`
RestoreChannelBackups accepts a set of singular channel backups, or a
single encrypted multi-chan backup and attempts to recover any funds
remaining within the channel.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SendCoinsResponse> |
sendCoins(LightningApi.SendCoinsRequest request)
lncli: `sendcoins`
SendCoins executes a request to send coins to a particular address.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SendCustomMessageResponse> |
sendCustomMessage(LightningApi.SendCustomMessageRequest request)
lncli: `sendcustom`
SendCustomMessage sends a custom peer message.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SendManyResponse> |
sendMany(LightningApi.SendManyRequest request)
lncli: `sendmany`
SendMany handles a request for a transaction that creates multiple specified
outputs in parallel.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SendResponse> |
sendPaymentSync(LightningApi.SendRequest request)
SendPaymentSync is the synchronous non-streaming version of SendPayment.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SendResponse> |
sendToRouteSync(LightningApi.SendToRouteRequest request)
SendToRouteSync is a synchronous version of SendToRoute.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.SignMessageResponse> |
signMessage(LightningApi.SignMessageRequest request)
lncli: `signmessage`
SignMessage signs a message with this node's private key.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.StopResponse> |
stopDaemon(LightningApi.StopRequest request)
lncli: `stop`
StopDaemon will send a shutdown request to the interrupt handler, triggering
a graceful shutdown of the daemon.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.PolicyUpdateResponse> |
updateChannelPolicy(LightningApi.PolicyUpdateRequest request)
lncli: `updatechanpolicy`
UpdateChannelPolicy allows the caller to update the fee schedule and
channel policies for all channels globally, or a particular channel.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.VerifyChanBackupResponse> |
verifyChanBackup(LightningApi.ChanBackupSnapshot request)
VerifyChanBackup allows a caller to verify the integrity of a channel backup
snapshot.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.VerifyMessageResponse> |
verifyMessage(LightningApi.VerifyMessageRequest request)
lncli: `verifymessage`
VerifyMessage verifies a signature over a message and recovers the signer's
public key.
|
com.google.common.util.concurrent.ListenableFuture<LightningApi.WalletBalanceResponse> |
walletBalance(LightningApi.WalletBalanceRequest request)
lncli: `walletbalance`
WalletBalance returns total unspent outputs(confirmed and unconfirmed), all
confirmed unspent outputs and all unconfirmed unspent outputs under control
of the wallet.
|
protected LightningGrpc.LightningFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
build
in class io.grpc.stub.AbstractStub<LightningGrpc.LightningFutureStub>
public com.google.common.util.concurrent.ListenableFuture<LightningApi.WalletBalanceResponse> walletBalance(LightningApi.WalletBalanceRequest request)
lncli: `walletbalance` WalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelBalanceResponse> channelBalance(LightningApi.ChannelBalanceRequest request)
lncli: `channelbalance` ChannelBalance returns a report on the total funds across all open channels, categorized in local/remote, pending local/remote and unsettled local/remote balances.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.TransactionDetails> getTransactions(LightningApi.GetTransactionsRequest request)
lncli: `listchaintxns` GetTransactions returns a list describing all the known transactions relevant to the wallet.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.EstimateFeeResponse> estimateFee(LightningApi.EstimateFeeRequest request)
lncli: `estimatefee` EstimateFee asks the chain backend to estimate the fee rate and total fees for a transaction that pays to multiple specified outputs. When using REST, the `AddrToAmount` map type can be set by appending `&AddrToAmount[<address>]=<amount_to_send>` to the URL. Unfortunately this map type doesn't appear in the REST API documentation because of a bug in the grpc-gateway library.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SendCoinsResponse> sendCoins(LightningApi.SendCoinsRequest request)
lncli: `sendcoins` 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_vbyte are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListUnspentResponse> listUnspent(LightningApi.ListUnspentRequest request)
lncli: `listunspent` Deprecated, use walletrpc.ListUnspent instead. ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SendManyResponse> sendMany(LightningApi.SendManyRequest request)
lncli: `sendmany` SendMany handles a request for a transaction that creates multiple specified outputs in parallel. If neither target_conf, or sat_per_vbyte are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.NewAddressResponse> newAddress(LightningApi.NewAddressRequest request)
lncli: `newaddress` NewAddress creates a new address under control of the local wallet.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SignMessageResponse> signMessage(LightningApi.SignMessageRequest request)
lncli: `signmessage` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.VerifyMessageResponse> verifyMessage(LightningApi.VerifyMessageRequest request)
lncli: `verifymessage` VerifyMessage verifies a signature over a message and recovers the signer's public key. The signature is only deemed valid if the recovered public key corresponds to a node key in the public Lightning network. 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ConnectPeerResponse> connectPeer(LightningApi.ConnectPeerRequest request)
lncli: `connect` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.DisconnectPeerResponse> disconnectPeer(LightningApi.DisconnectPeerRequest request)
lncli: `disconnect` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPeersResponse> listPeers(LightningApi.ListPeersRequest request)
lncli: `listpeers` ListPeers returns a verbose listing of all currently active peers.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.GetInfoResponse> getInfo(LightningApi.GetInfoRequest request)
lncli: `getinfo` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.GetRecoveryInfoResponse> getRecoveryInfo(LightningApi.GetRecoveryInfoRequest request)
lncli: `getrecoveryinfo` GetRecoveryInfo returns information concerning the recovery mode including whether it's in a recovery mode, whether the recovery is finished, and the progress made so far.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.PendingChannelsResponse> pendingChannels(LightningApi.PendingChannelsRequest request)
lncli: `pendingchannels` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListChannelsResponse> listChannels(LightningApi.ListChannelsRequest request)
lncli: `listchannels` ListChannels returns a description of all the open channels that this node is a participant in.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ClosedChannelsResponse> closedChannels(LightningApi.ClosedChannelsRequest request)
lncli: `closedchannels` ClosedChannels returns a description of all the closed channels that this node was a participant in.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelPoint> openChannelSync(LightningApi.OpenChannelRequest request)
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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.BatchOpenChannelResponse> batchOpenChannel(LightningApi.BatchOpenChannelRequest request)
lncli: `batchopenchannel` BatchOpenChannel attempts to open multiple single-funded channels in a single transaction in an atomic way. This means either all channel open requests succeed at once or all attempts are aborted if any of them fail. This is the safer variant of using PSBTs to manually fund a batch of channels through the OpenChannel RPC.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.FundingStateStepResp> fundingStateStep(LightningApi.FundingTransitionMsg request)
FundingStateStep is an advanced funding related call that allows the caller to either execute some preparatory steps for a funding workflow, or manually progress a funding workflow. The primary way a funding flow is identified is via its pending channel ID. As an example, this method can be used to specify that we're expecting a funding flow for a particular pending channel ID, for which we need to use specific parameters. Alternatively, this can be used to interactively drive PSBT signing for funding for partially complete funding transactions.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.AbandonChannelResponse> abandonChannel(LightningApi.AbandonChannelRequest request)
lncli: `abandonchannel` AbandonChannel removes all channel state from the database except for a close summary. This method can be used to get rid of permanently unusable channels due to bugs fixed in newer versions of lnd. This method can also be used to remove externally funded channels where the funding transaction was never broadcast. Only available for non-externally funded channels in dev build.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SendResponse> sendPaymentSync(LightningApi.SendRequest request)
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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SendResponse> sendToRouteSync(LightningApi.SendToRouteRequest request)
SendToRouteSync is a synchronous version of SendToRoute. It Will block until the payment either fails or succeeds.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.AddInvoiceResponse> addInvoice(LightningApi.Invoice request)
lncli: `addinvoice` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListInvoiceResponse> listInvoices(LightningApi.ListInvoiceRequest request)
lncli: `listinvoices` ListInvoices returns a list of all the invoices currently stored within the database. Any active debug invoices are ignored. It has full support for paginated responses, allowing users to query for specific invoices through their add_index. This can be done by using either the first_index_offset or last_index_offset fields included in the response as the index_offset of the next request. By default, the first 100 invoices created will be returned. Backwards pagination is also supported through the Reversed flag.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.Invoice> lookupInvoice(LightningApi.PaymentHash request)
lncli: `lookupinvoice` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.PayReq> decodePayReq(LightningApi.PayReqString request)
lncli: `decodepayreq` DecodePayReq takes an encoded payment request string and attempts to decode it, returning a full description of the conditions encoded within the payment request.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPaymentsResponse> listPayments(LightningApi.ListPaymentsRequest request)
lncli: `listpayments` ListPayments returns a list of all outgoing payments.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.DeletePaymentResponse> deletePayment(LightningApi.DeletePaymentRequest request)
DeletePayment deletes an outgoing payment from DB. Note that it will not attempt to delete an In-Flight payment, since that would be unsafe.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.DeleteAllPaymentsResponse> deleteAllPayments(LightningApi.DeleteAllPaymentsRequest request)
DeleteAllPayments deletes all outgoing payments from DB. Note that it will not attempt to delete In-Flight payments, since that would be unsafe.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelGraph> describeGraph(LightningApi.ChannelGraphRequest request)
lncli: `describegraph` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.NodeMetricsResponse> getNodeMetrics(LightningApi.NodeMetricsRequest request)
lncli: `getnodemetrics` GetNodeMetrics returns node metrics calculated from the graph. Currently the only supported metric is betweenness centrality of individual nodes.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelEdge> getChanInfo(LightningApi.ChanInfoRequest request)
lncli: `getchaninfo` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.NodeInfo> getNodeInfo(LightningApi.NodeInfoRequest request)
lncli: `getnodeinfo` GetNodeInfo returns the latest advertised, aggregated, and authenticated channel information for the specified node identified by its public key.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.QueryRoutesResponse> queryRoutes(LightningApi.QueryRoutesRequest request)
lncli: `queryroutes` 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 returned 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. When using REST, the `dest_custom_records` map type can be set by appending `&dest_custom_records[<record_number>]=<record_data_base64_url_encoded>` to the URL. Unfortunately this map type doesn't appear in the REST API documentation because of a bug in the grpc-gateway library.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.NetworkInfo> getNetworkInfo(LightningApi.NetworkInfoRequest request)
lncli: `getnetworkinfo` GetNetworkInfo returns some basic stats about the known channel graph from the point of view of the node.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.StopResponse> stopDaemon(LightningApi.StopRequest request)
lncli: `stop` StopDaemon will send a shutdown request to the interrupt handler, triggering a graceful shutdown of the daemon.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.DebugLevelResponse> debugLevel(LightningApi.DebugLevelRequest request)
lncli: `debuglevel` 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.FeeReportResponse> feeReport(LightningApi.FeeReportRequest request)
lncli: `feereport` FeeReport allows the caller to obtain a report detailing the current fee schedule enforced by the node globally for each channel.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.PolicyUpdateResponse> updateChannelPolicy(LightningApi.PolicyUpdateRequest request)
lncli: `updatechanpolicy` UpdateChannelPolicy allows the caller to update the fee schedule and channel policies for all channels globally, or a particular channel.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ForwardingHistoryResponse> forwardingHistory(LightningApi.ForwardingHistoryRequest request)
lncli: `fwdinghistory` ForwardingHistory allows the caller to query the htlcswitch for a record of all HTLCs forwarded within the target time range, and integer offset within that time range, for a maximum number of events. If no maximum number of events is specified, up to 100 events will be returned. If no time-range is specified, then events will be returned in the order that they occured. 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.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChannelBackup> exportChannelBackup(LightningApi.ExportChannelBackupRequest request)
lncli: `exportchanbackup` ExportChannelBackup attempts to return an encrypted static channel backup for the target channel identified by it channel point. The backup is encrypted with a key generated from the aezeed seed of the user. The returned backup can either be restored using the RestoreChannelBackup method once lnd is running, or via the InitWallet and UnlockWallet methods from the WalletUnlocker service.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ChanBackupSnapshot> exportAllChannelBackups(LightningApi.ChanBackupExportRequest request)
ExportAllChannelBackups returns static channel backups for all existing channels known to lnd. A set of regular singular static channel backups for each channel are returned. Additionally, a multi-channel backup is returned as well, which contains a single encrypted blob containing the backups of each channel.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.VerifyChanBackupResponse> verifyChanBackup(LightningApi.ChanBackupSnapshot request)
VerifyChanBackup allows a caller to verify the integrity of a channel backup snapshot. This method will accept either a packed Single or a packed Multi. Specifying both will result in an error.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.RestoreBackupResponse> restoreChannelBackups(LightningApi.RestoreChanBackupRequest request)
lncli: `restorechanbackup` RestoreChannelBackups accepts a set of singular channel backups, or a single encrypted multi-chan backup and attempts to recover any funds remaining within the channel. If we are able to unpack the backup, then the new channel will be shown under listchannels, as well as pending channels.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.BakeMacaroonResponse> bakeMacaroon(LightningApi.BakeMacaroonRequest request)
lncli: `bakemacaroon` BakeMacaroon allows the creation of a new macaroon with custom read and write permissions. No first-party caveats are added since this can be done offline.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListMacaroonIDsResponse> listMacaroonIDs(LightningApi.ListMacaroonIDsRequest request)
lncli: `listmacaroonids` ListMacaroonIDs returns all root key IDs that are in use.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.DeleteMacaroonIDResponse> deleteMacaroonID(LightningApi.DeleteMacaroonIDRequest request)
lncli: `deletemacaroonid` DeleteMacaroonID deletes the specified macaroon ID and invalidates all macaroons derived from that ID.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListPermissionsResponse> listPermissions(LightningApi.ListPermissionsRequest request)
lncli: `listpermissions` ListPermissions lists all RPC method URIs and their required macaroon permissions to access them.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.CheckMacPermResponse> checkMacaroonPermissions(LightningApi.CheckMacPermRequest request)
CheckMacaroonPermissions checks whether a request follows the constraints imposed on the macaroon and that the macaroon is authorized to follow the provided permissions.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.SendCustomMessageResponse> sendCustomMessage(LightningApi.SendCustomMessageRequest request)
lncli: `sendcustom` SendCustomMessage sends a custom peer message.
public com.google.common.util.concurrent.ListenableFuture<LightningApi.ListAliasesResponse> listAliases(LightningApi.ListAliasesRequest request)
lncli: `listaliases` ListAliases returns the set of all aliases that have ever existed with their confirmed SCID (if it exists) and/or the base SCID (in the case of zero conf).
public com.google.common.util.concurrent.ListenableFuture<LightningApi.LookupHtlcResolutionResponse> lookupHtlcResolution(LightningApi.LookupHtlcResolutionRequest request)
LookupHtlcResolution retrieves a final htlc resolution from the database. If the htlc has no final resolution yet, a NotFound grpc status code is returned.