Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service ChannelService
channel.proto:5rpc Close (, stream )
channel.proto:9message
channel.proto:91optional channel_point = 1
* The outpoint (txid:index) of the funding transaction. With this value, Bob will be able to generate a signature for Alice's version of the commitment transaction.
bool force = 2
/ If true, then the channel will be closed forcibly. This means the current commitment transaction will be signed and broadcast.
int32 target_conf = 3
/ The target number of blocks that the closure transaction should be confirmed by.
optional sat_per_byte = 4
/ A manual fee rate set in sat/byte that should be used when crafting the closure transaction.
message
channel.proto:122oneof update
close_pending = 1
confirmation = 2
chan_close = 3
rpc List (, )
channel.proto:6message
channel.proto:49bool active_only = 1
bool inactive_only = 2
bool public_only = 3
bool private_only = 4
message
channel.proto:12repeated channels = 1
rpc Open (, stream )
channel.proto:8message
channel.proto:56bytes node_pubkey = 2
/ The pubkey of the node to open a channel with
string node_pubkey_string = 3
/ The hex encoded pubkey of the node to open a channel with
optional local_funding_amount = 4
/ The number of satoshis the wallet should commit to the channel
optional push = 5
/ The number of satoshis to push to the remote side as part of the initial commitment state
int32 target_conf = 6
/ The target number of blocks that the funding transaction should be confirmed by.
optional sat_per_byte = 7
/ A manual fee rate set in sat/byte that should be used when crafting the funding transaction.
bool private = 8
/ Whether this channel should be private, not announced to the greater network.
optional min_htlc = 9
/ The minimum value in millisatoshi we will require for incoming HTLCs on the channel.
uint32 remote_csv_delay = 10
/ The delay we require on the remote's commitment transaction. If this is not set, it will be scaled automatically with the channel size.
int32 min_configs = 11
/ The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
bool spend_unconfirmed = 12
/ Whether unconfirmed outputs should be used as inputs for the funding transaction.
message
channel.proto:130oneof update
chan_pending = 1
confirmation = 2
chan_open = 3
rpc Pending (, )
channel.proto:7message
channel.proto:183int64 total_limbo_balance = 1
/ The balance in satoshis encumbered in pending channels
repeated pending_open_channels = 2
/ Channels pending opening
repeated pending_closing_channels = 3
/ Channels pending closing
repeated pending_force_closing_channels = 4
/ Channels pending force closing
repeated waiting_close_channels = 5
/ Channels waiting for closing tx to confirm
service PaymentService
payment.proto:5rpc AddInvoice (, )
payment.proto:14* 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.
message
payment.proto:182bytes r_hash = 1
string payment_request = 2
* A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.
uint64 add_index = 16
* The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.
rpc DecodePayReq (, )
payment.proto:29message
payment.proto:270string pay_req = 1
/ The payment request string to be decoded
message
payment.proto:274string destination = 1
string payment_hash = 2
int64 num_satoshis = 3
int64 timestamp = 4
int64 expiry = 5
string description = 6
string description_hash = 7
string fallback_addr = 8
int64 cltv_expiry = 9
repeated route_hints = 10
rpc ListInvoices (, )
payment.proto:27* 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. The reversed flag is set by default in order to paginate backwards. If you wish to paginate forwards, you must explicitly set the flag to false. If none of the parameters are specified, then the last 100 invoices will be returned.
message
payment.proto:201bool pending_only = 1
/ If set, only unsettled invoices will be returned in the response.
uint64 index_offset = 4
* The index of an invoice that will be used as either the start or end of a query to determine which invoices should be returned in the response.
uint64 num_max_invoices = 5
/ The max number of invoices to return in the response to this query.
bool reversed = 6
* If set, the invoices returned will result from seeking backwards from the specified index offset. This can be used to paginate backwards.
message
payment.proto:220repeated invoices = 1
* A list of invoices from the time slice of the time series specified in the request.
uint64 last_index_offset = 2
* The index of the last item in the set of returned invoices. This can be used to seek further, pagination style.
uint64 first_index_offset = 3
* The index of the last item in the set of returned invoices. This can be used to seek backwards, pagination style.
rpc ListPayments (, )
payment.proto:31message
payment.proto:240repeated payments = 1
/ The list of payments
rpc SendPayment (stream , stream )
payment.proto:6rpc SendPaymentSync (, )
payment.proto:7
service RoutingService
routing.proto:5rpc ConnectPeer (, )
routing.proto:13message
routing.proto:64optional address = 1
/ Lightning address of the peer, in the format `<pubkey>@host`
bool perm = 2
* If set, the daemon will attempt to persistently connect to the target peer. Otherwise, the call will be synchronous.
rpc DescribeGraph (, )
routing.proto:19message
routing.proto:122bool include_unannounced = 1
* Whether unannounced channels are included in the response or not. If set, unannounced channels are included. Unannounced channels are both private channels, and public channels that are not yet announced to the network.
message
routing.proto:131/ Returns a new instance of the directed channel graph.
repeated nodes = 1
/ The list of `LightningNode`s in this channel graph
repeated edges = 2
/ The list of `ChannelEdge`s in this channel graph
rpc GetInfo (, )
routing.proto:17message
routing.proto:77string identity_pubkey = 1
/ The identity pubkey of the current node.
string alias = 2
/ If applicable, the alias of the current node, e.g. "bob"
uint32 num_pending_channels = 3
/ Number of pending channels
uint32 num_active_channels = 4
/ Number of active channels
uint32 num_peers = 5
/ Number of peers
uint32 block_height = 6
/ The node's current view of the height of the best block
string block_hash = 8
/ The node's current view of the hash of the best block
bool synced_to_chain = 9
/ Whether the wallet's view is synced to the main chain
bool testnet = 10
/ Whether the current node is connected to testnet
repeated string chains = 11
/ A list of active chains the node is connected to
repeated string uris = 12
/ The URIs of the current node.
int64 best_header_timestamp = 13
/ Timestamp of the block best known to the wallet
string version = 14
/ The version of the LPD software that the node is running.
uint32 num_inactive_channels = 15
/ Number of inactive channels
rpc ListPeers (, )
routing.proto:15message
routing.proto:73repeated peers = 1
rpc QueryRoutes (, )
routing.proto:20message
routing.proto:179string pub_key = 1
/ The 33-byte hex-encoded public key for the payment destination
int64 amt = 2
/ The amount to send expressed in satoshis
int32 num_routes = 3
/ The max number of routes to return.
int32 final_cltv_delta = 4
/ An optional CLTV delta from the current height that should be used for the timelock of the final hop
optional fee_limit = 5
* The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.
message
routing.proto:200repeated routes = 1
rpc SignMessage (, )
routing.proto:11* 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.
message
routing.proto:57bytes message = 1
message
routing.proto:60string signature = 1
message
channel.proto:16Used in:
bool active = 1
string remote_pubkey = 2
string channel_point = 3
optional chan_id = 4
optional capacity = 5
optional local_balance = 6
optional remote_balance = 7
optional commit_fee = 8
int64 commit_weight = 9
optional fee_per_kw = 10
optional unsettled_balance = 11
optional total_sent = 12
optional total_received = 13
uint64 num_updates = 14
repeated pending_htlcs = 15
uint32 csv_delay = 16
bool private = 17
message
channel.proto:154Used in:
bytes closing_txid = 1
bool success = 2
message
routing.proto:151Used in:
uint64 channel_id = 1
* The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
string chan_point = 2
uint32 last_update = 3
string node1_pub = 4
string node2_pub = 5
int64 capacity = 6
optional node1_policy = 7
optional node2_policy = 8
message
channel.proto:43Used in:
uint32 block_height = 1
uint32 index = 2
uint32 output_index = 3
message
channel.proto:150Used in:
optional channel_point = 1
message
channel.proto:109Used in: ,
oneof funding_txid
bytes funding_txid_bytes = 1
/ Txid of the funding transaction
string funding_txid_str = 2
/ Hex-encoded string representing the funding transaction
uint32 output_index = 3
/ The index of the output of the funding transaction
message
channel.proto:143Used in: ,
bytes block_sha = 1
int32 block_height = 2
uint32 num_confs_left = 3
message
common.proto:13Used in: ,
oneof limit
fixed = 1
/ The fee limit expressed as a fixed amount of satoshis.
int64 percent = 2
/ The fee limit expressed as a percentage of the payment amount.
message
channel.proto:36Used in:
bool incoming = 1
optional amount = 2
bytes hash_lock = 3
uint32 expiration_height = 4
message
common.proto:64Used in:
uint64 chan_id = 1
* The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.
int64 chan_capacity = 2
int64 amt_to_forward = 3
int64 fee = 4
uint32 expiry = 5
int64 amt_to_forward_msat = 6
int64 fee_msat = 7
string pub_key = 8
* An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.
message
payment.proto:287Used in:
string node_id = 1
/ The public key of the node at the start of the channel.
uint64 chan_id = 2
/ The unique identifier of the channel.
optional fee_base_msat = 3
/ The base fee of the channel denominated in millisatoshis.
uint32 fee_proportional_millionths = 4
* The fee rate of the channel for sending one satoshi across it denominated in millionths of a satoshi.
uint32 cltv_expiry_delta = 5
/ The time-lock delta of the channel.
message
payment.proto:78Used as request type in: PaymentService.AddInvoice
Used as field type in:
string memo = 1
* An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
bytes receipt = 2
/ An optional cryptographic receipt of payment
bytes r_preimage = 3
* The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage
bytes r_hash = 4
/ The hash of the preimage
optional value = 5
/ The value of this invoice in satoshis
bool settled = 6
/ Whether this invoice has been fulfilled
int64 creation_date = 7
/ When this invoice was created
int64 settle_date = 8
/ When this invoice was settled
string payment_request = 9
* A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.
bytes description_hash = 10
* Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request.
int64 expiry = 11
/ Payment request expiry time in seconds. Default is 3600 (1 hour).
string fallback_addr = 12
/ Fallback on-chain address.
uint64 cltv_expiry = 13
/ Delta to use for the time-lock of the CLTV extended to the final hop.
repeated route_hints = 14
* Route hints that can each be individually used to assist in reaching the invoice's destination.
bool private = 15
/ Whether this invoice should include routing hints for private channels.
uint64 add_index = 16
* The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.
uint64 settle_index = 17
* The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one.
int64 amt_paid = 18
/ Deprecated, use amt_paid_sat or amt_paid_msat.
int64 amt_paid_sat = 19
* The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.
int64 amt_paid_msat = 20
* The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.
message
routing.proto:23Used in:
string pubkey = 1
string host = 2
/ The network location of the lightning node, e.g. `69.69.69.69:1337` / localhost alias is not supported yet, use 127.0.0.1
message
routing.proto:138Used in:
uint32 last_update = 1
string pub_key = 2
string alias = 3
repeated addresses = 4
string color = 5
message
common.proto:9Used in: , , , , , ,
uint64 value = 1
message
routing.proto:146Used in:
string network = 1
string addr = 2
message
payment.proto:244Used in:
string payment_hash = 1
/ The payment hash
int64 value = 2
/ Deprecated, use value_sat or value_msat.
int64 creation_date = 3
/ The date of this payment
repeated string path = 4
/ The path this payment took
optional fee = 5
/ The fee paid for this payment in satoshis
string payment_preimage = 6
/ The payment preimage
optional value_sat = 7
/ The value of the payment in satoshis
optional value_msat = 8
/ The value of the payment in milli-satoshis
message
routing.proto:31Used in:
string pub_key = 1
/ The identity pubkey of the peer
string address = 3
/ Network address of the peer; eg `127.0.0.1:10011`
uint64 bytes_sent = 4
/ Bytes of data transmitted to this peer
uint64 bytes_recv = 5
/ Bytes of data transmitted from this peer
optional sat_sent = 6
/ Satoshis sent to this peer
optional sat_recv = 7
/ Satoshis received from this peer
bool inbound = 8
/ A channel is inbound if the counterparty initiated the channel
int64 ping_time = 9
/ Ping time to this peer
message
channel.proto:229Used in:
optional channel = 1
/ The pending channel to be closed
string closing_txid = 2
/ The transaction id of the closing transaction
message
channel.proto:237Used in:
optional channel = 1
/ The pending channel to be force closed
string closing_txid = 2
/ The transaction id of the closing transaction
int64 limbo_balance = 3
/ The balance in satoshis encumbered in this pending channel
uint32 maturity_height = 4
/ The height at which funds can be sweeped into the wallet
int32 blocks_til_maturity = 5
Remaining # of blocks until the commitment output can be swept. Negative values indicate how many blocks have passed since becoming mature.
int64 recovered_balance = 6
/ The total value of funds successfully recovered from this channel
repeated pending_htlcs = 8
message
channel.proto:184Used in: , , ,
string remote_node_pub = 1
string channel_point = 2
int64 capacity = 3
int64 local_balance = 4
int64 remote_balance = 5
message
channel.proto:194Used in:
optional channel = 1
/ The pending channel
uint32 confirmation_height = 2
/ The height at which this channel will be confirmed
int64 commit_fee = 4
* The amount calculated to be paid in fees for the current set of commitment transactions. The fee amount is persisted with the channel in order to allow the fee amount to be removed and recalculated with each channel state update, including updates that happen after a system restart.
int64 commit_weight = 5
/ The weight of the commitment transaction
int64 fee_per_kw = 6
* The required number of satoshis per kilo-weight that the requester will pay at all times, for both the funding transaction and commitment transaction. This value can later be updated once the channel is open.
message
channel.proto:221Used in:
optional channel = 1
/ The pending channel waiting for closing tx to confirm
int64 limbo_balance = 2
/ The balance in satoshis encumbered in this channel
message
channel.proto:159Used in:
bool incoming = 1
/ The direction within the channel that the htlc was sent
optional amount = 2
/ The total value of the htlc
string outpoint = 3
/ The final output to be swept back to the user's wallet
uint32 maturity_height = 4
/ The next block height at which we can spend the current stage
int32 blocks_til_maturity = 5
* The number of blocks remaining until the current stage can be swept. Negative values indicate how many blocks have passed since becoming mature.
uint32 stage = 6
/ Indicates whether the htlc is in its first or second stage of recovery
message
channel.proto:138Used in: ,
bytes txid = 1
uint32 output_index = 2
message
common.proto:23Used in: ,
uint32 total_time_lock = 1
* The cumulative (final) time lock across the entire route. This is the CLTV value that should be extended to the first hop in the route. All other hops will decrement the time-lock as advertised, leaving enough time for all hops to wait for or present the payment preimage to complete the payment.
optional total_fees = 2
* The sum of the fees paid at each hop within the final route. In the case of a one-hop payment, this value will be zero as we don't need to pay a fee it ourself.
optional total_amt = 3
* The total amount of funds required to complete a payment over this route. This value includes the cumulative fees at each hop. As a result, the HTLC extended to the first-hop in the route will need to have at least this many satoshis, otherwise the route will fail at an intermediate node due to an insufficient amount of fees.
repeated hops = 4
* Contains details concerning the specific forwarding details at each hop.
optional total_fees_msat = 5
* The total fees in millisatoshis.
optional total_amt_msat = 6
* The total amount in millisatoshis.
message
payment.proto:307Used in: ,
repeated hop_hints = 1
* A list of hop hints that when chained together can assist in reaching a specific destination.
message
routing.proto:171Used in:
uint32 time_lock_delta = 1
int64 min_htlc = 2
int64 fee_base_msat = 3
optional fee_rate_milli = 4
bool disabled = 5
message
common.proto:5Used in: , , , , , , , ,
uint64 value = 1
message
payment.proto:34Used as request type in: PaymentService.SendPayment, PaymentService.SendPaymentSync
bytes destination = 1
/ The identity pubkey of the payment recipient
string destination_string = 2
/ The hex-encoded identity pubkey of the payment recipient
optional amt = 3
/ Number of satoshis to send.
bytes payment_hash = 4
/ The hash to use within the payment's HTLC
string payment_hash_string = 5
/ The hex-encoded hash to use within the payment's HTLC
string payment_request = 6
* A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.
int32 final_cltv_delta = 7
* The CLTV delta from the current height that should be used to set the timelock for the final hop.
optional fee_limit = 8
* The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.
message
payment.proto:72Used as response type in: PaymentService.SendPayment, PaymentService.SendPaymentSync
string payment_error = 1
bytes payment_preimage = 2
optional payment_route = 3
message
common.proto:3Used as request type in: ChannelService.Pending, PaymentService.ListPayments, RoutingService.GetInfo, RoutingService.ListPeers
Used as response type in: RoutingService.ConnectPeer
(message has no fields)