public static interface LightningGrpc.AsyncService
Lightning is the main RPC server of the daemon.
| Modifier and Type | Method and Description |
|---|---|
default void |
abandonChannel(LightningApi.AbandonChannelRequest request,
io.grpc.stub.StreamObserver<LightningApi.AbandonChannelResponse> responseObserver)
lncli: `abandonchannel`
AbandonChannel removes all channel state from the database except for a
close summary.
|
default void |
addInvoice(LightningApi.Invoice request,
io.grpc.stub.StreamObserver<LightningApi.AddInvoiceResponse> responseObserver)
lncli: `addinvoice`
AddInvoice attempts to add a new invoice to the invoice database.
|
default void |
bakeMacaroon(LightningApi.BakeMacaroonRequest request,
io.grpc.stub.StreamObserver<LightningApi.BakeMacaroonResponse> responseObserver)
lncli: `bakemacaroon`
BakeMacaroon allows the creation of a new macaroon with custom read and
write permissions.
|
default void |
batchOpenChannel(LightningApi.BatchOpenChannelRequest request,
io.grpc.stub.StreamObserver<LightningApi.BatchOpenChannelResponse> responseObserver)
lncli: `batchopenchannel`
BatchOpenChannel attempts to open multiple single-funded channels in a
single transaction in an atomic way.
|
default io.grpc.stub.StreamObserver<LightningApi.ChannelAcceptResponse> |
channelAcceptor(io.grpc.stub.StreamObserver<LightningApi.ChannelAcceptRequest> responseObserver)
ChannelAcceptor dispatches a bi-directional streaming RPC in which
OpenChannel requests are sent to the client and the client responds with
a boolean that tells LND whether or not to accept the channel.
|
default void |
channelBalance(LightningApi.ChannelBalanceRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChannelBalanceResponse> responseObserver)
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.
|
default void |
checkMacaroonPermissions(LightningApi.CheckMacPermRequest request,
io.grpc.stub.StreamObserver<LightningApi.CheckMacPermResponse> responseObserver)
CheckMacaroonPermissions checks whether a request follows the constraints
imposed on the macaroon and that the macaroon is authorized to follow the
provided permissions.
|
default void |
closeChannel(LightningApi.CloseChannelRequest request,
io.grpc.stub.StreamObserver<LightningApi.CloseStatusUpdate> responseObserver)
lncli: `closechannel`
CloseChannel attempts to close an active channel identified by its channel
outpoint (ChannelPoint).
|
default void |
closedChannels(LightningApi.ClosedChannelsRequest request,
io.grpc.stub.StreamObserver<LightningApi.ClosedChannelsResponse> responseObserver)
lncli: `closedchannels`
ClosedChannels returns a description of all the closed channels that
this node was a participant in.
|
default void |
connectPeer(LightningApi.ConnectPeerRequest request,
io.grpc.stub.StreamObserver<LightningApi.ConnectPeerResponse> responseObserver)
lncli: `connect`
ConnectPeer attempts to establish a connection to a remote peer.
|
default void |
debugLevel(LightningApi.DebugLevelRequest request,
io.grpc.stub.StreamObserver<LightningApi.DebugLevelResponse> responseObserver)
lncli: `debuglevel`
DebugLevel allows a caller to programmatically set the logging verbosity of
lnd.
|
default void |
decodePayReq(LightningApi.PayReqString request,
io.grpc.stub.StreamObserver<LightningApi.PayReq> responseObserver)
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.
|
default void |
deleteAllPayments(LightningApi.DeleteAllPaymentsRequest request,
io.grpc.stub.StreamObserver<LightningApi.DeleteAllPaymentsResponse> responseObserver)
DeleteAllPayments deletes all outgoing payments from DB.
|
default void |
deleteMacaroonID(LightningApi.DeleteMacaroonIDRequest request,
io.grpc.stub.StreamObserver<LightningApi.DeleteMacaroonIDResponse> responseObserver)
lncli: `deletemacaroonid`
DeleteMacaroonID deletes the specified macaroon ID and invalidates all
macaroons derived from that ID.
|
default void |
deletePayment(LightningApi.DeletePaymentRequest request,
io.grpc.stub.StreamObserver<LightningApi.DeletePaymentResponse> responseObserver)
DeletePayment deletes an outgoing payment from DB.
|
default void |
describeGraph(LightningApi.ChannelGraphRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChannelGraph> responseObserver)
lncli: `describegraph`
DescribeGraph returns a description of the latest graph state from the
point of view of the node.
|
default void |
disconnectPeer(LightningApi.DisconnectPeerRequest request,
io.grpc.stub.StreamObserver<LightningApi.DisconnectPeerResponse> responseObserver)
lncli: `disconnect`
DisconnectPeer attempts to disconnect one peer from another identified by a
given pubKey.
|
default void |
estimateFee(LightningApi.EstimateFeeRequest request,
io.grpc.stub.StreamObserver<LightningApi.EstimateFeeResponse> responseObserver)
lncli: `estimatefee`
EstimateFee asks the chain backend to estimate the fee rate and total fees
for a transaction that pays to multiple specified outputs.
|
default void |
exportAllChannelBackups(LightningApi.ChanBackupExportRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChanBackupSnapshot> responseObserver)
ExportAllChannelBackups returns static channel backups for all existing
channels known to lnd.
|
default void |
exportChannelBackup(LightningApi.ExportChannelBackupRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChannelBackup> responseObserver)
lncli: `exportchanbackup`
ExportChannelBackup attempts to return an encrypted static channel backup
for the target channel identified by it channel point.
|
default void |
feeReport(LightningApi.FeeReportRequest request,
io.grpc.stub.StreamObserver<LightningApi.FeeReportResponse> responseObserver)
lncli: `feereport`
FeeReport allows the caller to obtain a report detailing the current fee
schedule enforced by the node globally for each channel.
|
default void |
forwardingHistory(LightningApi.ForwardingHistoryRequest request,
io.grpc.stub.StreamObserver<LightningApi.ForwardingHistoryResponse> responseObserver)
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.
|
default void |
fundingStateStep(LightningApi.FundingTransitionMsg request,
io.grpc.stub.StreamObserver<LightningApi.FundingStateStepResp> responseObserver)
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.
|
default void |
getChanInfo(LightningApi.ChanInfoRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChannelEdge> responseObserver)
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.
|
default void |
getInfo(LightningApi.GetInfoRequest request,
io.grpc.stub.StreamObserver<LightningApi.GetInfoResponse> responseObserver)
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.
|
default void |
getNetworkInfo(LightningApi.NetworkInfoRequest request,
io.grpc.stub.StreamObserver<LightningApi.NetworkInfo> responseObserver)
lncli: `getnetworkinfo`
GetNetworkInfo returns some basic stats about the known channel graph from
the point of view of the node.
|
default void |
getNodeInfo(LightningApi.NodeInfoRequest request,
io.grpc.stub.StreamObserver<LightningApi.NodeInfo> responseObserver)
lncli: `getnodeinfo`
GetNodeInfo returns the latest advertised, aggregated, and authenticated
channel information for the specified node identified by its public key.
|
default void |
getNodeMetrics(LightningApi.NodeMetricsRequest request,
io.grpc.stub.StreamObserver<LightningApi.NodeMetricsResponse> responseObserver)
lncli: `getnodemetrics`
GetNodeMetrics returns node metrics calculated from the graph.
|
default void |
getRecoveryInfo(LightningApi.GetRecoveryInfoRequest request,
io.grpc.stub.StreamObserver<LightningApi.GetRecoveryInfoResponse> responseObserver)
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.
|
default void |
getTransactions(LightningApi.GetTransactionsRequest request,
io.grpc.stub.StreamObserver<LightningApi.TransactionDetails> responseObserver)
lncli: `listchaintxns`
GetTransactions returns a list describing all the known transactions
relevant to the wallet.
|
default void |
listAliases(LightningApi.ListAliasesRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListAliasesResponse> responseObserver)
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).
|
default void |
listChannels(LightningApi.ListChannelsRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListChannelsResponse> responseObserver)
lncli: `listchannels`
ListChannels returns a description of all the open channels that this node
is a participant in.
|
default void |
listInvoices(LightningApi.ListInvoiceRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListInvoiceResponse> responseObserver)
lncli: `listinvoices`
ListInvoices returns a list of all the invoices currently stored within the
database.
|
default void |
listMacaroonIDs(LightningApi.ListMacaroonIDsRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListMacaroonIDsResponse> responseObserver)
lncli: `listmacaroonids`
ListMacaroonIDs returns all root key IDs that are in use.
|
default void |
listPayments(LightningApi.ListPaymentsRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListPaymentsResponse> responseObserver)
lncli: `listpayments`
ListPayments returns a list of all outgoing payments.
|
default void |
listPeers(LightningApi.ListPeersRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListPeersResponse> responseObserver)
lncli: `listpeers`
ListPeers returns a verbose listing of all currently active peers.
|
default void |
listPermissions(LightningApi.ListPermissionsRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListPermissionsResponse> responseObserver)
lncli: `listpermissions`
ListPermissions lists all RPC method URIs and their required macaroon
permissions to access them.
|
default void |
listUnspent(LightningApi.ListUnspentRequest request,
io.grpc.stub.StreamObserver<LightningApi.ListUnspentResponse> responseObserver)
lncli: `listunspent`
Deprecated, use walletrpc.ListUnspent instead.
|
default void |
lookupHtlcResolution(LightningApi.LookupHtlcResolutionRequest request,
io.grpc.stub.StreamObserver<LightningApi.LookupHtlcResolutionResponse> responseObserver)
LookupHtlcResolution retrieves a final htlc resolution from the database.
|
default void |
lookupInvoice(LightningApi.PaymentHash request,
io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)
lncli: `lookupinvoice`
LookupInvoice attempts to look up an invoice according to its payment hash.
|
default void |
newAddress(LightningApi.NewAddressRequest request,
io.grpc.stub.StreamObserver<LightningApi.NewAddressResponse> responseObserver)
lncli: `newaddress`
NewAddress creates a new address under control of the local wallet.
|
default void |
openChannel(LightningApi.OpenChannelRequest request,
io.grpc.stub.StreamObserver<LightningApi.OpenStatusUpdate> responseObserver)
lncli: `openchannel`
OpenChannel attempts to open a singly funded channel specified in the
request to a remote peer.
|
default void |
openChannelSync(LightningApi.OpenChannelRequest request,
io.grpc.stub.StreamObserver<LightningApi.ChannelPoint> responseObserver)
OpenChannelSync is a synchronous version of the OpenChannel RPC call.
|
default void |
pendingChannels(LightningApi.PendingChannelsRequest request,
io.grpc.stub.StreamObserver<LightningApi.PendingChannelsResponse> responseObserver)
lncli: `pendingchannels`
PendingChannels returns a list of all the channels that are currently
considered "pending".
|
default void |
queryRoutes(LightningApi.QueryRoutesRequest request,
io.grpc.stub.StreamObserver<LightningApi.QueryRoutesResponse> responseObserver)
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.
|
default io.grpc.stub.StreamObserver<LightningApi.RPCMiddlewareResponse> |
registerRPCMiddleware(io.grpc.stub.StreamObserver<LightningApi.RPCMiddlewareRequest> responseObserver)
RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain.
|
default void |
restoreChannelBackups(LightningApi.RestoreChanBackupRequest request,
io.grpc.stub.StreamObserver<LightningApi.RestoreBackupResponse> responseObserver)
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.
|
default void |
sendCoins(LightningApi.SendCoinsRequest request,
io.grpc.stub.StreamObserver<LightningApi.SendCoinsResponse> responseObserver)
lncli: `sendcoins`
SendCoins executes a request to send coins to a particular address.
|
default void |
sendCustomMessage(LightningApi.SendCustomMessageRequest request,
io.grpc.stub.StreamObserver<LightningApi.SendCustomMessageResponse> responseObserver)
lncli: `sendcustom`
SendCustomMessage sends a custom peer message.
|
default void |
sendMany(LightningApi.SendManyRequest request,
io.grpc.stub.StreamObserver<LightningApi.SendManyResponse> responseObserver)
lncli: `sendmany`
SendMany handles a request for a transaction that creates multiple specified
outputs in parallel.
|
default io.grpc.stub.StreamObserver<LightningApi.SendRequest> |
sendPayment(io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
Deprecated.
|
default void |
sendPaymentSync(LightningApi.SendRequest request,
io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
SendPaymentSync is the synchronous non-streaming version of SendPayment.
|
default io.grpc.stub.StreamObserver<LightningApi.SendToRouteRequest> |
sendToRoute(io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
Deprecated.
|
default void |
sendToRouteSync(LightningApi.SendToRouteRequest request,
io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
SendToRouteSync is a synchronous version of SendToRoute.
|
default void |
signMessage(LightningApi.SignMessageRequest request,
io.grpc.stub.StreamObserver<LightningApi.SignMessageResponse> responseObserver)
lncli: `signmessage`
SignMessage signs a message with this node's private key.
|
default void |
stopDaemon(LightningApi.StopRequest request,
io.grpc.stub.StreamObserver<LightningApi.StopResponse> responseObserver)
lncli: `stop`
StopDaemon will send a shutdown request to the interrupt handler, triggering
a graceful shutdown of the daemon.
|
default void |
subscribeChannelBackups(LightningApi.ChannelBackupSubscription request,
io.grpc.stub.StreamObserver<LightningApi.ChanBackupSnapshot> responseObserver)
SubscribeChannelBackups allows a client to sub-subscribe to the most up to
date information concerning the state of all channel backups.
|
default void |
subscribeChannelEvents(LightningApi.ChannelEventSubscription request,
io.grpc.stub.StreamObserver<LightningApi.ChannelEventUpdate> responseObserver)
SubscribeChannelEvents creates a uni-directional stream from the server to
the client in which any updates relevant to the state of the channels are
sent over.
|
default void |
subscribeChannelGraph(LightningApi.GraphTopologySubscription request,
io.grpc.stub.StreamObserver<LightningApi.GraphTopologyUpdate> responseObserver)
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.
|
default void |
subscribeCustomMessages(LightningApi.SubscribeCustomMessagesRequest request,
io.grpc.stub.StreamObserver<LightningApi.CustomMessage> responseObserver)
lncli: `subscribecustom`
SubscribeCustomMessages subscribes to a stream of incoming custom peer
messages.
|
default void |
subscribeInvoices(LightningApi.InvoiceSubscription request,
io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)
SubscribeInvoices returns a uni-directional stream (server -> client) for
notifying the client of newly added/settled invoices.
|
default void |
subscribePeerEvents(LightningApi.PeerEventSubscription request,
io.grpc.stub.StreamObserver<LightningApi.PeerEvent> responseObserver)
SubscribePeerEvents creates a uni-directional stream from the server to
the client in which any events relevant to the state of peers are sent
over.
|
default void |
subscribeTransactions(LightningApi.GetTransactionsRequest request,
io.grpc.stub.StreamObserver<LightningApi.Transaction> responseObserver)
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.
|
default void |
updateChannelPolicy(LightningApi.PolicyUpdateRequest request,
io.grpc.stub.StreamObserver<LightningApi.PolicyUpdateResponse> responseObserver)
lncli: `updatechanpolicy`
UpdateChannelPolicy allows the caller to update the fee schedule and
channel policies for all channels globally, or a particular channel.
|
default void |
verifyChanBackup(LightningApi.ChanBackupSnapshot request,
io.grpc.stub.StreamObserver<LightningApi.VerifyChanBackupResponse> responseObserver)
VerifyChanBackup allows a caller to verify the integrity of a channel backup
snapshot.
|
default void |
verifyMessage(LightningApi.VerifyMessageRequest request,
io.grpc.stub.StreamObserver<LightningApi.VerifyMessageResponse> responseObserver)
lncli: `verifymessage`
VerifyMessage verifies a signature over a message and recovers the signer's
public key.
|
default void |
walletBalance(LightningApi.WalletBalanceRequest request,
io.grpc.stub.StreamObserver<LightningApi.WalletBalanceResponse> responseObserver)
lncli: `walletbalance`
WalletBalance returns total unspent outputs(confirmed and unconfirmed), all
confirmed unspent outputs and all unconfirmed unspent outputs under control
of the wallet.
|
default void walletBalance(LightningApi.WalletBalanceRequest request, io.grpc.stub.StreamObserver<LightningApi.WalletBalanceResponse> responseObserver)
lncli: `walletbalance` WalletBalance returns total unspent outputs(confirmed and unconfirmed), all confirmed unspent outputs and all unconfirmed unspent outputs under control of the wallet.
default void channelBalance(LightningApi.ChannelBalanceRequest request, io.grpc.stub.StreamObserver<LightningApi.ChannelBalanceResponse> responseObserver)
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.
default void getTransactions(LightningApi.GetTransactionsRequest request, io.grpc.stub.StreamObserver<LightningApi.TransactionDetails> responseObserver)
lncli: `listchaintxns` GetTransactions returns a list describing all the known transactions relevant to the wallet.
default void estimateFee(LightningApi.EstimateFeeRequest request, io.grpc.stub.StreamObserver<LightningApi.EstimateFeeResponse> responseObserver)
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.
default void sendCoins(LightningApi.SendCoinsRequest request, io.grpc.stub.StreamObserver<LightningApi.SendCoinsResponse> responseObserver)
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.
default void listUnspent(LightningApi.ListUnspentRequest request, io.grpc.stub.StreamObserver<LightningApi.ListUnspentResponse> responseObserver)
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.
default void subscribeTransactions(LightningApi.GetTransactionsRequest request, io.grpc.stub.StreamObserver<LightningApi.Transaction> responseObserver)
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.
default void sendMany(LightningApi.SendManyRequest request, io.grpc.stub.StreamObserver<LightningApi.SendManyResponse> responseObserver)
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.
default void newAddress(LightningApi.NewAddressRequest request, io.grpc.stub.StreamObserver<LightningApi.NewAddressResponse> responseObserver)
lncli: `newaddress` NewAddress creates a new address under control of the local wallet.
default void signMessage(LightningApi.SignMessageRequest request, io.grpc.stub.StreamObserver<LightningApi.SignMessageResponse> responseObserver)
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.
default void verifyMessage(LightningApi.VerifyMessageRequest request, io.grpc.stub.StreamObserver<LightningApi.VerifyMessageResponse> responseObserver)
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.
default void connectPeer(LightningApi.ConnectPeerRequest request, io.grpc.stub.StreamObserver<LightningApi.ConnectPeerResponse> responseObserver)
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.
default void disconnectPeer(LightningApi.DisconnectPeerRequest request, io.grpc.stub.StreamObserver<LightningApi.DisconnectPeerResponse> responseObserver)
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.
default void listPeers(LightningApi.ListPeersRequest request, io.grpc.stub.StreamObserver<LightningApi.ListPeersResponse> responseObserver)
lncli: `listpeers` ListPeers returns a verbose listing of all currently active peers.
default void subscribePeerEvents(LightningApi.PeerEventSubscription request, io.grpc.stub.StreamObserver<LightningApi.PeerEvent> responseObserver)
SubscribePeerEvents creates a uni-directional stream from the server to the client in which any events relevant to the state of peers are sent over. Events include peers going online and offline.
default void getInfo(LightningApi.GetInfoRequest request, io.grpc.stub.StreamObserver<LightningApi.GetInfoResponse> responseObserver)
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.
default void getRecoveryInfo(LightningApi.GetRecoveryInfoRequest request, io.grpc.stub.StreamObserver<LightningApi.GetRecoveryInfoResponse> responseObserver)
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.
default void pendingChannels(LightningApi.PendingChannelsRequest request, io.grpc.stub.StreamObserver<LightningApi.PendingChannelsResponse> responseObserver)
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.
default void listChannels(LightningApi.ListChannelsRequest request, io.grpc.stub.StreamObserver<LightningApi.ListChannelsResponse> responseObserver)
lncli: `listchannels` ListChannels returns a description of all the open channels that this node is a participant in.
default void subscribeChannelEvents(LightningApi.ChannelEventSubscription request, io.grpc.stub.StreamObserver<LightningApi.ChannelEventUpdate> responseObserver)
SubscribeChannelEvents creates a uni-directional stream from the server to the client in which any updates relevant to the state of the channels are sent over. Events include new active channels, inactive channels, and closed channels.
default void closedChannels(LightningApi.ClosedChannelsRequest request, io.grpc.stub.StreamObserver<LightningApi.ClosedChannelsResponse> responseObserver)
lncli: `closedchannels` ClosedChannels returns a description of all the closed channels that this node was a participant in.
default void openChannelSync(LightningApi.OpenChannelRequest request, io.grpc.stub.StreamObserver<LightningApi.ChannelPoint> responseObserver)
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.
default void openChannel(LightningApi.OpenChannelRequest request, io.grpc.stub.StreamObserver<LightningApi.OpenStatusUpdate> responseObserver)
lncli: `openchannel` 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. Each OpenStatusUpdate will return the pending channel ID of the in-progress channel. Depending on the arguments specified in the OpenChannelRequest, this pending channel ID can then be used to manually progress the channel funding flow.
default void batchOpenChannel(LightningApi.BatchOpenChannelRequest request, io.grpc.stub.StreamObserver<LightningApi.BatchOpenChannelResponse> responseObserver)
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.
default void fundingStateStep(LightningApi.FundingTransitionMsg request, io.grpc.stub.StreamObserver<LightningApi.FundingStateStepResp> responseObserver)
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.
default io.grpc.stub.StreamObserver<LightningApi.ChannelAcceptResponse> channelAcceptor(io.grpc.stub.StreamObserver<LightningApi.ChannelAcceptRequest> responseObserver)
ChannelAcceptor dispatches a bi-directional streaming RPC in which OpenChannel requests are sent to the client and the client responds with a boolean that tells LND whether or not to accept the channel. This allows node operators to specify their own criteria for accepting inbound channels through a single persistent connection.
default void closeChannel(LightningApi.CloseChannelRequest request, io.grpc.stub.StreamObserver<LightningApi.CloseStatusUpdate> responseObserver)
lncli: `closechannel` 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.
default void abandonChannel(LightningApi.AbandonChannelRequest request, io.grpc.stub.StreamObserver<LightningApi.AbandonChannelResponse> responseObserver)
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.
@Deprecated default io.grpc.stub.StreamObserver<LightningApi.SendRequest> sendPayment(io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
lncli: `sendpayment` Deprecated, use routerrpc.SendPaymentV2. 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.
default void sendPaymentSync(LightningApi.SendRequest request, io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
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.
@Deprecated default io.grpc.stub.StreamObserver<LightningApi.SendToRouteRequest> sendToRoute(io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
lncli: `sendtoroute` Deprecated, use routerrpc.SendToRouteV2. SendToRoute is a bi-directional streaming RPC for sending payment through the Lightning Network. This method differs from SendPayment in that it allows users to specify a full route manually. This can be used for things like rebalancing, and atomic swaps.
default void sendToRouteSync(LightningApi.SendToRouteRequest request, io.grpc.stub.StreamObserver<LightningApi.SendResponse> responseObserver)
SendToRouteSync is a synchronous version of SendToRoute. It Will block until the payment either fails or succeeds.
default void addInvoice(LightningApi.Invoice request, io.grpc.stub.StreamObserver<LightningApi.AddInvoiceResponse> responseObserver)
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.
default void listInvoices(LightningApi.ListInvoiceRequest request, io.grpc.stub.StreamObserver<LightningApi.ListInvoiceResponse> responseObserver)
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.
default void lookupInvoice(LightningApi.PaymentHash request, io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)
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.
default void subscribeInvoices(LightningApi.InvoiceSubscription request, io.grpc.stub.StreamObserver<LightningApi.Invoice> responseObserver)
SubscribeInvoices returns a uni-directional stream (server -> client) for notifying the client of newly added/settled invoices. The caller can optionally specify the add_index and/or the settle_index. If the add_index is specified, then we'll first start by sending add invoice events for all invoices with an add_index greater than the specified value. If the settle_index is specified, the next, we'll send out all settle events for invoices with a settle_index greater than the specified value. One or both of these fields can be set. If no fields are set, then we'll only send out the latest add/settle events.
default void decodePayReq(LightningApi.PayReqString request, io.grpc.stub.StreamObserver<LightningApi.PayReq> responseObserver)
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.
default void listPayments(LightningApi.ListPaymentsRequest request, io.grpc.stub.StreamObserver<LightningApi.ListPaymentsResponse> responseObserver)
lncli: `listpayments` ListPayments returns a list of all outgoing payments.
default void deletePayment(LightningApi.DeletePaymentRequest request, io.grpc.stub.StreamObserver<LightningApi.DeletePaymentResponse> responseObserver)
DeletePayment deletes an outgoing payment from DB. Note that it will not attempt to delete an In-Flight payment, since that would be unsafe.
default void deleteAllPayments(LightningApi.DeleteAllPaymentsRequest request, io.grpc.stub.StreamObserver<LightningApi.DeleteAllPaymentsResponse> responseObserver)
DeleteAllPayments deletes all outgoing payments from DB. Note that it will not attempt to delete In-Flight payments, since that would be unsafe.
default void describeGraph(LightningApi.ChannelGraphRequest request, io.grpc.stub.StreamObserver<LightningApi.ChannelGraph> responseObserver)
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.
default void getNodeMetrics(LightningApi.NodeMetricsRequest request, io.grpc.stub.StreamObserver<LightningApi.NodeMetricsResponse> responseObserver)
lncli: `getnodemetrics` GetNodeMetrics returns node metrics calculated from the graph. Currently the only supported metric is betweenness centrality of individual nodes.
default void getChanInfo(LightningApi.ChanInfoRequest request, io.grpc.stub.StreamObserver<LightningApi.ChannelEdge> responseObserver)
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.
default void getNodeInfo(LightningApi.NodeInfoRequest request, io.grpc.stub.StreamObserver<LightningApi.NodeInfo> responseObserver)
lncli: `getnodeinfo` GetNodeInfo returns the latest advertised, aggregated, and authenticated channel information for the specified node identified by its public key.
default void queryRoutes(LightningApi.QueryRoutesRequest request, io.grpc.stub.StreamObserver<LightningApi.QueryRoutesResponse> responseObserver)
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.
default void getNetworkInfo(LightningApi.NetworkInfoRequest request, io.grpc.stub.StreamObserver<LightningApi.NetworkInfo> responseObserver)
lncli: `getnetworkinfo` GetNetworkInfo returns some basic stats about the known channel graph from the point of view of the node.
default void stopDaemon(LightningApi.StopRequest request, io.grpc.stub.StreamObserver<LightningApi.StopResponse> responseObserver)
lncli: `stop` StopDaemon will send a shutdown request to the interrupt handler, triggering a graceful shutdown of the daemon.
default void subscribeChannelGraph(LightningApi.GraphTopologySubscription request, io.grpc.stub.StreamObserver<LightningApi.GraphTopologyUpdate> responseObserver)
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.
default void debugLevel(LightningApi.DebugLevelRequest request, io.grpc.stub.StreamObserver<LightningApi.DebugLevelResponse> responseObserver)
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.
default void feeReport(LightningApi.FeeReportRequest request, io.grpc.stub.StreamObserver<LightningApi.FeeReportResponse> responseObserver)
lncli: `feereport` FeeReport allows the caller to obtain a report detailing the current fee schedule enforced by the node globally for each channel.
default void updateChannelPolicy(LightningApi.PolicyUpdateRequest request, io.grpc.stub.StreamObserver<LightningApi.PolicyUpdateResponse> responseObserver)
lncli: `updatechanpolicy` UpdateChannelPolicy allows the caller to update the fee schedule and channel policies for all channels globally, or a particular channel.
default void forwardingHistory(LightningApi.ForwardingHistoryRequest request, io.grpc.stub.StreamObserver<LightningApi.ForwardingHistoryResponse> responseObserver)
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.
default void exportChannelBackup(LightningApi.ExportChannelBackupRequest request, io.grpc.stub.StreamObserver<LightningApi.ChannelBackup> responseObserver)
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.
default void exportAllChannelBackups(LightningApi.ChanBackupExportRequest request, io.grpc.stub.StreamObserver<LightningApi.ChanBackupSnapshot> responseObserver)
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.
default void verifyChanBackup(LightningApi.ChanBackupSnapshot request, io.grpc.stub.StreamObserver<LightningApi.VerifyChanBackupResponse> responseObserver)
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.
default void restoreChannelBackups(LightningApi.RestoreChanBackupRequest request, io.grpc.stub.StreamObserver<LightningApi.RestoreBackupResponse> responseObserver)
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.
default void subscribeChannelBackups(LightningApi.ChannelBackupSubscription request, io.grpc.stub.StreamObserver<LightningApi.ChanBackupSnapshot> responseObserver)
SubscribeChannelBackups allows a client to sub-subscribe to the most up to date information concerning the state of all channel backups. Each time a new channel is added, we return the new set of channels, along with a multi-chan backup containing the backup info for all channels. Each time a channel is closed, we send a new update, which contains new new chan back ups, but the updated set of encrypted multi-chan backups with the closed channel(s) removed.
default void bakeMacaroon(LightningApi.BakeMacaroonRequest request, io.grpc.stub.StreamObserver<LightningApi.BakeMacaroonResponse> responseObserver)
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.
default void listMacaroonIDs(LightningApi.ListMacaroonIDsRequest request, io.grpc.stub.StreamObserver<LightningApi.ListMacaroonIDsResponse> responseObserver)
lncli: `listmacaroonids` ListMacaroonIDs returns all root key IDs that are in use.
default void deleteMacaroonID(LightningApi.DeleteMacaroonIDRequest request, io.grpc.stub.StreamObserver<LightningApi.DeleteMacaroonIDResponse> responseObserver)
lncli: `deletemacaroonid` DeleteMacaroonID deletes the specified macaroon ID and invalidates all macaroons derived from that ID.
default void listPermissions(LightningApi.ListPermissionsRequest request, io.grpc.stub.StreamObserver<LightningApi.ListPermissionsResponse> responseObserver)
lncli: `listpermissions` ListPermissions lists all RPC method URIs and their required macaroon permissions to access them.
default void checkMacaroonPermissions(LightningApi.CheckMacPermRequest request, io.grpc.stub.StreamObserver<LightningApi.CheckMacPermResponse> responseObserver)
CheckMacaroonPermissions checks whether a request follows the constraints imposed on the macaroon and that the macaroon is authorized to follow the provided permissions.
default io.grpc.stub.StreamObserver<LightningApi.RPCMiddlewareResponse> registerRPCMiddleware(io.grpc.stub.StreamObserver<LightningApi.RPCMiddlewareRequest> responseObserver)
RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain. A gRPC middleware is software component external to lnd that aims to add additional business logic to lnd by observing/intercepting/validating incoming gRPC client requests and (if needed) replacing/overwriting outgoing messages before they're sent to the client. When registering the middleware must identify itself and indicate what custom macaroon caveats it wants to be responsible for. Only requests that contain a macaroon with that specific custom caveat are then sent to the middleware for inspection. The other option is to register for the read-only mode in which all requests/responses are forwarded for interception to the middleware but the middleware is not allowed to modify any responses. As a security measure, _no_ middleware can modify responses for requests made with _unencumbered_ macaroons!
default void sendCustomMessage(LightningApi.SendCustomMessageRequest request, io.grpc.stub.StreamObserver<LightningApi.SendCustomMessageResponse> responseObserver)
lncli: `sendcustom` SendCustomMessage sends a custom peer message.
default void subscribeCustomMessages(LightningApi.SubscribeCustomMessagesRequest request, io.grpc.stub.StreamObserver<LightningApi.CustomMessage> responseObserver)
lncli: `subscribecustom` SubscribeCustomMessages subscribes to a stream of incoming custom peer messages. To include messages with type outside of the custom range (>= 32768) lnd needs to be compiled with the `dev` build tag, and the message type to override should be specified in lnd's experimental protocol configuration.
default void listAliases(LightningApi.ListAliasesRequest request, io.grpc.stub.StreamObserver<LightningApi.ListAliasesResponse> responseObserver)
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).
default void lookupHtlcResolution(LightningApi.LookupHtlcResolutionRequest request, io.grpc.stub.StreamObserver<LightningApi.LookupHtlcResolutionResponse> responseObserver)
LookupHtlcResolution retrieves a final htlc resolution from the database. If the htlc has no final resolution yet, a NotFound grpc status code is returned.