package lnrpc

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service Lightning

lightning.proto:26

Lightning is the main RPC server of the daemon.

service State

stateservice.proto:27

State service is a always running service that exposes the current state of the wallet and RPC server.

service WalletUnlocker

walletunlocker.proto:29

WalletUnlocker is a service that is used to set up a wallet password for lnd at first startup, and unlock a previously set up wallet.

message AMP

lightning.proto:4212

Details specific to AMP HTLCs.

Used in: InvoiceHTLC

message AMPInvoiceState

lightning.proto:3850

Used in: Invoice

message AMPRecord

lightning.proto:3395

Used in: Hop

enum AddressType

lightning.proto:1224

`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) - `p2tr`: Pay to taproot pubkey (`TAPROOT_PUBKEY` = 4)

Used in: NewAddressRequest, Utxo

message AliasMap

lightning.proto:1650

Used in: ListAliasesResponse, routerrpc.AddAliasesRequest, routerrpc.AddAliasesResponse, routerrpc.DeleteAliasesRequest, routerrpc.DeleteAliasesResponse

message Amount

lightning.proto:3082

Used in: ChannelBalanceResponse

message BatchOpenChannel

lightning.proto:2231

Used in: BatchOpenChannelRequest

message BlindedHop

lightning.proto:3842

Used in: BlindedPath

message BlindedPath

lightning.proto:3827

Used in: BlindedPaymentPath, OnionMessageUpdate

message BlindedPathConfig

lightning.proto:4111

Used in: Invoice

message BlindedPaymentPath

lightning.proto:3792

Used in: PayReq, QueryRoutesRequest

message Chain

lightning.proto:2065

Used in: GetInfoResponse

message ChanBackupSnapshot

lightning.proto:5013

Used as request type in: Lightning.VerifyChanBackup

Used as response type in: Lightning.ExportAllChannelBackups, Lightning.SubscribeChannelBackups

Used as field type in: InitWalletRequest, UnlockWalletRequest

message ChanPointShim

lightning.proto:2575

Used in: FundingShim

message Channel

lightning.proto:1445

Used in: ChannelCommitUpdate, ChannelEventUpdate, ListChannelsResponse

message ChannelAuthProof

lightning.proto:3549

ChannelAuthProof is the authentication proof (the signature portion) for a channel. Using the four signatures contained in the struct, and some auxiliary knowledge (the funding script, node identities, and outpoint) nodes on the network are able to validate the authenticity and existence of a channel.

Used in: ChannelEdge

message ChannelBackup

lightning.proto:4981

Used as response type in: Lightning.ExportChannelBackup

Used as field type in: ChannelBackups

message ChannelBackups

lightning.proto:5027

Used in: ChanBackupSnapshot, RestoreChanBackupRequest

message ChannelCloseSummary

lightning.proto:1673

Used in: ChannelEventUpdate, ClosedChannelsResponse

enum ChannelCloseSummary.ClosureType

lightning.proto:1701

Used in: ChannelCloseSummary

message ChannelCloseUpdate

lightning.proto:2095

Used in: CloseStatusUpdate

message ChannelCommitUpdate

lightning.proto:3012

Used in: ChannelEventUpdate

message ChannelConstraints

lightning.proto:1421

Used in: Channel

message ChannelEdge

lightning.proto:3574

A fully authenticated channel along with all its unique attributes. Once an authenticated channel announcement has been processed on the network, then an 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.

Used as response type in: Lightning.GetChanInfo

Used as field type in: ChannelGraph, NodeInfo

message ChannelEdgeUpdate

lightning.proto:3731

Used in: GraphTopologyUpdate

enum ChannelEventUpdate.UpdateType

lightning.proto:3028

Used in: ChannelEventUpdate

message ChannelFeeReport

lightning.proto:4734

Used in: FeeReportResponse

message ChannelGraph

lightning.proto:3617

Returns a new instance of the directed channel graph.

Used as request type in: devrpc.Dev.ImportGraph

Used as response type in: Lightning.DescribeGraph

message ChannelOpenUpdate

lightning.proto:2074

Used in: OpenStatusUpdate

message ChannelPoint

lightning.proto:1023

Used as response type in: Lightning.OpenChannelSync

Used as field type in: devrpc.QuiescenceRequest, AbandonChannelRequest, ChanPointShim, ChannelBackup, ChannelEdgeUpdate, ChannelEventUpdate, ChannelOpenUpdate, CloseChannelRequest, ClosedChannelUpdate, ExportChannelBackupRequest, MultiChanBackup, PolicyUpdateRequest, routerrpc.UpdateChanStatusRequest, walletrpc.BumpForceCloseFeeRequest

message ChannelUpdate

lightning.proto:5198

Used in: Failure

message CloseOutput

lightning.proto:2078

Used in: ChannelCloseUpdate

message ClosedChannelUpdate

lightning.proto:3748

Used in: GraphTopologyUpdate

enum CoinSelectionStrategy

lightning.proto:1071

Used in: BatchOpenChannelRequest, EstimateFeeRequest, SendCoinsRequest, SendManyRequest, walletrpc.FundPsbtRequest, walletrpc.SendOutputsRequest

enum CommitmentType

lightning.proto:1345

Used in: BatchOpenChannel, Channel, ChannelAcceptRequest, OpenChannelRequest, PendingChannelsResponse.PendingChannel

message EdgeLocator

lightning.proto:3267

Used in: QueryRoutesRequest

message FailedUpdate

lightning.proto:4863

Used in: PolicyUpdateResponse

message Failure

lightning.proto:5116

Used in: HTLCAttempt

enum Failure.FailureCode

lightning.proto:5117

Used in: Failure, routerrpc.ForwardHtlcInterceptResponse, routerrpc.LinkFailEvent

message Feature

lightning.proto:4726

Used in: GetInfoResponse, Invoice, LightningNode, NodeUpdate, PayReq, Peer

enum FeatureBit

lightning.proto:4696

Used in: BlindedPaymentPath, QueryRoutesRequest, peersrpc.UpdateFeatureAction, routerrpc.SendPaymentRequest

message FeeLimit

lightning.proto:875

Used in: QueryRoutesRequest

message FloatMetric

lightning.proto:3646

Used in: NodeMetricsResponse

message ForwardingEvent

lightning.proto:4910

Used in: ForwardingHistoryResponse

message FundingPsbtFinalize

lightning.proto:2686

Used in: FundingTransitionMsg

message FundingPsbtVerify

lightning.proto:2660

Used in: FundingTransitionMsg

message FundingShim

lightning.proto:2639

Used in: FundingTransitionMsg, OpenChannelRequest

message FundingShimCancel

lightning.proto:2655

Used in: FundingTransitionMsg

message GetTransactionsRequest

lightning.proto:797

Used as request type in: Lightning.GetTransactions, Lightning.SubscribeTransactions

enum GraphCacheStatus

lightning.proto:1951

Used in: GetInfoResponse

message HTLC

lightning.proto:1316

Used in: Channel

message HTLCAttempt

lightning.proto:4467

Used as response type in: routerrpc.Router.SendToRouteV2

Used as field type in: Payment

enum HTLCAttempt.HTLCStatus

lightning.proto:4471

Used in: HTLCAttempt

message Hop

lightning.proto:3294

Used in: Route

message HopHint

lightning.proto:3760

Used in: RouteHint

message InboundFee

lightning.proto:4778

Used in: PolicyUpdateRequest

enum Initiator

lightning.proto:1666

Used in: ChannelCloseSummary, PendingChannelsResponse.PendingChannel

message InstantUpdate

lightning.proto:2175

Used in: CloseStatusUpdate

message InterceptFeedback

lightning.proto:5533

Used in: RPCMiddlewareResponse

message Invoice

lightning.proto:3864

Used as request type in: Lightning.AddInvoice

Used as response type in: invoicesrpc.Invoices.LookupInvoiceV2, invoicesrpc.Invoices.SubscribeSingleInvoice, Lightning.LookupInvoice, Lightning.SubscribeInvoices

Used as field type in: invoicesrpc.HtlcModifyRequest, ListInvoiceResponse

enum Invoice.InvoiceState

lightning.proto:4002

Used in: Invoice

message InvoiceHTLC

lightning.proto:4171

Details of an HTLC that paid to an invoice

Used in: Invoice

enum InvoiceHTLCState

lightning.proto:4146

Used in: AMPInvoiceState, InvoiceHTLC

message KeyDescriptor

lightning.proto:2563

Used in: ChanPointShim

message KeyLocator

lightning.proto:2555

Used in: KeyDescriptor

message LightningAddress

lightning.proto:1062

Used in: ConnectPeerRequest

message LightningNode

lightning.proto:3508

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.

Used in: ChannelGraph, NodeInfo

message MPPRecord

lightning.proto:3376

Used in: Hop

message MacaroonId

lightning.proto:5281

message MacaroonPermission

lightning.proto:5060

Used in: BakeMacaroonRequest, CheckMacPermRequest, MacaroonPermissionList

message MacaroonPermissionList

lightning.proto:5101

Used in: ListPermissionsResponse

message MetadataValues

lightning.proto:5419

Used in: RPCMiddlewareRequest

message MiddlewareRegistration

lightning.proto:5504

Used in: RPCMiddlewareResponse

message MultiChanBackup

lightning.proto:4996

Used in: ChanBackupSnapshot

message NodeAddress

lightning.proto:3520

Used in: LightningNode, NodeUpdate

enum NodeMetricType

lightning.proto:3625

Used in: NodeMetricsRequest

message NodePair

lightning.proto:3253

Used in: QueryRoutesRequest

message NodeUpdate

lightning.proto:3708

Used in: GraphTopologyUpdate

message Op

lightning.proto:5287

Used in: MacaroonId, peersrpc.NodeAnnouncementUpdateResponse

message OpenChannelRequest

lightning.proto:2360

Used as request type in: Lightning.OpenChannel, Lightning.OpenChannelSync

message OutPoint

lightning.proto:1042

Used in: EstimateFeeRequest, EstimateFeeResponse, FailedUpdate, OpenChannelRequest, Resolution, SendCoinsRequest, Utxo, walletrpc.BumpFeeRequest, walletrpc.LeaseOutputRequest, walletrpc.PendingSweep, walletrpc.ReleaseOutputRequest, walletrpc.TxTemplate, walletrpc.UtxoLease

message OutputDetail

lightning.proto:738

Used in: Transaction

enum OutputScriptType

lightning.proto:725

Used in: OutputDetail

message PartialPolicyUpdate

lightning.proto:4788

Used in: PolicyUpdateRequest

message Payment

lightning.proto:4392

Used as response type in: routerrpc.Router.SendPaymentV2, routerrpc.Router.TrackPaymentV2, routerrpc.Router.TrackPayments

Used as field type in: ListPaymentsResponse

enum Payment.PaymentStatus

lightning.proto:4419

Used in: Payment

enum PaymentFailureReason

lightning.proto:4353

Used in: Payment, routerrpc.RouteFeeResponse

message Peer

lightning.proto:1829

Used in: ListPeersResponse

enum Peer.SyncType

lightning.proto:1854

Used in: Peer

enum PeerEvent.EventType

lightning.proto:1941

Used in: PeerEvent

message PendingChannelsResponse.ClosedChannel

lightning.proto:2939

Used in: PendingChannelsResponse

message PendingChannelsResponse.Commitments

lightning.proto:2910

Used in: WaitingCloseChannel

message PendingChannelsResponse.ForceClosedChannel

lightning.proto:2947

Used in: PendingChannelsResponse

enum PendingChannelsResponse.ForceClosedChannel.AnchorState

lightning.proto:2977

There are three resolution states for the anchor: limbo, lost and recovered. Derive the current state from the limbo and recovered balances.

Used in: ForceClosedChannel

message PendingChannelsResponse.PendingChannel

lightning.proto:2767

Used in: ClosedChannel, ForceClosedChannel, PendingOpenChannel, WaitingCloseChannel

message PendingChannelsResponse.PendingOpenChannel

lightning.proto:2814

Used in: PendingChannelsResponse

message PendingChannelsResponse.WaitingCloseChannel

lightning.proto:2871

Used in: PendingChannelsResponse

message PendingHTLC

lightning.proto:2737

Used in: PendingChannelsResponse.ForceClosedChannel

message PendingUpdate

lightning.proto:2168

Used in: BatchOpenChannelResponse, ChannelEventUpdate, CloseStatusUpdate, OpenStatusUpdate

message PreviousOutPoint

lightning.proto:1053

Used in: Transaction

message PsbtShim

lightning.proto:2614

Used in: FundingShim

message RPCMessage

lightning.proto:5435

Used in: RPCMiddlewareRequest

message ReadyForPsbtFunding

lightning.proto:2182

Used in: OpenStatusUpdate

message Resolution

lightning.proto:1798

Used in: ChannelCloseSummary

enum ResolutionOutcome

lightning.proto:1769

Used in: Resolution

enum ResolutionType

lightning.proto:1745

Used in: Resolution

message Route

lightning.proto:3410

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.

Used in: HTLCAttempt, QueryRoutesResponse, routerrpc.BuildRouteResponse, routerrpc.SendToRouteRequest, switchrpc.BuildOnionRequest

message RouteHint

lightning.proto:3784

Used in: invoicesrpc.AddHoldInvoiceRequest, Invoice, PayReq, QueryRoutesRequest, routerrpc.SendPaymentRequest

message RoutingPolicy

lightning.proto:3525

Used in: ChannelEdge, ChannelEdgeUpdate

message SetID

lightning.proto:3780

message StreamAuth

lightning.proto:5426

Used in: RPCMiddlewareRequest

message TimestampedError

lightning.proto:1913

Used in: Peer

message Transaction

lightning.proto:758

Used as response type in: Lightning.SubscribeTransactions, walletrpc.WalletKit.GetTransaction

Used as field type in: TransactionDetails

message TransactionDetails

lightning.proto:858

Used as response type in: Lightning.GetTransactions

Used as field type in: walletrpc.ListSweepsResponse

enum UpdateFailure

lightning.proto:4855

Used in: FailedUpdate

message Utxo

lightning.proto:705

Used in: ListUnspentResponse, walletrpc.ListUnspentResponse

message WalletAccountBalance

lightning.proto:3042

Used in: WalletBalanceResponse

enum WalletState

stateservice.proto:38

Used in: GetStateResponse, SubscribeStateResponse

message WatchOnly

walletunlocker.proto:207

Used in: InitWalletRequest

message WatchOnlyAccount

walletunlocker.proto:235

Used in: WatchOnly