aboutsummaryrefslogtreecommitdiffstats
path: root/sampleconfig
diff options
context:
space:
mode:
authorAdam Soltys <[email protected]>2021-05-31 10:52:00 -0700
committerAdam Soltys <[email protected]>2021-06-09 16:06:45 -0700
commitef2e67a7dce5c49a74ffca9440d0a256f69f9853 (patch)
tree5e11ce83b1120e3e75e711696dc0ad10eff39ce8 /sampleconfig
parentc5374c599a9d96507bff6ff6d5b9e1f355e89eff (diff)
downloadcoinos-server-ef2e67a7dce5c49a74ffca9440d0a256f69f9853.tar.gz
coinos-server-ef2e67a7dce5c49a74ffca9440d0a256f69f9853.zip
move sample config
Diffstat (limited to 'sampleconfig')
-rw-r--r--sampleconfig/bitcoin/bitcoin.conf17
-rw-r--r--sampleconfig/config.json26
-rw-r--r--sampleconfig/index.js85
-rw-r--r--sampleconfig/lightning/config7
-rw-r--r--sampleconfig/liquid/elements.conf38
-rw-r--r--sampleconfig/lnurl.js32
-rw-r--r--sampleconfig/private.json49
-rw-r--r--sampleconfig/rpc.proto3497
8 files changed, 3751 insertions, 0 deletions
diff --git a/sampleconfig/bitcoin/bitcoin.conf b/sampleconfig/bitcoin/bitcoin.conf
new file mode 100644
index 00000000..46a797bd
--- /dev/null
+++ b/sampleconfig/bitcoin/bitcoin.conf
@@ -0,0 +1,17 @@
+regtest=1
+testnet=0
+dnsseed=0
+upnp=0
+
+[regtest]
+fallbackfee=0.00002
+server=1
+txindex=0
+
+rpcuser=admin1
+rpcpassword=123
+rpcallowip=0.0.0.0/0
+rpcbind=0.0.0.0
+
+zmqpubrawblock=tcp://0.0.0.0:18506
+zmqpubrawtx=tcp://0.0.0.0:18507
diff --git a/sampleconfig/config.json b/sampleconfig/config.json
new file mode 100644
index 00000000..f3cfd309
--- /dev/null
+++ b/sampleconfig/config.json
@@ -0,0 +1,26 @@
+{
+ "development": {
+ "username": "root",
+ "password": "password",
+ "database": "coinos",
+ "host": "localhost",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ },
+ "test": {
+ "username": "root",
+ "password": null,
+ "database": "database_test",
+ "host": "127.0.0.1",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ },
+ "production": {
+ "username": "root",
+ "password": null,
+ "database": "database_production",
+ "host": "127.0.0.1",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ }
+}
diff --git a/sampleconfig/index.js b/sampleconfig/index.js
new file mode 100644
index 00000000..407fbed6
--- /dev/null
+++ b/sampleconfig/index.js
@@ -0,0 +1,85 @@
+const private = require("./private.json") || {}
+const debug = require('debug')('test')
+
+const dbOptions = private.connection[process.env.NODE_ENV || "development"]
+let lnurl;
+
+try {
+ lnurl = require("./lnurl");
+} catch(e) {
+ debug("lnurl config not found");
+}
+
+const btcasset = "5ac9f65c0efcc4775e0baec4ec03abdde22473cd3cf33c0419ca290e0751b225";
+const cadasset = "e749f7326d0ba155ec1d878e23458bc3f740a38bf91bbce955945ee10d6ab523";
+const usdtasset = "4dddd1d0d0beeaee17df7722b512906cc5bc660c81225083b72b05820ecd3d91";
+
+module.exports = {
+ dbOptions: dbOptions,
+ lnurl,
+ clientVersion: private.CLIENT_VERSION,
+ private: private,
+ vapid: {
+ url: "https://coinos.io/",
+ publicKey: private.VAPID_PUBLIC_KEY,
+ privateKey: private.VAPID_PRIVATE_KEY
+ },
+ knex: {
+ client: 'mysql2',
+ connection: dbOptions
+ },
+ ipstack: "2e1805258268b4992ebac06e20fc1865", // optional, set default currency based on IP
+ jwt: private.jwt,
+ port: 3119,
+ facebook: private.facebook,
+ bitcoin: {
+ masterkey: private.BITCOIN_KEY, // get from bitcoin-cli dumpwallet "walletfile"
+ username: "user",
+ password: "password",
+ network: "regtest",
+ port: 18443,
+ zmqrawblock: "tcp://127.0.0.1:18506",
+ zmqrawtx: "tcp://127.0.0.1:18507"
+ },
+ liquid: {
+ masterkey: private.LIQUID_KEY, // get from elements-cli dumpwallet "walletfile"
+ blindkey: '0e66557c1dfa0c7daa371314ffd763979d3f7c5db69380e5c15ea72b85453c2e',
+ wallet: "coinos",
+ username: "user",
+ password: "password",
+ network: "regtest",
+ port: 18882,
+ zmqrawblock: "tcp://127.0.0.1:18602",
+ zmqrawtx: "tcp://127.0.0.1:18603",
+ btcasset: "b2e15d0d7a0c94e4e2ce0fe6e8691b9e451377f6e46e8045a86f7c4b5d4f0f23", // find with elements-cli dumpassetlabels
+ },
+ lna: {
+ server: 'localhost:10001',
+ tls: '/home/user/.lnd.testa/tls.cert',
+ macaroon: '/home/user/.lnd.testa/data/chain/bitcoin/testnet/admin.macaroon',
+ },
+ maker: [ // special account with username "maker" places orders on the exchange
+ {
+ c1: btcasset,
+ c2: cadasset,
+ currency: "CAD",
+ amount: 0.001,
+ askMultiplier: 1.01,
+ bidMultiplier: 0.99,
+ },
+ {
+ c1: btcasset,
+ c2: usdtasset,
+ currency: 'USD',
+ amount: 0.001,
+ askMultiplier: 1.01,
+ bidMultiplier: 0.99,
+ }
+ ],
+ mailgun: {
+ domain: "coinos.io",
+ apiKey: private.MAILGUN_KEY
+
+ },
+ imap: private.IMAP_SETTINGS
+}
diff --git a/sampleconfig/lightning/config b/sampleconfig/lightning/config
new file mode 100644
index 00000000..14e913c3
--- /dev/null
+++ b/sampleconfig/lightning/config
@@ -0,0 +1,7 @@
+alias=coinos
+rgb=006000
+bitcoin-rpcconnect=bitcoin
+bitcoin-rpcport=18443
+bitcoin-rpcuser=admin1
+bitcoin-rpcpassword=123
+network=regtest
diff --git a/sampleconfig/liquid/elements.conf b/sampleconfig/liquid/elements.conf
new file mode 100644
index 00000000..06539981
--- /dev/null
+++ b/sampleconfig/liquid/elements.conf
@@ -0,0 +1,38 @@
+chain=liquidregtest
+listen=1
+txindex=1
+
+
+[liquidregtest]
+port=18886
+rpcport=18884
+rpcuser=admin1
+rpcpassword=123
+rpcallowip=0.0.0.0/0
+rpcbind=0.0.0.0
+
+#mainchainrpcport=19001
+#mainchainrpchost=10.10.0.10
+#mainchainrpcuser=admin1
+#mainchainrpcpassword=123
+
+# This is the script that controls pegged in funds in Bitcoin network
+# Users will be pegging into a P2SH of this, and the "watchmen"
+# can then recover these funds and send them to users who desire to peg out.
+# This template is 1-of-1 checkmultisig
+#fedpegscript=5121<pubkey>51ae
+
+# This is the script that controls how blocks are made
+# We have to supply a signature that satisfies this to create
+# a valid block.
+#signblockscript=5121<pubkey2>51ae
+
+# We want to validate pegins by checking with bitcoind if header exists
+# in best known chain, and how deep. We combine this with pegin
+# proof included in the pegin to get full security.
+
+validatepegin=0
+initialfreecoins=2100000000000000
+
+zmqpubrawblock=tcp://0.0.0.0:18606
+zmqpubrawtx=tcp://0.0.0.0:18607
diff --git a/sampleconfig/lnurl.js b/sampleconfig/lnurl.js
new file mode 100644
index 00000000..8c9add00
--- /dev/null
+++ b/sampleconfig/lnurl.js
@@ -0,0 +1,32 @@
+module.exports = {
+ host: "localhost",
+ port: 3118,
+ protocol: "http",
+ url: "http://localhost:8085",
+ auth: {
+ apiKeys: [
+ {
+ id: "50bdeb634d",
+ key: "ac9bdd15a983072311c74c13877d122f16a27a8f40cb4dfa5014eece4da5cda2"
+ }
+ ]
+ },
+ lightning: {
+ backend: "lnd",
+ config: {
+ hostname: "localhost:8005",
+ cert: "/home/user/.lnd.sima/tls.cert",
+ macaroon: "/home/user/.lnd.sima/data/chain/bitcoin/regtest/admin.macaroon"
+ }
+ },
+ store: {
+ backend: 'knex',
+ config: {
+ client: 'sqlite3',
+ useNullAsDefault: true,
+ connection: {
+ filename: './lnurl-server.sqlite3',
+ },
+ },
+ },
+};
diff --git a/sampleconfig/private.json b/sampleconfig/private.json
new file mode 100644
index 00000000..ff9c9171
--- /dev/null
+++ b/sampleconfig/private.json
@@ -0,0 +1,49 @@
+{
+ "connection": {
+ "development": {
+ "user": "tester",
+ "password": "testpassword",
+ "database": "coinos",
+ "host": "localhost",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ },
+ "test": {
+ "username": "proxy",
+ "password": "pwd",
+ "database": "database_test",
+ "host": "127.0.0.1",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ },
+ "production": {
+ "username": "proxy",
+ "password": "pwd",
+ "database": "database_production",
+ "host": "127.0.0.1",
+ "dialect": "mariadb",
+ "dialectOptions": { "multipleStatements": true, "timezone": "Etc/GMT+7" }
+ }
+ },
+ "jwt": "********",
+
+ "CLIENT_VERSION": "*****",
+
+ "MAILGUN_KEY": "*****",
+
+ "IMAP_SETTINGS": {
+ "user": "**",
+ "password": "**",
+ "host": "**",
+ "port": "**",
+ "tls": true,
+ "accounts": {}
+ },
+
+ "BITCOIN_KEY": "*****",
+ "LIQUID_KEY": "*****",
+
+ "VAPID_PUBLIC_KEY": "*****",
+ "VAPID_PRIVATE_KEY": "*****",
+}
+
diff --git a/sampleconfig/rpc.proto b/sampleconfig/rpc.proto
new file mode 100644
index 00000000..ee5504d7
--- /dev/null
+++ b/sampleconfig/rpc.proto
@@ -0,0 +1,3497 @@
+syntax = "proto3";
+
+package lnrpc;
+
+option go_package = "github.com/lightningnetwork/lnd/lnrpc";
+
+/*
+ * Comments in this file will be directly parsed into the API
+ * Documentation as descriptions of the associated method, message, or field.
+ * These descriptions should go right above the definition of the object, and
+ * can be in either block or // comment format.
+ *
+ * An RPC method can be matched to an lncli command by placing a line in the
+ * beginning of the description in exactly the following format:
+ * lncli: `methodname`
+ *
+ * Failure to specify the exact name of the command will cause documentation
+ * generation to fail.
+ *
+ * More information on how exactly the gRPC documentation is generated from
+ * this proto file can be found here:
+ * https://github.com/lightninglabs/lightning-api
+ */
+
+// Lightning is the main RPC server of the daemon.
+service Lightning {
+ /* lncli: `walletbalance`
+ WalletBalance returns total unspent outputs(confirmed and unconfirmed), all
+ confirmed unspent outputs and all unconfirmed unspent outputs under control
+ of the wallet.
+ */
+ rpc WalletBalance (WalletBalanceRequest) returns (WalletBalanceResponse);
+
+ /* lncli: `channelbalance`
+ ChannelBalance returns the total funds available across all open channels
+ in satoshis.
+ */
+ rpc ChannelBalance (ChannelBalanceRequest) returns (ChannelBalanceResponse);
+
+ /* lncli: `listchaintxns`
+ GetTransactions returns a list describing all the known transactions
+ relevant to the wallet.
+ */
+ rpc GetTransactions (GetTransactionsRequest) returns (TransactionDetails);
+
+ /* 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.
+ */
+ rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse);
+
+ /* 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_byte are set, then the internal wallet will
+ consult its fee model to determine a fee for the default confirmation
+ target.
+ */
+ rpc SendCoins (SendCoinsRequest) returns (SendCoinsResponse);
+
+ /* 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.
+ */
+ rpc ListUnspent (ListUnspentRequest) returns (ListUnspentResponse);
+
+ /*
+ 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.
+ */
+ rpc SubscribeTransactions (GetTransactionsRequest)
+ returns (stream Transaction);
+
+ /* lncli: `sendmany`
+ SendMany handles a request for a transaction that creates multiple specified
+ outputs in parallel. If neither target_conf, or sat_per_byte are set, then
+ the internal wallet will consult its fee model to determine a fee for the
+ default confirmation target.
+ */
+ rpc SendMany (SendManyRequest) returns (SendManyResponse);
+
+ /* lncli: `newaddress`
+ NewAddress creates a new address under control of the local wallet.
+ */
+ rpc NewAddress (NewAddressRequest) returns (NewAddressResponse);
+
+ /* 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.
+ */
+ rpc SignMessage (SignMessageRequest) returns (SignMessageResponse);
+
+ /* lncli: `verifymessage`
+ VerifyMessage verifies a signature over a msg. The signature must be
+ zbase32 encoded and signed by an active node in the resident node's
+ channel database. In addition to returning the validity of the signature,
+ VerifyMessage also returns the recovered pubkey from the signature.
+ */
+ rpc VerifyMessage (VerifyMessageRequest) returns (VerifyMessageResponse);
+
+ /* 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.
+ */
+ rpc ConnectPeer (ConnectPeerRequest) returns (ConnectPeerResponse);
+
+ /* 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.
+ */
+ rpc DisconnectPeer (DisconnectPeerRequest) returns (DisconnectPeerResponse);
+
+ /* lncli: `listpeers`
+ ListPeers returns a verbose listing of all currently active peers.
+ */
+ rpc ListPeers (ListPeersRequest) returns (ListPeersResponse);
+
+ /*
+ 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.
+ */
+ rpc SubscribePeerEvents (PeerEventSubscription) returns (stream PeerEvent);
+
+ /* 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.
+ */
+ rpc GetInfo (GetInfoRequest) returns (GetInfoResponse);
+
+ /** 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.
+ */
+ rpc GetRecoveryInfo (GetRecoveryInfoRequest)
+ returns (GetRecoveryInfoResponse);
+
+ // TODO(roasbeef): merge with below with bool?
+ /* 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.
+ */
+ rpc PendingChannels (PendingChannelsRequest)
+ returns (PendingChannelsResponse);
+
+ /* lncli: `listchannels`
+ ListChannels returns a description of all the open channels that this node
+ is a participant in.
+ */
+ rpc ListChannels (ListChannelsRequest) returns (ListChannelsResponse);
+
+ /*
+ 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.
+ */
+ rpc SubscribeChannelEvents (ChannelEventSubscription)
+ returns (stream ChannelEventUpdate);
+
+ /* lncli: `closedchannels`
+ ClosedChannels returns a description of all the closed channels that
+ this node was a participant in.
+ */
+ rpc ClosedChannels (ClosedChannelsRequest) returns (ClosedChannelsResponse);
+
+ /*
+ 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.
+ */
+ rpc OpenChannelSync (OpenChannelRequest) returns (ChannelPoint);
+
+ /* 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.
+ */
+ rpc OpenChannel (OpenChannelRequest) returns (stream OpenStatusUpdate);
+
+ /*
+ 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.
+ */
+ rpc FundingStateStep (FundingTransitionMsg) returns (FundingStateStepResp);
+
+ /*
+ 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.
+ */
+ rpc ChannelAcceptor (stream ChannelAcceptResponse)
+ returns (stream ChannelAcceptRequest);
+
+ /* 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.
+ */
+ rpc CloseChannel (CloseChannelRequest) returns (stream CloseStatusUpdate);
+
+ /* 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. Only available
+ when in debug builds of lnd.
+ */
+ rpc AbandonChannel (AbandonChannelRequest) returns (AbandonChannelResponse);
+
+ /* 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.
+ */
+ rpc SendPayment (stream SendRequest) returns (stream SendResponse) {
+ option deprecated = true;
+ }
+
+ /*
+ 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.
+ */
+ rpc SendPaymentSync (SendRequest) returns (SendResponse);
+
+ /* 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.
+ */
+ rpc SendToRoute (stream SendToRouteRequest) returns (stream SendResponse) {
+ option deprecated = true;
+ }
+
+ /*
+ SendToRouteSync is a synchronous version of SendToRoute. It Will block
+ until the payment either fails or succeeds.
+ */
+ rpc SendToRouteSync (SendToRouteRequest) returns (SendResponse);
+
+ /* 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.
+ */
+ rpc AddInvoice (Invoice) returns (AddInvoiceResponse);
+
+ /* 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.
+ */
+ rpc ListInvoices (ListInvoiceRequest) returns (ListInvoiceResponse);
+
+ /* 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.
+ */
+ rpc LookupInvoice (PaymentHash) returns (Invoice);
+
+ /*
+ 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.
+ */
+ rpc SubscribeInvoices (InvoiceSubscription) returns (stream Invoice);
+
+ /* 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.
+ */
+ rpc DecodePayReq (PayReqString) returns (PayReq);
+
+ /* lncli: `listpayments`
+ ListPayments returns a list of all outgoing payments.
+ */
+ rpc ListPayments (ListPaymentsRequest) returns (ListPaymentsResponse);
+
+ /*
+ DeleteAllPayments deletes all outgoing payments from DB.
+ */
+ rpc DeleteAllPayments (DeleteAllPaymentsRequest)
+ returns (DeleteAllPaymentsResponse);
+
+ /* 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.
+ */
+ rpc DescribeGraph (ChannelGraphRequest) returns (ChannelGraph);
+
+ /* lncli: `getnodemetrics`
+ GetNodeMetrics returns node metrics calculated from the graph. Currently
+ the only supported metric is betweenness centrality of individual nodes.
+ */
+ rpc GetNodeMetrics (NodeMetricsRequest) returns (NodeMetricsResponse);
+
+ /* 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.
+ */
+ rpc GetChanInfo (ChanInfoRequest) returns (ChannelEdge);
+
+ /* lncli: `getnodeinfo`
+ GetNodeInfo returns the latest advertised, aggregated, and authenticated
+ channel information for the specified node identified by its public key.
+ */
+ rpc GetNodeInfo (NodeInfoRequest) returns (NodeInfo);
+
+ /* 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.
+ */
+ rpc QueryRoutes (QueryRoutesRequest) returns (QueryRoutesResponse);
+
+ /* lncli: `getnetworkinfo`
+ GetNetworkInfo returns some basic stats about the known channel graph from
+ the point of view of the node.
+ */
+ rpc GetNetworkInfo (NetworkInfoRequest) returns (NetworkInfo);
+
+ /* lncli: `stop`
+ StopDaemon will send a shutdown request to the interrupt handler, triggering
+ a graceful shutdown of the daemon.
+ */
+ rpc StopDaemon (StopRequest) returns (StopResponse);
+
+ /*
+ 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.
+ */
+ rpc SubscribeChannelGraph (GraphTopologySubscription)
+ returns (stream GraphTopologyUpdate);
+
+ /* 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.
+ */
+ rpc DebugLevel (DebugLevelRequest) returns (DebugLevelResponse);
+
+ /* lncli: `feereport`
+ FeeReport allows the caller to obtain a report detailing the current fee
+ schedule enforced by the node globally for each channel.
+ */
+ rpc FeeReport (FeeReportRequest) returns (FeeReportResponse);
+
+ /* lncli: `updatechanpolicy`
+ UpdateChannelPolicy allows the caller to update the fee schedule and
+ channel policies for all channels globally, or a particular channel.
+ */
+ rpc UpdateChannelPolicy (PolicyUpdateRequest)
+ returns (PolicyUpdateResponse);
+
+ /* 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. If no time-range is specified, then the first chunk
+ of the past 24 hrs of forwarding history are returned.
+
+ A list of forwarding events are returned. The size of each forwarding event
+ is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.
+ As a result each message can only contain 50k entries. Each response has
+ the index offset of the last entry. The index offset can be provided to the
+ request to allow the caller to skip a series of records.
+ */
+ rpc ForwardingHistory (ForwardingHistoryRequest)
+ returns (ForwardingHistoryResponse);
+
+ /* 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.
+ */
+ rpc ExportChannelBackup (ExportChannelBackupRequest)
+ returns (ChannelBackup);
+
+ /*
+ 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.
+ */
+ rpc ExportAllChannelBackups (ChanBackupExportRequest)
+ returns (ChanBackupSnapshot);
+
+ /*
+ 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.
+ */
+ rpc VerifyChanBackup (ChanBackupSnapshot)
+ returns (VerifyChanBackupResponse);
+
+ /* 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.
+ */
+ rpc RestoreChannelBackups (RestoreChanBackupRequest)
+ returns (RestoreBackupResponse);
+
+ /*
+ 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.
+ */
+ rpc SubscribeChannelBackups (ChannelBackupSubscription)
+ returns (stream ChanBackupSnapshot);
+
+ /* 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.
+ */
+ rpc BakeMacaroon (BakeMacaroonRequest) returns (BakeMacaroonResponse);
+}
+
+message Utxo {
+ // The type of address
+ AddressType address_type = 1;
+
+ // The address
+ string address = 2;
+
+ // The value of the unspent coin in satoshis
+ int64 amount_sat = 3;
+
+ // The pkscript in hex
+ string pk_script = 4;
+
+ // The outpoint in format txid:n
+ OutPoint outpoint = 5;
+
+ // The number of confirmations for the Utxo
+ int64 confirmations = 6;
+}
+
+message Transaction {
+ // The transaction hash
+ string tx_hash = 1;
+
+ // The transaction amount, denominated in satoshis
+ int64 amount = 2;
+
+ // The number of confirmations
+ int32 num_confirmations = 3;
+
+ // The hash of the block this transaction was included in
+ string block_hash = 4;
+
+ // The height of the block this transaction was included in
+ int32 block_height = 5;
+
+ // Timestamp of this transaction
+ int64 time_stamp = 6;
+
+ // Fees paid for this transaction
+ int64 total_fees = 7;
+
+ // Addresses that received funds for this transaction
+ repeated string dest_addresses = 8;
+
+ // The raw transaction hex.
+ string raw_tx_hex = 9;
+
+ // A label that was optionally set on transaction broadcast.
+ string label = 10;
+}
+message GetTransactionsRequest {
+ /*
+ The height from which to list transactions, inclusive. If this value is
+ greater than end_height, transactions will be read in reverse.
+ */
+ int32 start_height = 1;
+
+ /*
+ The height until which to list transactions, inclusive. To include
+ unconfirmed transactions, this value should be set to -1, which will
+ return transactions from start_height until the current chain tip and
+ unconfirmed transactions. If no end_height is provided, the call will
+ default to this option.
+ */
+ int32 end_height = 2;
+}
+
+message TransactionDetails {
+ // The list of transactions relevant to the wallet.
+ repeated Transaction transactions = 1;
+}
+
+message FeeLimit {
+ oneof limit {
+ /*
+ The fee limit expressed as a fixed amount of satoshis.
+
+ The fields fixed and fixed_msat are mutually exclusive.
+ */
+ int64 fixed = 1;
+
+ /*
+ The fee limit expressed as a fixed amount of millisatoshis.
+
+ The fields fixed and fixed_msat are mutually exclusive.
+ */
+ int64 fixed_msat = 3;
+
+ // The fee limit expressed as a percentage of the payment amount.
+ int64 percent = 2;
+ }
+}
+
+message SendRequest {
+ /*
+ The identity pubkey of the payment recipient. When using REST, this field
+ must be encoded as base64.
+ */
+ bytes dest = 1;
+
+ /*
+ The hex-encoded identity pubkey of the payment recipient. Deprecated now
+ that the REST gateway supports base64 encoding of bytes fields.
+ */
+ string dest_string = 2 [deprecated = true];
+
+ /*
+ The amount to send expressed in satoshis.
+
+ The fields amt and amt_msat are mutually exclusive.
+ */
+ int64 amt = 3;
+
+ /*
+ The amount to send expressed in millisatoshis.
+
+ The fields amt and amt_msat are mutually exclusive.
+ */
+ int64 amt_msat = 12;
+
+ /*
+ The hash to use within the payment's HTLC. When using REST, this field
+ must be encoded as base64.
+ */
+ bytes payment_hash = 4;
+
+ /*
+ The hex-encoded hash to use within the payment's HTLC. Deprecated now
+ that the REST gateway supports base64 encoding of bytes fields.
+ */
+ string payment_hash_string = 5 [deprecated = true];
+
+ /*
+ 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.
+ */
+ string payment_request = 6;
+
+ /*
+ The CLTV delta from the current height that should be used to set the
+ timelock for the final hop.
+ */
+ int32 final_cltv_delta = 7;
+
+ /*
+ 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.
+ */
+ FeeLimit fee_limit = 8;
+
+ /*
+ The channel id of the channel that must be taken to the first hop. If zero,
+ any channel may be used.
+ */
+ uint64 outgoing_chan_id = 9 [jstype = JS_STRING];
+
+ /*
+ The pubkey of the last hop of the route. If empty, any hop may be used.
+ */
+ bytes last_hop_pubkey = 13;
+
+ /*
+ An optional maximum total time lock for the route. This should not exceed
+ lnd's `--max-cltv-expiry` setting. If zero, then the value of
+ `--max-cltv-expiry` is enforced.
+ */
+ uint32 cltv_limit = 10;
+
+ /*
+ An optional field that can be used to pass an arbitrary set of TLV records
+ to a peer which understands the new records. This can be used to pass
+ application specific data during the payment attempt. Record types are
+ required to be in the custom range >= 65536. When using REST, the values
+ must be encoded as base64.
+ */
+ map<uint64, bytes> dest_custom_records = 11;
+
+ // If set, circular payments to self are permitted.
+ bool allow_self_payment = 14;
+
+ /*
+ Features assumed to be supported by the final node. All transitive feature
+ dependencies must also be set properly. For a given feature bit pair, either
+ optional or remote may be set, but not both. If this field is nil or empty,
+ the router will try to load destination features from the graph as a
+ fallback.
+ */
+ repeated FeatureBit dest_features = 15;
+}
+
+message SendResponse {
+ string payment_error = 1;
+ bytes payment_preimage = 2;
+ Route payment_route = 3;
+ bytes payment_hash = 4;
+}
+
+message SendToRouteRequest {
+ /*
+ The payment hash to use for the HTLC. When using REST, this field must be
+ encoded as base64.
+ */
+ bytes payment_hash = 1;
+
+ /*
+ An optional hex-encoded payment hash to be used for the HTLC. Deprecated now
+ that the REST gateway supports base64 encoding of bytes fields.
+ */
+ string payment_hash_string = 2 [deprecated = true];
+
+ reserved 3;
+
+ // Route that should be used to attempt to complete the payment.
+ Route route = 4;
+}
+
+message ChannelAcceptRequest {
+ // The pubkey of the node that wishes to open an inbound channel.
+ bytes node_pubkey = 1;
+
+ // The hash of the genesis block that the proposed channel resides in.
+ bytes chain_hash = 2;
+
+ // The pending channel id.
+ bytes pending_chan_id = 3;
+
+ // The funding amount in satoshis that initiator wishes to use in the
+ // channel.
+ uint64 funding_amt = 4;
+
+ // The push amount of the proposed channel in millisatoshis.
+ uint64 push_amt = 5;
+
+ // The dust limit of the initiator's commitment tx.
+ uint64 dust_limit = 6;
+
+ // The maximum amount of coins in millisatoshis that can be pending in this
+ // channel.
+ uint64 max_value_in_flight = 7;
+
+ // The minimum amount of satoshis the initiator requires us to have at all
+ // times.
+ uint64 channel_reserve = 8;
+
+ // The smallest HTLC in millisatoshis that the initiator will accept.
+ uint64 min_htlc = 9;
+
+ // The initial fee rate that the initiator suggests for both commitment
+ // transactions.
+ uint64 fee_per_kw = 10;
+
+ /*
+ The number of blocks to use for the relative time lock in the pay-to-self
+ output of both commitment transactions.
+ */
+ uint32 csv_delay = 11;
+
+ // The total number of incoming HTLC's that the initiator will accept.
+ uint32 max_accepted_htlcs = 12;
+
+ // A bit-field which the initiator uses to specify proposed channel
+ // behavior.
+ uint32 channel_flags = 13;
+}
+
+message ChannelAcceptResponse {
+ // Whether or not the client accepts the channel.
+ bool accept = 1;
+
+ // The pending channel id to which this response applies.
+ bytes pending_chan_id = 2;
+}
+
+message ChannelPoint {
+ oneof funding_txid {
+ /*
+ Txid of the funding transaction. When using REST, this field must be
+ encoded as base64.
+ */
+ bytes funding_txid_bytes = 1;
+
+ /*
+ Hex-encoded string representing the byte-reversed hash of the funding
+ transaction.
+ */
+ string funding_txid_str = 2;
+ }
+
+ // The index of the output of the funding transaction
+ uint32 output_index = 3;
+}
+
+message OutPoint {
+ // Raw bytes representing the transaction id.
+ bytes txid_bytes = 1;
+
+ // Reversed, hex-encoded string representing the transaction id.
+ string txid_str = 2;
+
+ // The index of the output on the transaction.
+ uint32 output_index = 3;
+}
+
+message LightningAddress {
+ // The identity pubkey of the Lightning node
+ string pubkey = 1;
+
+ // The network location of the lightning node, e.g. `69.69.69.69:1337` or
+ // `localhost:10011`
+ string host = 2;
+}
+
+message EstimateFeeRequest {
+ // The map from addresses to amounts for the transaction.
+ map<string, int64> AddrToAmount = 1;
+
+ // The target number of blocks that this transaction should be confirmed
+ // by.
+ int32 target_conf = 2;
+}
+
+message EstimateFeeResponse {
+ // The total fee in satoshis.
+ int64 fee_sat = 1;
+
+ // The fee rate in satoshi/byte.
+ int64 feerate_sat_per_byte = 2;
+}
+
+message SendManyRequest {
+ // The map from addresses to amounts
+ map<string, int64> AddrToAmount = 1;
+
+ // The target number of blocks that this transaction should be confirmed
+ // by.
+ int32 target_conf = 3;
+
+ // A manual fee rate set in sat/byte that should be used when crafting the
+ // transaction.
+ int64 sat_per_byte = 5;
+
+ // An optional label for the transaction, limited to 500 characters.
+ string label = 6;
+}
+message SendManyResponse {
+ // The id of the transaction
+ string txid = 1;
+}
+
+message SendCoinsRequest {
+ // The address to send coins to
+ string addr = 1;
+
+ // The amount in satoshis to send
+ int64 amount = 2;
+
+ // The target number of blocks that this transaction should be confirmed
+ // by.
+ int32 target_conf = 3;
+
+ // A manual fee rate set in sat/byte that should be used when crafting the
+ // transaction.
+ int64 sat_per_byte = 5;
+
+ /*
+ If set, then the amount field will be ignored, and lnd will attempt to
+ send all the coins under control of the internal wallet to the specified
+ address.
+ */
+ bool send_all = 6;
+
+ // An optional label for the transaction, limited to 500 characters.
+ string label = 7;
+}
+message SendCoinsResponse {
+ // The transaction ID of the transaction
+ string txid = 1;
+}
+
+message ListUnspentRequest {
+ // The minimum number of confirmations to be included.
+ int32 min_confs = 1;
+
+ // The maximum number of confirmations to be included.
+ int32 max_confs = 2;
+}
+message ListUnspentResponse {
+ // A list of utxos
+ repeated Utxo utxos = 1;
+}
+
+/*
+`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)
+*/
+enum AddressType {
+ WITNESS_PUBKEY_HASH = 0;
+ NESTED_PUBKEY_HASH = 1;
+ UNUSED_WITNESS_PUBKEY_HASH = 2;
+ UNUSED_NESTED_PUBKEY_HASH = 3;
+}
+
+message NewAddressRequest {
+ // The address type
+ AddressType type = 1;
+}
+message NewAddressResponse {
+ // The newly generated wallet address
+ string address = 1;
+}
+
+message SignMessageRequest {
+ /*
+ The message to be signed. When using REST, this field must be encoded as
+ base64.
+ */
+ bytes msg = 1;
+}
+message SignMessageResponse {
+ // The signature for the given message
+ string signature = 1;
+}
+
+message VerifyMessageRequest {
+ /*
+ The message over which the signature is to be verified. When using REST,
+ this field must be encoded as base64.
+ */
+ bytes msg = 1;
+
+ // The signature to be verified over the given message
+ string signature = 2;
+}
+message VerifyMessageResponse {
+ // Whether the signature was valid over the given message
+ bool valid = 1;
+
+ // The pubkey recovered from the signature
+ string pubkey = 2;
+}
+
+message ConnectPeerRequest {
+ // Lightning address of the peer, in the format `<pubkey>@host`
+ LightningAddress addr = 1;
+
+ /* If set, the daemon will attempt to persistently connect to the target
+ * peer. Otherwise, the call will be synchronous. */
+ bool perm = 2;
+}
+message ConnectPeerResponse {
+}
+
+message DisconnectPeerRequest {
+ // The pubkey of the node to disconnect from
+ string pub_key = 1;
+}
+message DisconnectPeerResponse {
+}
+
+message HTLC {
+ bool incoming = 1;
+ int64 amount = 2;
+ bytes hash_lock = 3;
+ uint32 expiration_height = 4;
+}
+
+enum CommitmentType {
+ /*
+ A channel using the legacy commitment format having tweaked to_remote
+ keys.
+ */
+ LEGACY = 0;
+
+ /*
+ A channel that uses the modern commitment format where the key in the
+ output of the remote party does not change each state. This makes back
+ up and recovery easier as when the channel is closed, the funds go
+ directly to that key.
+ */
+ STATIC_REMOTE_KEY = 1;
+
+ /*
+ A channel that uses a commitment format that has anchor outputs on the
+ commitments, allowing fee bumping after a force close transaction has
+ been broadcast.
+ */
+ ANCHORS = 2;
+
+ /*
+ Returned when the commitment type isn't known or unavailable.
+ */
+ UNKNOWN_COMMITMENT_TYPE = 999;
+}
+
+message ChannelConstraints {
+ /*
+ The CSV delay expressed in relative blocks. If the channel is force closed,
+ we will need to wait for this many blocks before we can regain our funds.
+ */
+ uint32 csv_delay = 1;
+
+ // The minimum satoshis this node is required to reserve in its balance.
+ uint64 chan_reserve_sat = 2;
+
+ // The dust limit (in satoshis) of the initiator's commitment tx.
+ uint64 dust_limit_sat = 3;
+
+ // The maximum amount of coins in millisatoshis that can be pending in this
+ // channel.
+ uint64 max_pending_amt_msat = 4;
+
+ // The smallest HTLC in millisatoshis that the initiator will accept.
+ uint64 min_htlc_msat = 5;
+
+ // The total number of incoming HTLC's that the initiator will accept.
+ uint32 max_accepted_htlcs = 6;
+}
+
+message Channel {
+ // Whether this channel is active or not
+ bool active = 1;
+
+ // The identity pubkey of the remote node
+ string remote_pubkey = 2;
+
+ /*
+ 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.
+ */
+ string channel_point = 3;
+
+ /*
+ 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.
+ */
+ uint64 chan_id = 4 [jstype = JS_STRING];
+
+ // The total amount of funds held in this channel
+ int64 capacity = 5;
+
+ // This node's current balance in this channel
+ int64 local_balance = 6;
+
+ // The counterparty's current balance in this channel
+ int64 remote_balance = 7;
+
+ /*
+ 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_fee = 8;
+
+ // The weight of the commitment transaction
+ int64 commit_weight = 9;
+
+ /*
+ 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.
+ */
+ int64 fee_per_kw = 10;
+
+ // The unsettled balance in this channel
+ int64 unsettled_balance = 11;
+
+ /*
+ The total number of satoshis we've sent within this channel.
+ */
+ int64 total_satoshis_sent = 12;
+
+ /*
+ The total number of satoshis we've received within this channel.
+ */
+ int64 total_satoshis_received = 13;
+
+ /*
+ The total number of updates conducted within this channel.
+ */
+ uint64 num_updates = 14;
+
+ /*
+ The list of active, uncleared HTLCs currently pending within the channel.
+ */
+ repeated HTLC pending_htlcs = 15;
+
+ /*
+ Deprecated. The CSV delay expressed in relative blocks. If the channel is
+ force closed, we will need to wait for this many blocks before we can regain
+ our funds.
+ */
+ uint32 csv_delay = 16 [deprecated = true];
+
+ // Whether this channel is advertised to the network or not.
+ bool private = 17;
+
+ // True if we were the ones that created the channel.
+ bool initiator = 18;
+
+ // A set of flags showing the current state of the channel.
+ string chan_status_flags = 19;
+
+ // Deprecated. The minimum satoshis this node is required to reserve in its
+ // balance.
+ int64 local_chan_reserve_sat = 20 [deprecated = true];
+
+ /*
+ Deprecated. The minimum satoshis the other node is required to reserve in
+ its balance.
+ */
+ int64 remote_chan_reserve_sat = 21 [deprecated = true];
+
+ // Deprecated. Use commitment_type.
+ bool static_remote_key = 22 [deprecated = true];
+
+ // The commitment type used by this channel.
+ CommitmentType commitment_type = 26;
+
+ /*
+ The number of seconds that the channel has been monitored by the channel
+ scoring system. Scores are currently not persisted, so this value may be
+ less than the lifetime of the channel [EXPERIMENTAL].
+ */
+ int64 lifetime = 23;
+
+ /*
+ The number of seconds that the remote peer has been observed as being online
+ by the channel scoring system over the lifetime of the channel
+ [EXPERIMENTAL].
+ */
+ int64 uptime = 24;
+
+ /*
+ Close address is the address that we will enforce payout to on cooperative
+ close if the channel was opened utilizing option upfront shutdown. This
+ value can be set on channel open by setting close_address in an open channel
+ request. If this value is not set, you can still choose a payout address by
+ cooperatively closing with the delivery_address field set.
+ */
+ string close_address = 25;
+
+ /*
+ The amount that the initiator of the channel optionally pushed to the remote
+ party on channel open. This amount will be zero if the channel initiator did
+ not push any funds to the remote peer. If the initiator field is true, we
+ pushed this amount to our peer, if it is false, the remote peer pushed this
+ amount to us.
+ */
+ uint64 push_amount_sat = 27;
+
+ /*
+ This uint32 indicates if this channel is to be considered 'frozen'. A
+ frozen channel doest not allow a cooperative channel close by the
+ initiator. The thaw_height is the height that this restriction stops
+ applying to the channel. This field is optional, not setting it or using a
+ value of zero will mean the channel has no additional restrictions. The
+ height can be interpreted in two ways: as a relative height if the value is
+ less than 500,000, or as an absolute height otherwise.
+ */
+ uint32 thaw_height = 28;
+
+ // List constraints for the local node.
+ ChannelConstraints local_constraints = 29;
+
+ // List constraints for the remote node.
+ ChannelConstraints remote_constraints = 30;
+}
+
+message ListChannelsRequest {
+ bool active_only = 1;
+ bool inactive_only = 2;
+ bool public_only = 3;
+ bool private_only = 4;
+
+ /*
+ Filters the response for channels with a target peer's pubkey. If peer is
+ empty, all channels will be returned.
+ */
+ bytes peer = 5;
+}
+message ListChannelsResponse {
+ // The list of active channels
+ repeated Channel channels = 11;
+}
+
+enum Initiator {
+ INITIATOR_UNKNOWN = 0;
+ INITIATOR_LOCAL = 1;
+ INITIATOR_REMOTE = 2;
+ INITIATOR_BOTH = 3;
+}
+
+message ChannelCloseSummary {
+ // The outpoint (txid:index) of the funding transaction.
+ string channel_point = 1;
+
+ // The unique channel ID for the channel.
+ uint64 chan_id = 2 [jstype = JS_STRING];
+
+ // The hash of the genesis block that this channel resides within.
+ string chain_hash = 3;
+
+ // The txid of the transaction which ultimately closed this channel.
+ string closing_tx_hash = 4;
+
+ // Public key of the remote peer that we formerly had a channel with.
+ string remote_pubkey = 5;
+
+ // Total capacity of the channel.
+ int64 capacity = 6;
+
+ // Height at which the funding transaction was spent.
+ uint32 close_height = 7;
+
+ // Settled balance at the time of channel closure
+ int64 settled_balance = 8;
+
+ // The sum of all the time-locked outputs at the time of channel closure
+ int64 time_locked_balance = 9;
+
+ enum ClosureType {
+ COOPERATIVE_CLOSE = 0;
+ LOCAL_FORCE_CLOSE = 1;
+ REMOTE_FORCE_CLOSE = 2;
+ BREACH_CLOSE = 3;
+ FUNDING_CANCELED = 4;
+ ABANDONED = 5;
+ }
+
+ // Details on how the channel was closed.
+ ClosureType close_type = 10;
+
+ /*
+ Open initiator is the party that initiated opening the channel. Note that
+ this value may be unknown if the channel was closed before we migrated to
+ store open channel information after close.
+ */
+ Initiator open_initiator = 11;
+
+ /*
+ Close initiator indicates which party initiated the close. This value will
+ be unknown for channels that were cooperatively closed before we started
+ tracking cooperative close initiators. Note that this indicates which party
+ initiated a close, and it is possible for both to initiate cooperative or
+ force closes, although only one party's close will be confirmed on chain.
+ */
+ Initiator close_initiator = 12;
+
+ repeated Resolution resolutions = 13;
+}
+
+enum ResolutionType {
+ TYPE_UNKNOWN = 0;
+
+ // We resolved an anchor output.
+ ANCHOR = 1;
+
+ /*
+ We are resolving an incoming htlc on chain. This if this htlc is
+ claimed, we swept the incoming htlc with the preimage. If it is timed
+ out, our peer swept the timeout path.
+ */
+ INCOMING_HTLC = 2;
+
+ /*
+ We are resolving an outgoing htlc on chain. If this htlc is claimed,
+ the remote party swept the htlc with the preimage. If it is timed out,
+ we swept it with the timeout path.
+ */
+ OUTGOING_HTLC = 3;
+
+ // We force closed and need to sweep our time locked commitment output.
+ COMMIT = 4;
+}
+
+enum ResolutionOutcome {
+ // Outcome unknown.
+ OUTCOME_UNKNOWN = 0;
+
+ // An output was claimed on chain.
+ CLAIMED = 1;
+
+ // An output was left unclaimed on chain.
+ UNCLAIMED = 2;
+
+ /*
+ ResolverOutcomeAbandoned indicates that an output that we did not
+ claim on chain, for example an anchor that we did not sweep and a
+ third party claimed on chain, or a htlc that we could not decode
+ so left unclaimed.
+ */
+ ABANDONED = 3;
+
+ /*
+ If we force closed our channel, our htlcs need to be claimed in two
+ stages. This outcome represents the broadcast of a timeout or success
+ transaction for this two stage htlc claim.
+ */
+ FIRST_STAGE = 4;
+
+ // A htlc was timed out on chain.
+ TIMEOUT = 5;
+}
+
+message Resolution {
+ // The type of output we are resolving.
+ ResolutionType resolution_type = 1;
+
+ // The outcome of our on chain action that resolved the outpoint.
+ ResolutionOutcome outcome = 2;
+
+ // The outpoint that was spent by the resolution.
+ OutPoint outpoint = 3;
+
+ // The amount that was claimed by the resolution.
+ uint64 amount_sat = 4;
+
+ // The hex-encoded transaction ID of the sweep transaction that spent the
+ // output.
+ string sweep_txid = 5;
+}
+
+message ClosedChannelsRequest {
+ bool cooperative = 1;
+ bool local_force = 2;
+ bool remote_force = 3;
+ bool breach = 4;
+ bool funding_canceled = 5;
+ bool abandoned = 6;
+}
+
+message ClosedChannelsResponse {
+ repeated ChannelCloseSummary channels = 1;
+}
+
+message Peer {
+ // The identity pubkey of the peer
+ string pub_key = 1;
+
+ // Network address of the peer; eg `127.0.0.1:10011`
+ string address = 3;
+
+ // Bytes of data transmitted to this peer
+ uint64 bytes_sent = 4;
+
+ // Bytes of data transmitted from this peer
+ uint64 bytes_recv = 5;
+
+ // Satoshis sent to this peer
+ int64 sat_sent = 6;
+
+ // Satoshis received from this peer
+ int64 sat_recv = 7;
+
+ // A channel is inbound if the counterparty initiated the channel
+ bool inbound = 8;
+
+ // Ping time to this peer
+ int64 ping_time = 9;
+
+ enum SyncType {
+ /*
+ Denotes that we cannot determine the peer's current sync type.
+ */
+ UNKNOWN_SYNC = 0;
+
+ /*
+ Denotes that we are actively receiving new graph updates from the peer.
+ */
+ ACTIVE_SYNC = 1;
+
+ /*
+ Denotes that we are not receiving new graph updates from the peer.
+ */
+ PASSIVE_SYNC = 2;
+ }
+
+ // The type of sync we are currently performing with this peer.
+ SyncType sync_type = 10;
+
+ // Features advertised by the remote peer in their init message.
+ map<uint32, Feature> features = 11;
+
+ /*
+ The latest errors received from our peer with timestamps, limited to the 10
+ most recent errors. These errors are tracked across peer connections, but
+ are not persisted across lnd restarts. Note that these errors are only
+ stored for peers that we have channels open with, to prevent peers from
+ spamming us with errors at no cost.
+ */
+ repeated TimestampedError errors = 12;
+}
+
+message TimestampedError {
+ // The unix timestamp in seconds when the error occurred.
+ uint64 timestamp = 1;
+
+ // The string representation of the error sent by our peer.
+ string error = 2;
+}
+
+message ListPeersRequest {
+ /*
+ If true, only the last error that our peer sent us will be returned with
+ the peer's information, rather than the full set of historic errors we have
+ stored.
+ */
+ bool latest_error = 1;
+}
+message ListPeersResponse {
+ // The list of currently connected peers
+ repeated Peer peers = 1;
+}
+
+message PeerEventSubscription {
+}
+
+message PeerEvent {
+ // The identity pubkey of the peer.
+ string pub_key = 1;
+
+ enum EventType {
+ PEER_ONLINE = 0;
+ PEER_OFFLINE = 1;
+ }
+
+ EventType type = 2;
+}
+
+message GetInfoRequest {
+}
+message GetInfoResponse {
+ // The version of the LND software that the node is running.
+ string version = 14;
+
+ // The SHA1 commit hash that the daemon is compiled with.
+ string commit_hash = 20;
+
+ // The identity pubkey of the current node.
+ string identity_pubkey = 1;
+
+ // If applicable, the alias of the current node, e.g. "bob"
+ string alias = 2;
+
+ // The color of the current node in hex code format
+ string color = 17;
+
+ // Number of pending channels
+ uint32 num_pending_channels = 3;
+
+ // Number of active channels
+ uint32 num_active_channels = 4;
+
+ // Number of inactive channels
+ uint32 num_inactive_channels = 15;
+
+ // Number of peers
+ uint32 num_peers = 5;
+
+ // The node's current view of the height of the best block
+ uint32 block_height = 6;
+
+ // The node's current view of the hash of the best block
+ string block_hash = 8;
+
+ // Timestamp of the block best known to the wallet
+ int64 best_header_timestamp = 13;
+
+ // Whether the wallet's view is synced to the main chain
+ bool synced_to_chain = 9;
+
+ // Whether we consider ourselves synced with the public channel graph.
+ bool synced_to_graph = 18;
+
+ /*
+ Whether the current node is connected to testnet. This field is
+ deprecated and the network field should be used instead
+ **/
+ bool testnet = 10 [deprecated = true];
+
+ reserved 11;
+
+ // A list of active chains the node is connected to
+ repeated Chain chains = 16;
+
+ // The URIs of the current node.
+ repeated string uris = 12;
+
+ /*
+ Features that our node has advertised in our init message, node
+ announcements and invoices.
+ */
+ map<uint32, Feature> features = 19;
+}
+
+message GetRecoveryInfoRequest {
+}
+message GetRecoveryInfoResponse {
+ // Whether the wallet is in recovery mode
+ bool recovery_mode = 1;
+
+ // Whether the wallet recovery progress is finished
+ bool recovery_finished = 2;
+
+ // The recovery progress, ranging from 0 to 1.
+ double progress = 3;
+}
+
+message Chain {
+ // The blockchain the node is on (eg bitcoin, litecoin)
+ string chain = 1;
+
+ // The network the node is on (eg regtest, testnet, mainnet)
+ string network = 2;
+}
+
+message ConfirmationUpdate {
+ bytes block_sha = 1;
+ int32 block_height = 2;
+
+ uint32 num_confs_left = 3;
+}
+
+message ChannelOpenUpdate {
+ ChannelPoint channel_point = 1;
+}
+
+message ChannelCloseUpdate {
+ bytes closing_txid = 1;
+
+ bool success = 2;
+}
+
+message CloseChannelRequest {
+ /*
+ 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.
+ */
+ ChannelPoint channel_point = 1;
+
+ // If true, then the channel will be closed forcibly. This means the
+ // current commitment transaction will be signed and broadcast.
+ bool force = 2;
+
+ // The target number of blocks that the closure transaction should be
+ // confirmed by.
+ int32 target_conf = 3;
+
+ // A manual fee rate set in sat/byte that should be used when crafting the
+ // closure transaction.
+ int64 sat_per_byte = 4;
+
+ /*
+ An optional address to send funds to in the case of a cooperative close.
+ If the channel was opened with an upfront shutdown script and this field
+ is set, the request to close will fail because the channel must pay out
+ to the upfront shutdown addresss.
+ */
+ string delivery_address = 5;
+}
+
+message CloseStatusUpdate {
+ oneof update {
+ PendingUpdate close_pending = 1;
+ ChannelCloseUpdate chan_close = 3;
+ }
+}
+
+message PendingUpdate {
+ bytes txid = 1;
+ uint32 output_index = 2;
+}
+
+message ReadyForPsbtFunding {
+ /*
+ The P2WSH address of the channel funding multisig address that the below
+ specified amount in satoshis needs to be sent to.
+ */
+ string funding_address = 1;
+
+ /*
+ The exact amount in satoshis that needs to be sent to the above address to
+ fund the pending channel.
+ */
+ int64 funding_amount = 2;
+
+ /*
+ A raw PSBT that contains the pending channel output. If a base PSBT was
+ provided in the PsbtShim, this is the base PSBT with one additional output.
+ If no base PSBT was specified, this is an otherwise empty PSBT with exactly
+ one output.
+ */
+ bytes psbt = 3;
+}
+
+message OpenChannelRequest {
+ /*
+ The pubkey of the node to open a channel with. When using REST, this field
+ must be encoded as base64.
+ */
+ bytes node_pubkey = 2;
+
+ /*
+ The hex encoded pubkey of the node to open a channel with. Deprecated now
+ that the REST gateway supports base64 encoding of bytes fields.
+ */
+ string node_pubkey_string = 3 [deprecated = true];
+
+ // The number of satoshis the wallet should commit to the channel
+ int64 local_funding_amount = 4;
+
+ // The number of satoshis to push to the remote side as part of the initial
+ // commitment state
+ int64 push_sat = 5;
+
+ // The target number of blocks that the funding transaction should be
+ // confirmed by.
+ int32 target_conf = 6;
+
+ // A manual fee rate set in sat/byte that should be used when crafting the
+ // funding transaction.
+ int64 sat_per_byte = 7;
+
+ // Whether this channel should be private, not announced to the greater
+ // network.
+ bool private = 8;
+
+ // The minimum value in millisatoshi we will require for incoming HTLCs on
+ // the channel.
+ int64 min_htlc_msat = 9;
+
+ // The delay we require on the remote's commitment transaction. If this is
+ // not set, it will be scaled automatically with the channel size.
+ uint32 remote_csv_delay = 10;
+
+ // The minimum number of confirmations each one of your outputs used for
+ // the funding transaction must satisfy.
+ int32 min_confs = 11;
+
+ // Whether unconfirmed outputs should be used as inputs for the funding
+ // transaction.
+ bool spend_unconfirmed = 12;
+
+ /*
+ Close address is an optional address which specifies the address to which
+ funds should be paid out to upon cooperative close. This field may only be
+ set if the peer supports the option upfront feature bit (call listpeers
+ to check). The remote peer will only accept cooperative closes to this
+ address if it is set.
+
+ Note: If this value is set on channel creation, you will *not* be able to
+ cooperatively close out to a different address.
+ */
+ string close_address = 13;
+
+ /*
+ Funding shims are an optional argument that allow the caller to intercept
+ certain funding functionality. For example, a shim can be provided to use a
+ particular key for the commitment key (ideally cold) rather than use one
+ that is generated by the wallet as normal, or signal that signing will be
+ carried out in an interactive manner (PSBT based).
+ */
+ FundingShim funding_shim = 14;
+
+ /*
+ The maximum amount of coins in millisatoshi that can be pending within
+ the channel. It only applies to the remote party.
+ */
+ uint64 remote_max_value_in_flight_msat = 15;
+}
+message OpenStatusUpdate {
+ oneof update {
+ /*
+ Signals that the channel is now fully negotiated and the funding
+ transaction published.
+ */
+ PendingUpdate chan_pending = 1;
+
+ /*
+ Signals that the channel's funding transaction has now reached the
+ required number of confirmations on chain and can be used.
+ */
+ ChannelOpenUpdate chan_open = 3;
+
+ /*
+ Signals that the funding process has been suspended and the construction
+ of a PSBT that funds the channel PK script is now required.
+ */
+ ReadyForPsbtFunding psbt_fund = 5;
+ }
+
+ /*
+ The pending channel ID of the created channel. This value may be used to
+ further the funding flow manually via the FundingStateStep method.
+ */
+ bytes pending_chan_id = 4;
+}
+
+message KeyLocator {
+ // The family of key being identified.
+ int32 key_family = 1;
+
+ // The precise index of the key being identified.
+ int32 key_index = 2;
+}
+
+message KeyDescriptor {
+ /*
+ The raw bytes of the key being identified.
+ */
+ bytes raw_key_bytes = 1;
+
+ /*
+ The key locator that identifies which key to use for signing.
+ */
+ KeyLocator key_loc = 2;
+}
+
+message ChanPointShim {
+ /*
+ The size of the pre-crafted output to be used as the channel point for this
+ channel funding.
+ */
+ int64 amt = 1;
+
+ // The target channel point to refrence in created commitment transactions.
+ ChannelPoint chan_point = 2;
+
+ // Our local key to use when creating the multi-sig output.
+ KeyDescriptor local_key = 3;
+
+ // The key of the remote party to use when creating the multi-sig output.
+ bytes remote_key = 4;
+
+ /*
+ If non-zero, then this will be used as the pending channel ID on the wire
+ protocol to initate the funding request. This is an optional field, and
+ should only be set if the responder is already expecting a specific pending
+ channel ID.
+ */
+ bytes pending_chan_id = 5;
+
+ /*
+ This uint32 indicates if this channel is to be considered 'frozen'. A frozen
+ channel does not allow a cooperative channel close by the initiator. The
+ thaw_height is the height that this restriction stops applying to the
+ channel. The height can be interpreted in two ways: as a relative height if
+ the value is less than 500,000, or as an absolute height otherwise.
+ */
+ uint32 thaw_height = 6;
+}
+
+message PsbtShim {
+ /*
+ A unique identifier of 32 random bytes that will be used as the pending
+ channel ID to identify the PSBT state machine when interacting with it and
+ on the wire protocol to initiate the funding request.
+ */
+ bytes pending_chan_id = 1;
+
+ /*
+ An optional base PSBT the new channel output will be added to. If this is
+ non-empty, it must be a binary serialized PSBT.
+ */
+ bytes base_psbt = 2;
+
+ /*
+ If a channel should be part of a batch (multiple channel openings in one
+ transaction), it can be dangerous if the whole batch transaction is
+ published too early before all channel opening negotiations are completed.
+ This flag prevents this particular channel from broadcasting the transaction
+ after the negotiation with the remote peer. In a batch of channel openings
+ this flag should be set to true for every channel but the very last.
+ */
+ bool no_publish = 3;
+}
+
+message FundingShim {
+ oneof shim {
+ /*
+ A channel shim where the channel point was fully constructed outside
+ of lnd's wallet and the transaction might already be published.
+ */
+ ChanPointShim chan_point_shim = 1;
+
+ /*
+ A channel shim that uses a PSBT to fund and sign the channel funding
+ transaction.
+ */
+ PsbtShim psbt_shim = 2;
+ }
+}
+
+message FundingShimCancel {
+ // The pending channel ID of the channel to cancel the funding shim for.
+ bytes pending_chan_id = 1;
+}
+
+message FundingPsbtVerify {
+ /*
+ The funded but not yet signed PSBT that sends the exact channel capacity
+ amount to the PK script returned in the open channel message in a previous
+ step.
+ */
+ bytes funded_psbt = 1;
+
+ // The pending channel ID of the channel to get the PSBT for.
+ bytes pending_chan_id = 2;
+}
+
+message FundingPsbtFinalize {
+ /*
+ The funded PSBT that contains all witness data to send the exact channel
+ capacity amount to the PK script returned in the open channel message in a
+ previous step.
+ */
+ bytes signed_psbt = 1;
+
+ // The pending channel ID of the channel to get the PSBT for.
+ bytes pending_chan_id = 2;
+}
+
+message FundingTransitionMsg {
+ oneof trigger {
+ /*
+ The funding shim to register. This should be used before any
+ channel funding has began by the remote party, as it is intended as a
+ preparatory step for the full channel funding.
+ */
+ FundingShim shim_register = 1;
+
+ // Used to cancel an existing registered funding shim.
+ FundingShimCancel shim_cancel = 2;
+
+ /*
+ Used to continue a funding flow that was initiated to be executed
+ through a PSBT. This step verifies that the PSBT contains the correct
+ outputs to fund the channel.
+ */
+ FundingPsbtVerify psbt_verify = 3;
+
+ /*
+ Used to continue a funding flow that was initiated to be executed
+ through a PSBT. This step finalizes the funded and signed PSBT, finishes
+ negotiation with the peer and finally publishes the resulting funding
+ transaction.
+ */
+ FundingPsbtFinalize psbt_finalize = 4;
+ }
+}
+
+message FundingStateStepResp {
+}
+
+message PendingHTLC {
+ // The direction within the channel that the htlc was sent
+ bool incoming = 1;
+
+ // The total value of the htlc
+ int64 amount = 2;
+
+ // The final output to be swept back to the user's wallet
+ string outpoint = 3;
+
+ // The next block height at which we can spend the current stage
+ uint32 maturity_height = 4;
+
+ /*
+ The number of blocks remaining until the current stage can be swept.
+ Negative values indicate how many blocks have passed since becoming
+ mature.
+ */
+ int32 blocks_til_maturity = 5;
+
+ // Indicates whether the htlc is in its first or second stage of recovery
+ uint32 stage = 6;
+}
+
+message PendingChannelsRequest {
+}
+message PendingChannelsResponse {
+ message PendingChannel {
+ string remote_node_pub = 1;
+ string channel_point = 2;
+
+ int64 capacity = 3;
+
+ int64 local_balance = 4;
+ int64 remote_balance = 5;
+
+ // The minimum satoshis this node is required to reserve in its
+ // balance.
+ int64 local_chan_reserve_sat = 6;
+
+ /*
+ The minimum satoshis the other node is required to reserve in its
+ balance.
+ */
+ int64 remote_chan_reserve_sat = 7;
+
+ // The party that initiated opening the channel.
+ Initiator initiator = 8;
+
+ // The commitment type used by this channel.
+ CommitmentType commitment_type = 9;
+ }
+
+ message PendingOpenChannel {
+ // The pending channel
+ PendingChannel channel = 1;
+
+ // The height at which this channel will be confirmed
+ uint32 confirmation_height = 2;
+
+ /*
+ 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_fee = 4;
+
+ // The weight of the commitment transaction
+ int64 commit_weight = 5;
+
+ /*
+ 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.
+ */
+ int64 fee_per_kw = 6;
+ }
+
+ message WaitingCloseChannel {
+ // The pending channel waiting for closing tx to confirm
+ PendingChannel channel = 1;
+
+ // The balance in satoshis encumbered in this channel
+ int64 limbo_balance = 2;
+
+ /*
+ A list of valid commitment transactions. Any of these can confirm at
+ this point.
+ */
+ Commitments commitments = 3;
+ }
+
+ message Commitments {
+ // Hash of the local version of the commitment tx.
+ string local_txid = 1;
+
+ // Hash of the remote version of the commitment tx.
+ string remote_txid = 2;
+
+ // Hash of the remote pending version of the commitment tx.
+ string remote_pending_txid = 3;
+
+ /*
+ The amount in satoshis calculated to be paid in fees for the local
+ commitment.
+ */
+ uint64 local_commit_fee_sat = 4;
+
+ /*
+ The amount in satoshis calculated to be paid in fees for the remote
+ commitment.
+ */
+ uint64 remote_commit_fee_sat = 5;
+
+ /*
+ The amount in satoshis calculated to be paid in fees for the remote
+ pending commitment.
+ */
+ uint64 remote_pending_commit_fee_sat = 6;
+ }
+
+ message ClosedChannel {
+ // The pending channel to be closed
+ PendingChannel channel = 1;
+
+ // The transaction id of the closing transaction
+ string closing_txid = 2;
+ }
+
+ message ForceClosedChannel {
+ // The pending channel to be force closed
+ PendingChannel channel = 1;
+
+ // The transaction id of the closing transaction
+ string closing_txid = 2;
+
+ // The balance in satoshis encumbered in this pending channel
+ int64 limbo_balance = 3;
+
+ // The height at which funds can be swept into the wallet
+ uint32 maturity_height = 4;
+
+ /*
+ Remaining # of blocks until the commitment output can be swept.
+ Negative values indicate how many blocks have passed since becoming
+ mature.
+ */
+ int32 blocks_til_maturity = 5;
+
+ // The total value of funds successfully recovered from this channel
+ int64 recovered_balance = 6;
+
+ repeated PendingHTLC pending_htlcs = 8;
+
+ enum AnchorState {
+ LIMBO = 0;
+ RECOVERED = 1;
+ LOST = 2;
+ }
+
+ AnchorState anchor = 9;
+ }
+
+ // The balance in satoshis encumbered in pending channels
+ int64 total_limbo_balance = 1;
+
+ // Channels pending opening
+ repeated PendingOpenChannel pending_open_channels = 2;
+
+ /*
+ Deprecated: Channels pending closing previously contained cooperatively
+ closed channels with a single confirmation. These channels are now
+ considered closed from the time we see them on chain.
+ */
+ repeated ClosedChannel pending_closing_channels = 3 [deprecated = true];
+
+ // Channels pending force closing
+ repeated ForceClosedChannel pending_force_closing_channels = 4;
+
+ // Channels waiting for closing tx to confirm
+ repeated WaitingCloseChannel waiting_close_channels = 5;
+}
+
+message ChannelEventSubscription {
+}
+
+message ChannelEventUpdate {
+ oneof channel {
+ Channel open_channel = 1;
+ ChannelCloseSummary closed_channel = 2;
+ ChannelPoint active_channel = 3;
+ ChannelPoint inactive_channel = 4;
+ PendingUpdate pending_open_channel = 6;
+ }
+
+ enum UpdateType {
+ OPEN_CHANNEL = 0;
+ CLOSED_CHANNEL = 1;
+ ACTIVE_CHANNEL = 2;
+ INACTIVE_CHANNEL = 3;
+ PENDING_OPEN_CHANNEL = 4;
+ }
+
+ UpdateType type = 5;
+}
+
+message WalletBalanceRequest {
+}
+message WalletBalanceResponse {
+ // The balance of the wallet
+ int64 total_balance = 1;
+
+ // The confirmed balance of a wallet(with >= 1 confirmations)
+ int64 confirmed_balance = 2;
+
+ // The unconfirmed balance of a wallet(with 0 confirmations)
+ int64 unconfirmed_balance = 3;
+}
+
+message ChannelBalanceRequest {
+}
+message ChannelBalanceResponse {
+ // Sum of channels balances denominated in satoshis
+ int64 balance = 1;
+
+ // Sum of channels pending balances denominated in satoshis
+ int64 pending_open_balance = 2;
+}
+
+message QueryRoutesRequest {
+ // The 33-byte hex-encoded public key for the payment destination
+ string pub_key = 1;
+
+ /*
+ The amount to send expressed in satoshis.
+
+ The fields amt and amt_msat are mutually exclusive.
+ */
+ int64 amt = 2;
+
+ /*
+ The amount to send expressed in millisatoshis.
+
+ The fields amt and amt_msat are mutually exclusive.
+ */
+ int64 amt_msat = 12;
+
+ reserved 3;
+
+ /*
+ An optional CLTV delta from the current height that should be used for the
+ timelock of the final hop. Note that unlike SendPayment, QueryRoutes does
+ not add any additional block padding on top of final_ctlv_delta. This
+ padding of a few blocks needs to be added manually or otherwise failures may
+ happen when a block comes in while the payment is in flight.
+ */
+ int32 final_cltv_delta = 4;
+
+ /*
+ 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.
+ */
+ FeeLimit fee_limit = 5;
+
+ /*
+ A list of nodes to ignore during path finding. When using REST, these fields
+ must be encoded as base64.
+ */
+ repeated bytes ignored_nodes = 6;
+
+ /*
+ Deprecated. A list of edges to ignore during path finding.
+ */
+ repeated EdgeLocator ignored_edges = 7 [deprecated = true];
+
+ /*
+ The source node where the request route should originated from. If empty,
+ self is assumed.
+ */
+ string source_pub_key = 8;
+
+ /*
+ If set to true, edge probabilities from mission control will be used to get
+ the optimal route.
+ */
+ bool use_mission_control = 9;
+
+ /*
+ A list of directed node pairs that will be ignored during path finding.
+ */
+ repeated NodePair ignored_pairs = 10;
+
+ /*
+ An optional maximum total time lock for the route. If the source is empty or
+ ourselves, this should not exceed lnd's `--max-cltv-expiry` setting. If
+ zero, then the value of `--max-cltv-expiry` is used as the limit.
+ */
+ uint32 cltv_limit = 11;
+
+ /*
+ An optional field that can be used to pass an arbitrary set of TLV records
+ to a peer which understands the new records. This can be used to pass
+ application specific data during the payment attempt. If the destination
+ does not support the specified recrods, and error will be returned.
+ Record types are required to be in the custom range >= 65536. When using
+ REST, the values must be encoded as base64.
+ */
+ map<uint64, bytes> dest_custom_records = 13;
+
+ /*
+ The channel id of the channel that must be taken to the first hop. If zero,
+ any channel may be used.
+ */
+ uint64 outgoing_chan_id = 14 [jstype = JS_STRING];
+
+ /*
+ The pubkey of the last hop of the route. If empty, any hop may be used.
+ */
+ bytes last_hop_pubkey = 15;
+
+ /*
+ Optional route hints to reach the destination through private channels.
+ */
+ repeated lnrpc.RouteHint route_hints = 16;
+
+ /*
+ Features assumed to be supported by the final node. All transitive feature
+ dependencies must also be set properly. For a given feature bit pair, either
+ optional or remote may be set, but not both. If this field is nil or empty,
+ the router will try to load destination features from the graph as a
+ fallback.
+ */
+ repeated lnrpc.FeatureBit dest_features = 17;
+}
+
+message NodePair {
+ /*
+ The sending node of the pair. When using REST, this field must be encoded as
+ base64.
+ */
+ bytes from = 1;
+
+ /*
+ The receiving node of the pair. When using REST, this field must be encoded
+ as base64.
+ */
+ bytes to = 2;
+}
+
+message EdgeLocator {
+ // The short channel id of this edge.
+ uint64 channel_id = 1 [jstype = JS_STRING];
+
+ /*
+ The direction of this edge. If direction_reverse is false, the direction
+ of this edge is from the channel endpoint with the lexicographically smaller
+ pub key to the endpoint with the larger pub key. If direction_reverse is
+ is true, the edge goes the other way.
+ */
+ bool direction_reverse = 2;
+}
+
+message QueryRoutesResponse {
+ /*
+ The route that results from the path finding operation. This is still a
+ repeated field to retain backwards compatibility.
+ */
+ repeated Route routes = 1;
+
+ /*
+ The success probability of the returned route based on the current mission
+ control state. [EXPERIMENTAL]
+ */
+ double success_prob = 2;
+}
+
+message Hop {
+ /*
+ 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.
+ */
+ uint64 chan_id = 1 [jstype = JS_STRING];
+ int64 chan_capacity = 2;
+ int64 amt_to_forward = 3 [deprecated = true];
+ int64 fee = 4 [deprecated = true];
+ uint32 expiry = 5;
+ int64 amt_to_forward_msat = 6;
+ int64 fee_msat = 7;
+
+ /*
+ 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.
+ */
+ string pub_key = 8;
+
+ /*
+ If set to true, then this hop will be encoded using the new variable length
+ TLV format. Note that if any custom tlv_records below are specified, then
+ this field MUST be set to true for them to be encoded properly.
+ */
+ bool tlv_payload = 9;
+
+ /*
+ An optional TLV record that signals the use of an MPP payment. If present,
+ the receiver will enforce that that the same mpp_record is included in the
+ final hop payload of all non-zero payments in the HTLC set. If empty, a
+ regular single-shot payment is or was attempted.
+ */
+ MPPRecord mpp_record = 10;
+
+ /*
+ An optional set of key-value TLV records. This is useful within the context
+ of the SendToRoute call as it allows callers to specify arbitrary K-V pairs
+ to drop off at each hop within the onion.
+ */
+ map<uint64, bytes> custom_records = 11;
+}
+
+message MPPRecord {
+ /*
+ A unique, random identifier used to authenticate the sender as the intended
+ payer of a multi-path payment. The payment_addr must be the same for all
+ subpayments, and match the payment_addr provided in the receiver's invoice.
+ The same payment_addr must be used on all subpayments.
+ */
+ bytes payment_addr = 11;
+
+ /*
+ The total amount in milli-satoshis being sent as part of a larger multi-path
+ payment. The caller is responsible for ensuring subpayments to the same node
+ and payment_hash sum exactly to total_amt_msat. The same
+ total_amt_msat must be used on all subpayments.
+ */
+ int64 total_amt_msat = 10;
+}
+
+/*
+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.
+*/
+message Route {
+ /*
+ 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.
+ */
+ uint32 total_time_lock = 1;
+
+ /*
+ 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
+ to ourselves.
+ */
+ int64 total_fees = 2 [deprecated = true];
+
+ /*
+ 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.
+ */
+ int64 total_amt = 3 [deprecated = true];
+
+ /*
+ Contains details concerning the specific forwarding details at each hop.
+ */
+ repeated Hop hops = 4;
+
+ /*
+ The total fees in millisatoshis.
+ */
+ int64 total_fees_msat = 5;
+
+ /*
+ The total amount in millisatoshis.
+ */
+ int64 total_amt_msat = 6;
+}
+
+message NodeInfoRequest {
+ // The 33-byte hex-encoded compressed public of the target node
+ string pub_key = 1;
+
+ // If true, will include all known channels associated with the node.
+ bool include_channels = 2;
+}
+
+message NodeInfo {
+ /*
+ 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.
+ */
+ LightningNode node = 1;
+
+ // The total number of channels for the node.
+ uint32 num_channels = 2;
+
+ // The sum of all channels capacity for the node, denominated in satoshis.
+ int64 total_capacity = 3;
+
+ // A list of all public channels for the node.
+ repeated ChannelEdge channels = 4;
+}
+
+/*
+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.
+*/
+message LightningNode {
+ uint32 last_update = 1;
+ string pub_key = 2;
+ string alias = 3;
+ repeated NodeAddress addresses = 4;
+ string color = 5;
+ map<uint32, Feature> features = 6;
+}
+
+message NodeAddress {
+ string network = 1;
+ string addr = 2;
+}
+
+message RoutingPolicy {
+ uint32 time_lock_delta = 1;
+ int64 min_htlc = 2;
+ int64 fee_base_msat = 3;
+ int64 fee_rate_milli_msat = 4;
+ bool disabled = 5;
+ uint64 max_htlc_msat = 6;
+ uint32 last_update = 7;
+}
+
+/*
+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.
+*/
+message ChannelEdge {
+ /*
+ 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.
+ */
+ uint64 channel_id = 1 [jstype = JS_STRING];
+ string chan_point = 2;
+
+ uint32 last_update = 3 [deprecated = true];
+
+ string node1_pub = 4;
+ string node2_pub = 5;
+
+ int64 capacity = 6;
+
+ RoutingPolicy node1_policy = 7;
+ RoutingPolicy node2_policy = 8;
+}
+
+message ChannelGraphRequest {
+ /*
+ 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.
+ */
+ bool include_unannounced = 1;
+}
+
+// Returns a new instance of the directed channel graph.
+message ChannelGraph {
+ // The list of `LightningNode`s in this channel graph
+ repeated LightningNode nodes = 1;
+
+ // The list of `ChannelEdge`s in this channel graph
+ repeated ChannelEdge edges = 2;
+}
+
+enum NodeMetricType {
+ UNKNOWN = 0;
+ BETWEENNESS_CENTRALITY = 1;
+}
+
+message NodeMetricsRequest {
+ // The requested node metrics.
+ repeated NodeMetricType types = 1;
+}
+
+message NodeMetricsResponse {
+ /*
+ Betweenness centrality is the sum of the ratio of shortest paths that pass
+ through the node for each pair of nodes in the graph (not counting paths
+ starting or ending at this node).
+ Map of node pubkey to betweenness centrality of the node. Normalized
+ values are in the [0,1] closed interval.
+ */
+ map<string, FloatMetric> betweenness_centrality = 1;
+}
+
+message FloatMetric {
+ // Arbitrary float value.
+ double value = 1;
+
+ // The value normalized to [0,1] or [-1,1].
+ double normalized_value = 2;
+}
+
+message ChanInfoRequest {
+ /*
+ 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.
+ */
+ uint64 chan_id = 1 [jstype = JS_STRING];
+}
+
+message NetworkInfoRequest {
+}
+message NetworkInfo {
+ uint32 graph_diameter = 1;
+ double avg_out_degree = 2;
+ uint32 max_out_degree = 3;
+
+ uint32 num_nodes = 4;
+ uint32 num_channels = 5;
+
+ int64 total_network_capacity = 6;
+
+ double avg_channel_size = 7;
+ int64 min_channel_size = 8;
+ int64 max_channel_size = 9;
+ int64 median_channel_size_sat = 10;
+
+ // The number of edges marked as zombies.
+ uint64 num_zombie_chans = 11;
+
+ // TODO(roasbeef): fee rate info, expiry
+ // * also additional RPC for tracking fee info once in
+}
+
+message StopRequest {
+}
+message StopResponse {
+}
+
+message GraphTopologySubscription {
+}
+message GraphTopologyUpdate {
+ repeated NodeUpdate node_updates = 1;
+ repeated ChannelEdgeUpdate channel_updates = 2;
+ repeated ClosedChannelUpdate closed_chans = 3;
+}
+message NodeUpdate {
+ repeated string addresses = 1;
+ string identity_key = 2;
+ bytes global_features = 3;
+ string alias = 4;
+ string color = 5;
+}
+message ChannelEdgeUpdate {
+ /*
+ 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.
+ */
+ uint64 chan_id = 1 [jstype = JS_STRING];
+
+ ChannelPoint chan_point = 2;
+
+ int64 capacity = 3;
+
+ RoutingPolicy routing_policy = 4;
+
+ string advertising_node = 5;
+ string connecting_node = 6;
+}
+message ClosedChannelUpdate {
+ /*
+ 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.
+ */
+ uint64 chan_id = 1 [jstype = JS_STRING];
+ int64 capacity = 2;
+ uint32 closed_height = 3;
+ ChannelPoint chan_point = 4;
+}
+
+message HopHint {
+ // The public key of the node at the start of the channel.
+ string node_id = 1;
+
+ // The unique identifier of the channel.
+ uint64 chan_id = 2 [jstype = JS_STRING];
+
+ // The base fee of the channel denominated in millisatoshis.
+ uint32 fee_base_msat = 3;
+
+ /*
+ The fee rate of the channel for sending one satoshi across it denominated in
+ millionths of a satoshi.
+ */
+ uint32 fee_proportional_millionths = 4;
+
+ // The time-lock delta of the channel.
+ uint32 cltv_expiry_delta = 5;
+}
+
+message RouteHint {
+ /*
+ A list of hop hints that when chained together can assist in reaching a
+ specific destination.
+ */
+ repeated HopHint hop_hints = 1;
+}
+
+message Invoice {
+ /*
+ 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.
+ */
+ string memo = 1;
+
+ reserved 2;
+
+ /*
+ The hex-encoded preimage (32 byte) which will allow settling an incoming
+ HTLC payable to this preimage. When using REST, this field must be encoded
+ as base64.
+ */
+ bytes r_preimage = 3;
+
+ /*
+ The hash of the preimage. When using REST, this field must be encoded as
+ base64.
+ */
+ bytes r_hash = 4;
+
+ /*
+ The value of this invoice in satoshis
+
+ The fields value and value_msat are mutually exclusive.
+ */
+ int64 value = 5;
+
+ /*
+ The value of this invoice in millisatoshis
+
+ The fields value and value_msat are mutually exclusive.
+ */
+ int64 value_msat = 23;
+
+ // Whether this invoice has been fulfilled
+ bool settled = 6 [deprecated = true];
+
+ // When this invoice was created
+ int64 creation_date = 7;
+
+ // When this invoice was settled
+ int64 settle_date = 8;
+
+ /*
+ 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.
+ */
+ string payment_request = 9;
+
+ /*
+ 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. When using REST, this field must be encoded
+ as base64.
+ */
+ bytes description_hash = 10;
+
+ // Payment request expiry time in seconds. Default is 3600 (1 hour).
+ int64 expiry = 11;
+
+ // Fallback on-chain address.
+ string fallback_addr = 12;
+
+ // Delta to use for the time-lock of the CLTV extended to the final hop.
+ uint64 cltv_expiry = 13;
+
+ /*
+ Route hints that can each be individually used to assist in reaching the
+ invoice's destination.
+ */
+ repeated RouteHint route_hints = 14;
+
+ // Whether this invoice should include routing hints for private channels.
+ bool private = 15;
+
+ /*
+ 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 add_index = 16;
+
+ /*
+ 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.
+ */
+ uint64 settle_index = 17;
+
+ // Deprecated, use amt_paid_sat or amt_paid_msat.
+ int64 amt_paid = 18 [deprecated = true];
+
+ /*
+ 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_sat = 19;
+
+ /*
+ 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.
+ */
+ int64 amt_paid_msat = 20;
+
+ enum InvoiceState {
+ OPEN = 0;
+ SETTLED = 1;
+ CANCELED = 2;
+ ACCEPTED = 3;
+ }
+
+ /*
+ The state the invoice is in.
+ */
+ InvoiceState state = 21;
+
+ // List of HTLCs paying to this invoice [EXPERIMENTAL].
+ repeated InvoiceHTLC htlcs = 22;
+
+ // List of features advertised on the invoice.
+ map<uint32, Feature> features = 24;
+
+ /*
+ Indicates if this invoice was a spontaneous payment that arrived via keysend
+ [EXPERIMENTAL].
+ */
+ bool is_keysend = 25;
+}
+
+enum InvoiceHTLCState {
+ ACCEPTED = 0;
+ SETTLED = 1;
+ CANCELED = 2;
+}
+
+// Details of an HTLC that paid to an invoice
+message InvoiceHTLC {
+ // Short channel id over which the htlc was received.
+ uint64 chan_id = 1 [jstype = JS_STRING];
+
+ // Index identifying the htlc on the channel.
+ uint64 htlc_index = 2;
+
+ // The amount of the htlc in msat.
+ uint64 amt_msat = 3;
+
+ // Block height at which this htlc was accepted.
+ int32 accept_height = 4;
+
+ // Time at which this htlc was accepted.
+ int64 accept_time = 5;
+
+ // Time at which this htlc was settled or canceled.
+ int64 resolve_time = 6;
+
+ // Block height at which this htlc expires.
+ int32 expiry_height = 7;
+
+ // Current state the htlc is in.
+ InvoiceHTLCState state = 8;
+
+ // Custom tlv records.
+ map<uint64, bytes> custom_records = 9;
+
+ // The total amount of the mpp payment in msat.
+ uint64 mpp_total_amt_msat = 10;
+}
+
+message AddInvoiceResponse {
+ bytes r_hash = 1;
+
+ /*
+ 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.
+ */
+ string payment_request = 2;
+
+ /*
+ 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 add_index = 16;
+}
+message PaymentHash {
+ /*
+ The hex-encoded payment hash of the invoice to be looked up. The passed
+ payment hash must be exactly 32 bytes, otherwise an error is returned.
+ Deprecated now that the REST gateway supports base64 encoding of bytes
+ fields.
+ */
+ string r_hash_str = 1 [deprecated = true];
+
+ /*
+ The payment hash of the invoice to be looked up. When using REST, this field
+ must be encoded as base64.
+ */
+ bytes r_hash = 2;
+}
+
+message ListInvoiceRequest {
+ /*
+ If set, only invoices that are not settled and not canceled will be returned
+ in the response.
+ */
+ bool pending_only = 1;
+
+ /*
+ 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 index_offset = 4;
+
+ // The max number of invoices to return in the response to this query.
+ uint64 num_max_invoices = 5;
+
+ /*
+ If set, the invoices returned will result from seeking backwards from the
+ specified index offset. This can be used to paginate backwards.
+ */
+ bool reversed = 6;
+}
+message ListInvoiceResponse {
+ /*
+ A list of invoices from the time slice of the time series specified in the
+ request.
+ */
+ repeated Invoice invoices = 1;
+
+ /*
+ The index of the last item in the set of returned invoices. This can be used
+ to seek further, pagination style.
+ */
+ uint64 last_index_offset = 2;
+
+ /*
+ The index of the last item in the set of returned invoices. This can be used
+ to seek backwards, pagination style.
+ */
+ uint64 first_index_offset = 3;
+}
+
+message InvoiceSubscription {
+ /*
+ If specified (non-zero), then we'll first start by sending out
+ notifications for all added indexes with an add_index greater than this
+ value. This allows callers to catch up on any events they missed while they
+ weren't connected to the streaming RPC.
+ */
+ uint64 add_index = 1;
+
+ /*
+ If specified (non-zero), then we'll first start by sending out
+ notifications for all settled indexes with an settle_index greater than
+ this value. This allows callers to catch up on any events they missed while
+ they weren't connected to the streaming RPC.
+ */
+ uint64 settle_index = 2;
+}
+
+enum PaymentFailureReason {
+ /*
+ Payment isn't failed (yet).
+ */
+ FAILURE_REASON_NONE = 0;
+
+ /*
+ There are more routes to try, but the payment timeout was exceeded.
+ */
+ FAILURE_REASON_TIMEOUT = 1;
+
+ /*
+ All possible routes were tried and failed permanently. Or were no
+ routes to the destination at all.
+ */
+ FAILURE_REASON_NO_ROUTE = 2;
+
+ /*
+ A non-recoverable error has occured.
+ */
+ FAILURE_REASON_ERROR = 3;
+
+ /*
+ Payment details incorrect (unknown hash, invalid amt or
+ invalid final cltv delta)
+ */
+ FAILURE_REASON_INCORRECT_PAYMENT_DETAILS = 4;
+
+ /*
+ Insufficient local balance.
+ */
+ FAILURE_REASON_INSUFFICIENT_BALANCE = 5;
+}
+
+message Payment {
+ // The payment hash
+ string payment_hash = 1;
+
+ // Deprecated, use value_sat or value_msat.
+ int64 value = 2 [deprecated = true];
+
+ // Deprecated, use creation_time_ns
+ int64 creation_date = 3 [deprecated = true];
+
+ reserved 4;
+
+ // Deprecated, use fee_sat or fee_msat.
+ int64 fee = 5 [deprecated = true];
+
+ // The payment preimage
+ string payment_preimage = 6;
+
+ // The value of the payment in satoshis
+ int64 value_sat = 7;
+
+ // The value of the payment in milli-satoshis
+ int64 value_msat = 8;
+
+ // The optional payment request being fulfilled.
+ string payment_request = 9;
+
+ enum PaymentStatus {
+ UNKNOWN = 0;
+ IN_FLIGHT = 1;
+ SUCCEEDED = 2;
+ FAILED = 3;
+ }
+
+ // The status of the payment.
+ PaymentStatus status = 10;
+
+ // The fee paid for this payment in satoshis
+ int64 fee_sat = 11;
+
+ // The fee paid for this payment in milli-satoshis
+ int64 fee_msat = 12;
+
+ // The time in UNIX nanoseconds at which the payment was created.
+ int64 creation_time_ns = 13;
+
+ // The HTLCs made in attempt to settle the payment.
+ repeated HTLCAttempt htlcs = 14;
+
+ /*
+ The creation index of this payment. Each payment can be uniquely identified
+ by this index, which may not strictly increment by 1 for payments made in
+ older versions of lnd.
+ */
+ uint64 payment_index = 15;
+
+ PaymentFailureReason failure_reason = 16;
+}
+
+message HTLCAttempt {
+ enum HTLCStatus {
+ IN_FLIGHT = 0;
+ SUCCEEDED = 1;
+ FAILED = 2;
+ }
+
+ // The status of the HTLC.
+ HTLCStatus status = 1;
+
+ // The route taken by this HTLC.
+ Route route = 2;
+
+ // The time in UNIX nanoseconds at which this HTLC was sent.
+ int64 attempt_time_ns = 3;
+
+ /*
+ The time in UNIX nanoseconds at which this HTLC was settled or failed.
+ This value will not be set if the HTLC is still IN_FLIGHT.
+ */
+ int64 resolve_time_ns = 4;
+
+ // Detailed htlc failure info.
+ Failure failure = 5;
+
+ // The preimage that was used to settle the HTLC.
+ bytes preimage = 6;
+}
+
+message ListPaymentsRequest {
+ /*
+ If true, then return payments that have not yet fully completed. This means
+ that pending payments, as well as failed payments will show up if this
+ field is set to true. This flag doesn't change the meaning of the indices,
+ which are tied to individual payments.
+ */
+ bool include_incomplete = 1;
+
+ /*
+ The index of a payment that will be used as either the start or end of a
+ query to determine which payments should be returned in the response. The
+ index_offset is exclusive. In the case of a zero index_offset, the query
+ will start with the oldest payment when paginating forwards, or will end
+ with the most recent payment when paginating backwards.
+ */
+ uint64 index_offset = 2;
+
+ // The maximal number of payments returned in the response to this query.
+ uint64 max_payments = 3;
+
+ /*
+ If set, the payments returned will result from seeking backwards from the
+ specified index offset. This can be used to paginate backwards. The order
+ of the returned payments is always oldest first (ascending index order).
+ */
+ bool reversed = 4;
+}
+
+message ListPaymentsResponse {
+ // The list of payments
+ repeated Payment payments = 1;
+
+ /*
+ The index of the first item in the set of returned payments. This can be
+ used as the index_offset to continue seeking backwards in the next request.
+ */
+ uint64 first_index_offset = 2;
+
+ /*
+ The index of the last item in the set of returned payments. This can be used
+ as the index_offset to continue seeking forwards in the next request.
+ */
+ uint64 last_index_offset = 3;
+}
+
+message DeleteAllPaymentsRequest {
+}
+
+message DeleteAllPaymentsResponse {
+}
+
+message AbandonChannelRequest {
+ ChannelPoint channel_point = 1;
+}
+
+message AbandonChannelResponse {
+}
+
+message DebugLevelRequest {
+ bool show = 1;
+ string level_spec = 2;
+}
+message DebugLevelResponse {
+ string sub_systems = 1;
+}
+
+message PayReqString {
+ // The payment request string to be decoded
+ string pay_req = 1;
+}
+message PayReq {
+ string 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 RouteHint route_hints = 10;
+ bytes payment_addr = 11;
+ int64 num_msat = 12;
+ map<uint32, Feature> features = 13;
+}
+
+enum FeatureBit {
+ DATALOSS_PROTECT_REQ = 0;
+ DATALOSS_PROTECT_OPT = 1;
+ INITIAL_ROUING_SYNC = 3;
+ UPFRONT_SHUTDOWN_SCRIPT_REQ = 4;
+ UPFRONT_SHUTDOWN_SCRIPT_OPT = 5;
+ GOSSIP_QUERIES_REQ = 6;
+ GOSSIP_QUERIES_OPT = 7;
+ TLV_ONION_REQ = 8;
+ TLV_ONION_OPT = 9;
+ EXT_GOSSIP_QUERIES_REQ = 10;
+ EXT_GOSSIP_QUERIES_OPT = 11;
+ STATIC_REMOTE_KEY_REQ = 12;
+ STATIC_REMOTE_KEY_OPT = 13;
+ PAYMENT_ADDR_REQ = 14;
+ PAYMENT_ADDR_OPT = 15;
+ MPP_REQ = 16;
+ MPP_OPT = 17;
+}
+
+message Feature {
+ string name = 2;
+ bool is_required = 3;
+ bool is_known = 4;
+}
+
+message FeeReportRequest {
+}
+message ChannelFeeReport {
+ // The short channel id that this fee report belongs to.
+ uint64 chan_id = 5 [jstype = JS_STRING];
+
+ // The channel that this fee report belongs to.
+ string channel_point = 1;
+
+ // The base fee charged regardless of the number of milli-satoshis sent.
+ int64 base_fee_msat = 2;
+
+ // The amount charged per milli-satoshis transferred expressed in
+ // millionths of a satoshi.
+ int64 fee_per_mil = 3;
+
+ // The effective fee rate in milli-satoshis. Computed by dividing the
+ // fee_per_mil value by 1 million.
+ double fee_rate = 4;
+}
+message FeeReportResponse {
+ // An array of channel fee reports which describes the current fee schedule
+ // for each channel.
+ repeated ChannelFeeReport channel_fees = 1;
+
+ // The total amount of fee revenue (in satoshis) the switch has collected
+ // over the past 24 hrs.
+ uint64 day_fee_sum = 2;
+
+ // The total amount of fee revenue (in satoshis) the switch has collected
+ // over the past 1 week.
+ uint64 week_fee_sum = 3;
+
+ // The total amount of fee revenue (in satoshis) the switch has collected
+ // over the past 1 month.
+ uint64 month_fee_sum = 4;
+}
+
+message PolicyUpdateRequest {
+ oneof scope {
+ // If set, then this update applies to all currently active channels.
+ bool global = 1;
+
+ // If set, this update will target a specific channel.
+ ChannelPoint chan_point = 2;
+ }
+
+ // The base fee charged regardless of the number of milli-satoshis sent.
+ int64 base_fee_msat = 3;
+
+ // The effective fee rate in milli-satoshis. The precision of this value
+ // goes up to 6 decimal places, so 1e-6.
+ double fee_rate = 4;
+
+ // The required timelock delta for HTLCs forwarded over the channel.
+ uint32 time_lock_delta = 5;
+
+ // If set, the maximum HTLC size in milli-satoshis. If unset, the maximum
+ // HTLC will be unchanged.
+ uint64 max_htlc_msat = 6;
+
+ // The minimum HTLC size in milli-satoshis. Only applied if
+ // min_htlc_msat_specified is true.
+ uint64 min_htlc_msat = 7;
+
+ // If true, min_htlc_msat is applied.
+ bool min_htlc_msat_specified = 8;
+}
+message PolicyUpdateResponse {
+}
+
+message ForwardingHistoryRequest {
+ // Start time is the starting point of the forwarding history request. All
+ // records beyond this point will be included, respecting the end time, and
+ // the index offset.
+ uint64 start_time = 1;
+
+ // End time is the end point of the forwarding history request. The
+ // response will carry at most 50k records between the start time and the
+ // end time. The index offset can be used to implement pagination.
+ uint64 end_time = 2;
+
+ // Index offset is the offset in the time series to start at. As each
+ // response can only contain 50k records, callers can use this to skip
+ // around within a packed time series.
+ uint32 index_offset = 3;
+
+ // The max number of events to return in the response to this query.
+ uint32 num_max_events = 4;
+}
+message ForwardingEvent {
+ // Timestamp is the time (unix epoch offset) that this circuit was
+ // completed.
+ uint64 timestamp = 1;
+
+ // The incoming channel ID that carried the HTLC that created the circuit.
+ uint64 chan_id_in = 2 [jstype = JS_STRING];
+
+ // The outgoing channel ID that carried the preimage that completed the
+ // circuit.
+ uint64 chan_id_out = 4 [jstype = JS_STRING];
+
+ // The total amount (in satoshis) of the incoming HTLC that created half
+ // the circuit.
+ uint64 amt_in = 5;
+
+ // The total amount (in satoshis) of the outgoing HTLC that created the
+ // second half of the circuit.
+ uint64 amt_out = 6;
+
+ // The total fee (in satoshis) that this payment circuit carried.
+ uint64 fee = 7;
+
+ // The total fee (in milli-satoshis) that this payment circuit carried.
+ uint64 fee_msat = 8;
+
+ // The total amount (in milli-satoshis) of the incoming HTLC that created
+ // half the circuit.
+ uint64 amt_in_msat = 9;
+
+ // The total amount (in milli-satoshis) of the outgoing HTLC that created
+ // the second half of the circuit.
+ uint64 amt_out_msat = 10;
+
+ // TODO(roasbeef): add settlement latency?
+ // * use FPE on the chan id?
+ // * also list failures?
+}
+message ForwardingHistoryResponse {
+ // A list of forwarding events from the time slice of the time series
+ // specified in the request.
+ repeated ForwardingEvent forwarding_events = 1;
+
+ // The index of the last time in the set of returned forwarding events. Can
+ // be used to seek further, pagination style.
+ uint32 last_offset_index = 2;
+}
+
+message ExportChannelBackupRequest {
+ // The target channel point to obtain a back up for.
+ ChannelPoint chan_point = 1;
+}
+
+message ChannelBackup {
+ /*
+ Identifies the channel that this backup belongs to.
+ */
+ ChannelPoint chan_point = 1;
+
+ /*
+ Is an encrypted single-chan backup. this can be passed to
+ RestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in
+ order to trigger the recovery protocol. When using REST, this field must be
+ encoded as base64.
+ */
+ bytes chan_backup = 2;
+}
+
+message MultiChanBackup {
+ /*
+ Is the set of all channels that are included in this multi-channel backup.
+ */
+ repeated ChannelPoint chan_points = 1;
+
+ /*
+ A single encrypted blob containing all the static channel backups of the
+ channel listed above. This can be stored as a single file or blob, and
+ safely be replaced with any prior/future versions. When using REST, this
+ field must be encoded as base64.
+ */
+ bytes multi_chan_backup = 2;
+}
+
+message ChanBackupExportRequest {
+}
+message ChanBackupSnapshot {
+ /*
+ The set of new channels that have been added since the last channel backup
+ snapshot was requested.
+ */
+ ChannelBackups single_chan_backups = 1;
+
+ /*
+ A multi-channel backup that covers all open channels currently known to
+ lnd.
+ */
+ MultiChanBackup multi_chan_backup = 2;
+}
+
+message ChannelBackups {
+ /*
+ A set of single-chan static channel backups.
+ */
+ repeated ChannelBackup chan_backups = 1;
+}
+
+message RestoreChanBackupRequest {
+ oneof backup {
+ /*
+ The channels to restore as a list of channel/backup pairs.
+ */
+ ChannelBackups chan_backups = 1;
+
+ /*
+ The channels to restore in the packed multi backup format. When using
+ REST, this field must be encoded as base64.
+ */
+ bytes multi_chan_backup = 2;
+ }
+}
+message RestoreBackupResponse {
+}
+
+message ChannelBackupSubscription {
+}
+
+message VerifyChanBackupResponse {
+}
+
+message MacaroonPermission {
+ // The entity a permission grants access to.
+ string entity = 1;
+
+ // The action that is granted.
+ string action = 2;
+}
+message BakeMacaroonRequest {
+ // The list of permissions the new macaroon should grant.
+ repeated MacaroonPermission permissions = 1;
+}
+message BakeMacaroonResponse {
+ // The hex encoded macaroon, serialized in binary format.
+ string macaroon = 1;
+}
+
+message Failure {
+ enum FailureCode {
+ /*
+ The numbers assigned in this enumeration match the failure codes as
+ defined in BOLT #4. Because protobuf 3 requires enums to start with 0,
+ a RESERVED value is added.
+ */
+ RESERVED = 0;
+
+ INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS = 1;
+ INCORRECT_PAYMENT_AMOUNT = 2;
+ FINAL_INCORRECT_CLTV_EXPIRY = 3;
+ FINAL_INCORRECT_HTLC_AMOUNT = 4;
+ FINAL_EXPIRY_TOO_SOON = 5;
+ INVALID_REALM = 6;
+ EXPIRY_TOO_SOON = 7;
+ INVALID_ONION_VERSION = 8;
+ INVALID_ONION_HMAC = 9;
+ INVALID_ONION_KEY = 10;
+ AMOUNT_BELOW_MINIMUM = 11;
+ FEE_INSUFFICIENT = 12;
+ INCORRECT_CLTV_EXPIRY = 13;
+ CHANNEL_DISABLED = 14;
+ TEMPORARY_CHANNEL_FAILURE = 15;
+ REQUIRED_NODE_FEATURE_MISSING = 16;
+ REQUIRED_CHANNEL_FEATURE_MISSING = 17;
+ UNKNOWN_NEXT_PEER = 18;
+ TEMPORARY_NODE_FAILURE = 19;
+ PERMANENT_NODE_FAILURE = 20;
+ PERMANENT_CHANNEL_FAILURE = 21;
+ EXPIRY_TOO_FAR = 22;
+ MPP_TIMEOUT = 23;
+
+ /*
+ An internal error occurred.
+ */
+ INTERNAL_FAILURE = 997;
+
+ /*
+ The error source is known, but the failure itself couldn't be decoded.
+ */
+ UNKNOWN_FAILURE = 998;
+
+ /*
+ An unreadable failure result is returned if the received failure message
+ cannot be decrypted. In that case the error source is unknown.
+ */
+ UNREADABLE_FAILURE = 999;
+ }
+
+ // Failure code as defined in the Lightning spec
+ FailureCode code = 1;
+
+ reserved 2;
+
+ // An optional channel update message.
+ ChannelUpdate channel_update = 3;
+
+ // A failure type-dependent htlc value.
+ uint64 htlc_msat = 4;
+
+ // The sha256 sum of the onion payload.
+ bytes onion_sha_256 = 5;
+
+ // A failure type-dependent cltv expiry value.
+ uint32 cltv_expiry = 6;
+
+ // A failure type-dependent flags value.
+ uint32 flags = 7;
+
+ /*
+ The position in the path of the intermediate or final node that generated
+ the failure message. Position zero is the sender node.
+ **/
+ uint32 failure_source_index = 8;
+
+ // A failure type-dependent block height.
+ uint32 height = 9;
+}
+
+message ChannelUpdate {
+ /*
+ The signature that validates the announced data and proves the ownership
+ of node id.
+ */
+ bytes signature = 1;
+
+ /*
+ The target chain that this channel was opened within. This value
+ should be the genesis hash of the target chain. Along with the short
+ channel ID, this uniquely identifies the channel globally in a
+ blockchain.
+ */
+ bytes chain_hash = 2;
+
+ /*
+ The unique description of the funding transaction.
+ */
+ uint64 chan_id = 3 [jstype = JS_STRING];
+
+ /*
+ A timestamp that allows ordering in the case of multiple announcements.
+ We should ignore the message if timestamp is not greater than the
+ last-received.
+ */
+ uint32 timestamp = 4;
+
+ /*
+ The bitfield that describes whether optional fields are present in this
+ update. Currently, the least-significant bit must be set to 1 if the
+ optional field MaxHtlc is present.
+ */
+ uint32 message_flags = 10;
+
+ /*
+ The bitfield that describes additional meta-data concerning how the
+ update is to be interpreted. Currently, the least-significant bit must be
+ set to 0 if the creating node corresponds to the first node in the
+ previously sent channel announcement and 1 otherwise. If the second bit
+ is set, then the channel is set to be disabled.
+ */
+ uint32 channel_flags = 5;
+
+ /*
+ The minimum number of blocks this node requires to be added to the expiry
+ of HTLCs. This is a security parameter determined by the node operator.
+ This value represents the required gap between the time locks of the
+ incoming and outgoing HTLC's set to this node.
+ */
+ uint32 time_lock_delta = 6;
+
+ /*
+ The minimum HTLC value which will be accepted.
+ */
+ uint64 htlc_minimum_msat = 7;
+
+ /*
+ The base fee that must be used for incoming HTLC's to this particular
+ channel. This value will be tacked onto the required for a payment
+ independent of the size of the payment.
+ */
+ uint32 base_fee = 8;
+
+ /*
+ The fee rate that will be charged per millionth of a satoshi.
+ */
+ uint32 fee_rate = 9;
+
+ /*
+ The maximum HTLC value which will be accepted.
+ */
+ uint64 htlc_maximum_msat = 11;
+
+ /*
+ The set of data that was appended to this message, some of which we may
+ not actually know how to iterate or parse. By holding onto this data, we
+ ensure that we're able to properly validate the set of signatures that
+ cover these new fields, and ensure we're able to make upgrades to the
+ network in a forwards compatible manner.
+ */
+ bytes extra_opaque_data = 12;
+}