lightning_network 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c59dcb13b12d5c6eae7342d92cdc586fadbd0e8
-  data.tar.gz: f9c5f2df1f42937a009f27c54acc248e97ab1c3e
+  metadata.gz: 0d8fab151e1b804895dc0efb60a02ecf32f5f2f3
+  data.tar.gz: 51e4c37e939f67a73a8ea3beda14a8ae78d214ad
 SHA512:
-  metadata.gz: 354a03a176026727c366163152763e25d27d5712f4c69db0afa27cb4e31f12c0df5cde7dee92be767a27c6c6171829935b4ce815d97e1b9d053ffa387e076f6e
-  data.tar.gz: '08032511e41921d357214ce02ed7903a0b74008b57061cf8969da36dac3257286da85029db2c81d45b90717c04f4033387ca1c89566d04349c9a5d0587621fea'
+  metadata.gz: f12e2ba30419840ca9b20f166b268a73a8a4e50d02b8c7579392288300ea021b4e6ccaea12fda7934f311654c323c444a7d9271729b87d8606a49f361aa614d4
+  data.tar.gz: 3dd327f4c24def6808fcc1b3d11756ec6312827b384b74b4d707f912a45f1469d81c4ac6d2114ba3948a371970ce26d0fc0aa220ca747ff2040d332613b4f1a7

data/lib/lightning_network.rb

@@ -7,3 +7,7 @@ require 'grpc'
 require 'macaroon_interceptor'
 require 'lnd'
 require 'node'
+
+ENV['lnd_macaroon'] = 'admin.macaroon'
+ENV['lnd_cert'] = 'tls.cert'
+ENV['lnd_host'] = 'lightning:10009'

data/lib/node.rb

@@ -158,8 +158,8 @@ class Node
   class Wallet
     include Lnd
 
-    def new_address
-      stub.new_witness_address(Lnrpc::NewWitnessAddressRequest.new())
+    def new_addresss
+      stub.new_address(Lnrpc::NewAddressRequest.new())
     end
 
     def wallet_balance

data/lib/rpc.proto

@@ -3,6 +3,9 @@ syntax = "proto3";
 import "google/api/annotations.proto";
 
 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.
@@ -22,7 +25,7 @@ package lnrpc;
  * 
  * More information on how exactly the gRPC documentation is generated from
  * this proto file can be found here:
- * https://github.com/MaxFangX/lightning-api
+ * https://github.com/lightninglabs/lightning-api
  */
 
 // The WalletUnlocker service is used to set up a wallet password for
@@ -231,6 +234,16 @@ service Lightning {
         };
     }
 
+    /** lncli: `listunspent`
+    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) {
+        option (google.api.http) = {
+            get: "/v1/utxos"
+        };
+    }
+
     /**
     SubscribeTransactions creates a uni-directional stream from the server to
     the client in which any newly discovered transactions relevant to the
@@ -249,12 +262,7 @@ service Lightning {
     /** lncli: `newaddress`
     NewAddress creates a new address under control of the local wallet.
     */
-    rpc NewAddress (NewAddressRequest) returns (NewAddressResponse);
-
-    /**
-    NewWitnessAddress creates a new witness address under control of the local wallet.
-    */
-    rpc NewWitnessAddress (NewWitnessAddressRequest) returns (NewAddressResponse) {
+    rpc NewAddress (NewAddressRequest) returns (NewAddressResponse) {
         option (google.api.http) = {
             get: "/v1/newaddress"
         };
@@ -265,7 +273,12 @@ service Lightning {
     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);
+    rpc SignMessage (SignMessageRequest) returns (SignMessageResponse) {
+        option (google.api.http) = {
+            post: "/v1/signmessage"
+            body: "*"
+        };
+    }
 
     /** lncli: `verifymessage`
     VerifyMessage verifies a signature over a msg. The signature must be
@@ -273,7 +286,12 @@ service Lightning {
     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);
+    rpc VerifyMessage (VerifyMessageRequest) returns (VerifyMessageResponse) {
+        option (google.api.http) = {
+            post: "/v1/verifymessage"
+            body: "*"
+        };
+    }
 
     /** lncli: `connect`
     ConnectPeer attempts to establish a connection to a remote peer. This is at
@@ -389,6 +407,19 @@ service Lightning {
         };
     }
 
+    /** 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) {
+        option (google.api.http) = {
+            delete: "/v1/channels/abandon/{channel_point.funding_txid_str}/{channel_point.output_index}"
+        };
+    }
+
+
     /** lncli: `sendpayment`
     SendPayment dispatches a bi-directional streaming RPC for sending payments
     through the Lightning Network. A single RPC invocation creates a persistent
@@ -443,7 +474,12 @@ service Lightning {
 
     /** lncli: `listinvoices`
     ListInvoices returns a list of all the invoices currently stored within the
-    database. Any active debug invoices are ignored.
+    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) {
         option (google.api.http) = {
@@ -463,8 +499,15 @@ service Lightning {
     }
 
     /**
-    SubscribeInvoices returns a uni-directional stream (sever -> client) for
-    notifying the client of newly added/settled invoices.
+    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) {
         option (google.api.http) = {
@@ -625,11 +668,33 @@ service Lightning {
     };
 }
 
+message Utxo {
+	/// The type of address
+	AddressType type = 1 [json_name = "address_type"];
+
+	/// The address
+	string address = 2 [json_name = "address"];
+
+	/// The value of the unspent coin in satoshis
+	int64 amount_sat = 3 [json_name = "amount_sat"];
+
+	/// The scriptpubkey in hex
+	string script_pubkey = 4 [json_name = "script_pubkey"];
+
+	/// The outpoint in format txid:n
+	/// Note that this reuses the `ChannelPoint` message but
+	/// is not actually a channel related outpoint, of course
+	ChannelPoint outpoint = 5 [json_name = "outpoint"];
+
+	/// The number of confirmations for the Utxo
+	int64 confirmations = 6 [json_name = "confirmations"];
+}
+
 message Transaction {
     /// The transaction hash
     string tx_hash = 1 [ json_name = "tx_hash" ];
 
-    /// The transaction ammount, denominated in satoshis
+    /// The transaction amount, denominated in satoshis
     int64 amount = 2 [ json_name = "amount" ];
 
     /// The number of confirmations
@@ -708,6 +773,7 @@ message SendResponse {
     string payment_error = 1 [json_name = "payment_error"];
     bytes payment_preimage = 2 [json_name = "payment_preimage"];
     Route payment_route = 3 [json_name = "payment_route"];
+    bytes payment_hash = 4 [json_name = "payment_hash"];
 }
 
 message SendToRouteRequest {
@@ -769,32 +835,47 @@ message SendCoinsRequest {
 
     /// 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; 
 }
 message SendCoinsResponse {
     /// The transaction ID of the transaction
     string txid = 1 [json_name = "txid"];
 }
 
+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 [json_name = "utxos"];
+
+}
+
 /** 
 `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)
-- `p2pkh`:  Pay to public key hash (`PUBKEY_HASH` = 2)
 */
-message NewAddressRequest {
-    enum AddressType {
+enum AddressType {
         WITNESS_PUBKEY_HASH = 0;
         NESTED_PUBKEY_HASH = 1;
-    }
+}
 
+message NewAddressRequest {
     /// The address type
     AddressType type = 1;
 }
-
-message NewWitnessAddressRequest {
-}
-
 message NewAddressResponse {
     /// The newly generated wallet address
     string address = 1 [json_name = "address"];
@@ -927,8 +1008,11 @@ message Channel {
     */
     uint32 csv_delay = 16 [json_name = "csv_delay"];
 
-    /// Whether this channel is advertised to the network or not
+    /// Whether this channel is advertised to the network or not.
     bool private = 17 [json_name = "private"];
+
+    /// True if we were the ones that creted the channel.
+    bool initiator = 18 [json_name = "initiator"];
 }
 
 
@@ -977,6 +1061,7 @@ message ChannelCloseSummary {
         REMOTE_FORCE_CLOSE = 2;
         BREACH_CLOSE = 3;
         FUNDING_CANCELED = 4;
+        ABANDONED = 5;
     }
 
     /// Details on how the channel was closed.
@@ -989,6 +1074,7 @@ message ClosedChannelsRequest {
     bool remote_force = 3;
     bool breach = 4;
     bool funding_canceled = 5;
+    bool abandoned = 6;
 }
 
 message ClosedChannelsResponse { 
@@ -1056,11 +1142,13 @@ message GetInfoResponse {
     /// Whether the wallet's view is synced to the main chain
     bool synced_to_chain = 9 [json_name = "synced_to_chain"];
 
-    /// Whether the current node is connected to testnet
-    bool testnet = 10 [json_name = "testnet"];
+    /** 
+    Whether the current node is connected to testnet. This field is 
+    deprecated and the network field should be used instead 
+    **/
+    bool testnet = 10 [json_name = "testnet", deprecated = true];
 
-    /// A list of active chains the node is connected to
-    repeated string chains = 11 [json_name = "chains"];
+    reserved 11;
 
     /// The URIs of the current node.
     repeated string uris = 12 [json_name = "uris"];
@@ -1071,6 +1159,19 @@ message GetInfoResponse {
     /// The version of the LND software that the node is running.
     string version = 14 [ json_name = "version" ];
 
+    /// Number of inactive channels
+    uint32 num_inactive_channels = 15 [json_name = "num_inactive_channels"];
+
+    /// A list of active chains the node is connected to
+    repeated Chain chains = 16 [json_name = "chains"];
+}
+
+message Chain {
+    /// The blockchain the node is on (eg bitcoin, litecoin)
+    string chain = 1 [json_name = "chain"];
+
+    /// The network the node is on (eg regtest, testnet, mainnet)
+    string network = 2 [json_name = "network"];
 }
 
 message ConfirmationUpdate {
@@ -1111,7 +1212,6 @@ message CloseChannelRequest {
 message CloseStatusUpdate {
     oneof update {
         PendingUpdate close_pending = 1 [json_name = "close_pending"];
-        ConfirmationUpdate confirmation = 2 [json_name = "confirmation"];
         ChannelCloseUpdate chan_close = 3 [json_name = "chan_close"];
     }
 }
@@ -1122,11 +1222,10 @@ message PendingUpdate {
 }
 
 message OpenChannelRequest {
-
     /// The pubkey of the node to open a channel with
     bytes node_pubkey = 2 [json_name = "node_pubkey"];
 
-    /// The hex encoded pubkey of the node to open a channel with 
+    /// The hex encoded pubkey of the node to open a channel with
     string node_pubkey_string = 3 [json_name = "node_pubkey_string"];
 
     /// The number of satoshis the wallet should commit to the channel
@@ -1149,11 +1248,16 @@ message OpenChannelRequest {
 
     /// 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 [json_name = "remote_csv_delay"];
+
+    /// The minimum number of confirmations each one of your outputs used for the funding transaction must satisfy.
+    int32 min_confs = 11 [json_name = "min_confs"];
+
+    /// Whether unconfirmed outputs should be used as inputs for the funding transaction.
+    bool spend_unconfirmed = 12 [json_name = "spend_unconfirmed"];
 }
 message OpenStatusUpdate {
     oneof update {
         PendingUpdate chan_pending = 1 [json_name = "chan_pending"];
-        ConfirmationUpdate confirmation = 2 [json_name = "confirmation"];
         ChannelOpenUpdate chan_open = 3 [json_name = "chan_open"];
     }
 }
@@ -1341,6 +1445,12 @@ message Hop {
     uint32 expiry = 5 [json_name = "expiry"];
     int64 amt_to_forward_msat = 6 [json_name = "amt_to_forward_msat"];
     int64 fee_msat = 7 [json_name = "fee_msat"];
+
+    /**
+    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 [json_name = "pub_key"];
 }
 
 /**
@@ -1435,6 +1545,7 @@ message RoutingPolicy {
     int64 min_htlc = 2 [json_name = "min_htlc"];
     int64 fee_base_msat = 3 [json_name = "fee_base_msat"];
     int64 fee_rate_milli_msat = 4 [json_name = "fee_rate_milli_msat"];
+    bool disabled = 5 [json_name = "disabled"];
 }
 
 /**
@@ -1466,6 +1577,12 @@ message ChannelEdge {
 }
 
 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 [json_name = "include_unannounced"];
 }
 
 /// Returns a new instance of the directed channel graph.
@@ -1587,8 +1704,10 @@ message Invoice {
     */
     string memo = 1 [json_name = "memo"];
 
-    /// An optional cryptographic receipt of payment
-    bytes receipt = 2 [json_name = "receipt"];
+    /** Deprecated. An optional cryptographic receipt of payment which is not
+    implemented.
+    */
+    bytes receipt = 2 [json_name = "receipt", deprecated = true];
 
     /**
     The hex-encoded preimage (32 byte) which will allow settling an incoming
@@ -1603,7 +1722,7 @@ message Invoice {
     int64 value = 5 [json_name = "value"];
 
     /// Whether this invoice has been fulfilled
-    bool settled = 6 [json_name = "settled"];
+    bool settled = 6 [json_name = "settled", deprecated = true];
 
     /// When this invoice was created
     int64 creation_date = 7 [json_name = "creation_date"];
@@ -1642,7 +1761,57 @@ message Invoice {
 
     /// Whether this invoice should include routing hints for private channels.
     bool private = 15 [json_name = "private"];
+
+    /**
+    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 [json_name = "add_index"];
+
+    /**
+    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 [json_name = "settle_index"];
+
+    /// Deprecated, use amt_paid_sat or amt_paid_msat.
+    int64 amt_paid = 18 [json_name = "amt_paid", 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 [json_name = "amt_paid_sat"];
+
+    /**
+    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 [json_name = "amt_paid_msat"];
+
+    enum InvoiceState {
+        OPEN = 0;
+        SETTLED = 1;
+    }
+
+    /**
+    The state the invoice is in.
+    */
+    InvoiceState state = 21 [json_name = "state"];
 }
+
 message AddInvoiceResponse {
     bytes r_hash = 1 [json_name = "r_hash"];
 
@@ -1652,6 +1821,14 @@ message AddInvoiceResponse {
     payment to the recipient.
     */
     string payment_request = 2 [json_name = "payment_request"];
+
+    /**
+    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 [json_name = "add_index"];
 }
 message PaymentHash {
     /**
@@ -1663,15 +1840,62 @@ message PaymentHash {
     /// The payment hash of the invoice to be looked up.
     bytes r_hash = 2 [json_name = "r_hash"];
 }
+
 message ListInvoiceRequest {
-    /// Toggles if all invoices should be returned, or only those that are currently unsettled.
-    bool pending_only = 1;
+    /// If set, only unsettled invoices will be returned in the response.
+    bool pending_only = 1 [json_name = "pending_only"];
+
+    /**
+    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 [json_name = "index_offset"];
+
+    /// The max number of invoices to return in the response to this query.
+    uint64 num_max_invoices = 5 [json_name = "num_max_invoices"];
+
+    /**
+    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 [json_name = "reversed"];
 }
 message ListInvoiceResponse {
+    /**
+    A list of invoices from the time slice of the time series specified in the
+    request.
+    */
     repeated Invoice invoices = 1 [json_name = "invoices"];
+
+    /**
+    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 [json_name = "last_index_offset"];
+
+    /**
+    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 [json_name = "first_index_offset"];
 }
 
 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 [json_name = "add_index"];
+
+    /**
+    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 [json_name = "settle_index"];
 }
 
 
@@ -1679,8 +1903,8 @@ message Payment {
     /// The payment hash
     string payment_hash = 1 [json_name = "payment_hash"];
 
-    /// The value of the payment in satoshis
-    int64 value = 2 [json_name = "value"];
+    /// Deprecated, use value_sat or value_msat.
+    int64 value = 2 [json_name = "value", deprecated = true];
 
     /// The date of this payment
     int64 creation_date = 3 [json_name = "creation_date"];
@@ -1693,6 +1917,12 @@ message Payment {
 
     /// The payment preimage
     string payment_preimage = 6 [json_name = "payment_preimage"];
+
+    /// The value of the payment in satoshis
+    int64 value_sat = 7 [json_name = "value_sat"];
+
+    /// The value of the payment in milli-satoshis
+    int64 value_msat = 8 [json_name = "value_msat"];
 }
 
 message ListPaymentsRequest {
@@ -1709,6 +1939,14 @@ message DeleteAllPaymentsRequest {
 message DeleteAllPaymentsResponse {
 }
 
+message AbandonChannelRequest {
+    ChannelPoint channel_point = 1;
+}
+
+message AbandonChannelResponse {
+}
+
+
 message DebugLevelRequest {
     bool show = 1;
     string level_spec = 2;
@@ -1806,15 +2044,18 @@ message ForwardingEvent {
     /// The outgoing channel ID that carried the preimage that completed the circuit.
     uint64 chan_id_out = 4 [json_name = "chan_id_out"];
 
-    /// The total amount of the incoming HTLC that created half the circuit.
+    /// The total amount (in satoshis) of the incoming HTLC that created half the circuit.
     uint64 amt_in = 5 [json_name = "amt_in"];
 
-    /// The total amount of the outgoign HTLC that created the second half of the circuit.
+    /// The total amount (in satoshis) of the outgoing HTLC that created the second half of the circuit.
     uint64 amt_out = 6 [json_name = "amt_out"];
 
-    /// The total fee that this payment circuit carried.
+    /// The total fee (in satoshis) that this payment circuit carried.
     uint64 fee = 7 [json_name = "fee"];
 
+    /// The total fee (in milli-satoshis) that this payment circuit carried.
+    uint64 fee_msat = 8 [json_name = "fee_msat"];
+
     // TODO(roasbeef): add settlement latency?
     //  * use FPE on the chan id?
     //  * also list failures?

data/lib/rpc_pb.rb

@@ -33,6 +33,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "lnrpc.ChangePasswordResponse" do
   end
+  add_message "lnrpc.Utxo" do
+    optional :type, :enum, 1, "lnrpc.AddressType"
+    optional :address, :string, 2
+    optional :amount_sat, :int64, 3
+    optional :script_pubkey, :string, 4
+    optional :outpoint, :message, 5, "lnrpc.ChannelPoint"
+    optional :confirmations, :int64, 6
+  end
   add_message "lnrpc.Transaction" do
     optional :tx_hash, :string, 1
     optional :amount, :int64, 2
@@ -68,6 +76,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :payment_error, :string, 1
     optional :payment_preimage, :bytes, 2
     optional :payment_route, :message, 3, "lnrpc.Route"
+    optional :payment_hash, :bytes, 4
   end
   add_message "lnrpc.SendToRouteRequest" do
     optional :payment_hash, :bytes, 1
@@ -98,18 +107,20 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :amount, :int64, 2
     optional :target_conf, :int32, 3
     optional :sat_per_byte, :int64, 5
+    optional :send_all, :bool, 6
   end
   add_message "lnrpc.SendCoinsResponse" do
     optional :txid, :string, 1
   end
-  add_message "lnrpc.NewAddressRequest" do
-    optional :type, :enum, 1, "lnrpc.NewAddressRequest.AddressType"
+  add_message "lnrpc.ListUnspentRequest" do
+    optional :min_confs, :int32, 1
+    optional :max_confs, :int32, 2
   end
-  add_enum "lnrpc.NewAddressRequest.AddressType" do
-    value :WITNESS_PUBKEY_HASH, 0
-    value :NESTED_PUBKEY_HASH, 1
+  add_message "lnrpc.ListUnspentResponse" do
+    repeated :utxos, :message, 1, "lnrpc.Utxo"
   end
-  add_message "lnrpc.NewWitnessAddressRequest" do
+  add_message "lnrpc.NewAddressRequest" do
+    optional :type, :enum, 1, "lnrpc.AddressType"
   end
   add_message "lnrpc.NewAddressResponse" do
     optional :address, :string, 1
@@ -163,6 +174,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :pending_htlcs, :message, 15, "lnrpc.HTLC"
     optional :csv_delay, :uint32, 16
     optional :private, :bool, 17
+    optional :initiator, :bool, 18
   end
   add_message "lnrpc.ListChannelsRequest" do
     optional :active_only, :bool, 1
@@ -191,6 +203,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :REMOTE_FORCE_CLOSE, 2
     value :BREACH_CLOSE, 3
     value :FUNDING_CANCELED, 4
+    value :ABANDONED, 5
   end
   add_message "lnrpc.ClosedChannelsRequest" do
     optional :cooperative, :bool, 1
@@ -198,6 +211,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :remote_force, :bool, 3
     optional :breach, :bool, 4
     optional :funding_canceled, :bool, 5
+    optional :abandoned, :bool, 6
   end
   add_message "lnrpc.ClosedChannelsResponse" do
     repeated :channels, :message, 1, "lnrpc.ChannelCloseSummary"
@@ -229,10 +243,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :block_hash, :string, 8
     optional :synced_to_chain, :bool, 9
     optional :testnet, :bool, 10
-    repeated :chains, :string, 11
     repeated :uris, :string, 12
     optional :best_header_timestamp, :int64, 13
     optional :version, :string, 14
+    optional :num_inactive_channels, :uint32, 15
+    repeated :chains, :message, 16, "lnrpc.Chain"
+  end
+  add_message "lnrpc.Chain" do
+    optional :chain, :string, 1
+    optional :network, :string, 2
   end
   add_message "lnrpc.ConfirmationUpdate" do
     optional :block_sha, :bytes, 1
@@ -255,7 +274,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "lnrpc.CloseStatusUpdate" do
     oneof :update do
       optional :close_pending, :message, 1, "lnrpc.PendingUpdate"
-      optional :confirmation, :message, 2, "lnrpc.ConfirmationUpdate"
       optional :chan_close, :message, 3, "lnrpc.ChannelCloseUpdate"
     end
   end
@@ -273,11 +291,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :private, :bool, 8
     optional :min_htlc_msat, :int64, 9
     optional :remote_csv_delay, :uint32, 10
+    optional :min_confs, :int32, 11
+    optional :spend_unconfirmed, :bool, 12
   end
   add_message "lnrpc.OpenStatusUpdate" do
     oneof :update do
       optional :chan_pending, :message, 1, "lnrpc.PendingUpdate"
-      optional :confirmation, :message, 2, "lnrpc.ConfirmationUpdate"
       optional :chan_open, :message, 3, "lnrpc.ChannelOpenUpdate"
     end
   end
@@ -360,6 +379,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :expiry, :uint32, 5
     optional :amt_to_forward_msat, :int64, 6
     optional :fee_msat, :int64, 7
+    optional :pub_key, :string, 8
   end
   add_message "lnrpc.Route" do
     optional :total_time_lock, :uint32, 1
@@ -393,6 +413,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :min_htlc, :int64, 2
     optional :fee_base_msat, :int64, 3
     optional :fee_rate_milli_msat, :int64, 4
+    optional :disabled, :bool, 5
   end
   add_message "lnrpc.ChannelEdge" do
     optional :channel_id, :uint64, 1
@@ -405,6 +426,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :node2_policy, :message, 8, "lnrpc.RoutingPolicy"
   end
   add_message "lnrpc.ChannelGraphRequest" do
+    optional :include_unannounced, :bool, 1
   end
   add_message "lnrpc.ChannelGraph" do
     repeated :nodes, :message, 1, "lnrpc.LightningNode"
@@ -483,10 +505,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :cltv_expiry, :uint64, 13
     repeated :route_hints, :message, 14, "lnrpc.RouteHint"
     optional :private, :bool, 15
+    optional :add_index, :uint64, 16
+    optional :settle_index, :uint64, 17
+    optional :amt_paid, :int64, 18
+    optional :amt_paid_sat, :int64, 19
+    optional :amt_paid_msat, :int64, 20
+    optional :state, :enum, 21, "lnrpc.Invoice.InvoiceState"
+  end
+  add_enum "lnrpc.Invoice.InvoiceState" do
+    value :OPEN, 0
+    value :SETTLED, 1
   end
   add_message "lnrpc.AddInvoiceResponse" do
     optional :r_hash, :bytes, 1
     optional :payment_request, :string, 2
+    optional :add_index, :uint64, 16
   end
   add_message "lnrpc.PaymentHash" do
     optional :r_hash_str, :string, 1
@@ -494,11 +527,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "lnrpc.ListInvoiceRequest" do
     optional :pending_only, :bool, 1
+    optional :index_offset, :uint64, 4
+    optional :num_max_invoices, :uint64, 5
+    optional :reversed, :bool, 6
   end
   add_message "lnrpc.ListInvoiceResponse" do
     repeated :invoices, :message, 1, "lnrpc.Invoice"
+    optional :last_index_offset, :uint64, 2
+    optional :first_index_offset, :uint64, 3
   end
   add_message "lnrpc.InvoiceSubscription" do
+    optional :add_index, :uint64, 1
+    optional :settle_index, :uint64, 2
   end
   add_message "lnrpc.Payment" do
     optional :payment_hash, :string, 1
@@ -507,6 +547,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :path, :string, 4
     optional :fee, :int64, 5
     optional :payment_preimage, :string, 6
+    optional :value_sat, :int64, 7
+    optional :value_msat, :int64, 8
   end
   add_message "lnrpc.ListPaymentsRequest" do
   end
@@ -517,6 +559,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "lnrpc.DeleteAllPaymentsResponse" do
   end
+  add_message "lnrpc.AbandonChannelRequest" do
+    optional :channel_point, :message, 1, "lnrpc.ChannelPoint"
+  end
+  add_message "lnrpc.AbandonChannelResponse" do
+  end
   add_message "lnrpc.DebugLevelRequest" do
     optional :show, :bool, 1
     optional :level_spec, :string, 2
@@ -577,11 +624,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :amt_in, :uint64, 5
     optional :amt_out, :uint64, 6
     optional :fee, :uint64, 7
+    optional :fee_msat, :uint64, 8
   end
   add_message "lnrpc.ForwardingHistoryResponse" do
     repeated :forwarding_events, :message, 1, "lnrpc.ForwardingEvent"
     optional :last_offset_index, :uint32, 2
   end
+  add_enum "lnrpc.AddressType" do
+    value :WITNESS_PUBKEY_HASH, 0
+    value :NESTED_PUBKEY_HASH, 1
+  end
 end
 
 module Lnrpc
@@ -593,6 +645,7 @@ module Lnrpc
   UnlockWalletResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.UnlockWalletResponse").msgclass
   ChangePasswordRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordRequest").msgclass
   ChangePasswordResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordResponse").msgclass
+  Utxo = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Utxo").msgclass
   Transaction = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Transaction").msgclass
   GetTransactionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetTransactionsRequest").msgclass
   TransactionDetails = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.TransactionDetails").msgclass
@@ -606,9 +659,9 @@ module Lnrpc
   SendManyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendManyResponse").msgclass
   SendCoinsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendCoinsRequest").msgclass
   SendCoinsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendCoinsResponse").msgclass
+  ListUnspentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListUnspentRequest").msgclass
+  ListUnspentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListUnspentResponse").msgclass
   NewAddressRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressRequest").msgclass
-  NewAddressRequest::AddressType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressRequest.AddressType").enummodule
-  NewWitnessAddressRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewWitnessAddressRequest").msgclass
   NewAddressResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressResponse").msgclass
   SignMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SignMessageRequest").msgclass
   SignMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SignMessageResponse").msgclass
@@ -631,6 +684,7 @@ module Lnrpc
   ListPeersResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListPeersResponse").msgclass
   GetInfoRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetInfoRequest").msgclass
   GetInfoResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetInfoResponse").msgclass
+  Chain = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Chain").msgclass
   ConfirmationUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ConfirmationUpdate").msgclass
   ChannelOpenUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelOpenUpdate").msgclass
   ChannelCloseUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelCloseUpdate").msgclass
@@ -676,6 +730,7 @@ module Lnrpc
   HopHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.HopHint").msgclass
   RouteHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.RouteHint").msgclass
   Invoice = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Invoice").msgclass
+  Invoice::InvoiceState = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Invoice.InvoiceState").enummodule
   AddInvoiceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AddInvoiceResponse").msgclass
   PaymentHash = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PaymentHash").msgclass
   ListInvoiceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListInvoiceRequest").msgclass
@@ -686,6 +741,8 @@ module Lnrpc
   ListPaymentsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListPaymentsResponse").msgclass
   DeleteAllPaymentsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.DeleteAllPaymentsRequest").msgclass
   DeleteAllPaymentsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.DeleteAllPaymentsResponse").msgclass
+  AbandonChannelRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AbandonChannelRequest").msgclass
+  AbandonChannelResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AbandonChannelResponse").msgclass
   DebugLevelRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.DebugLevelRequest").msgclass
   DebugLevelResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.DebugLevelResponse").msgclass
   PayReqString = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PayReqString").msgclass
@@ -698,4 +755,5 @@ module Lnrpc
   ForwardingHistoryRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingHistoryRequest").msgclass
   ForwardingEvent = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingEvent").msgclass
   ForwardingHistoryResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingHistoryResponse").msgclass
+  AddressType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AddressType").enummodule
 end

data/lib/rpc_services_pb.rb

@@ -2,10 +2,31 @@
 # Source: rpc.proto for package 'lnrpc'
 
 require 'grpc'
-require_relative 'rpc_pb'
+require 'rpc_pb'
 
 module Lnrpc
   module WalletUnlocker
+    # *
+    # 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. 
+    # 
+    # One edge case exists where a // comment followed by a /// comment in the
+    # next line will cause the description not to show up in the documentation. In
+    # that instance, simply separate the two comments with a blank line.
+    # 
+    # 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
+    #
     # The WalletUnlocker service is used to set up a wallet password for
     # lnd at first startup, and unlock a previously set up wallet.
     class Service
@@ -81,6 +102,10 @@ module Lnrpc
       # consult its fee model to determine a fee for the default confirmation
       # target.
       rpc :SendCoins, SendCoinsRequest, SendCoinsResponse
+      # * lncli: `listunspent`
+      # 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, ListUnspentResponse
       # *
       # SubscribeTransactions creates a uni-directional stream from the server to
       # the client in which any newly discovered transactions relevant to the
@@ -95,9 +120,6 @@ module Lnrpc
       # * lncli: `newaddress`
       # NewAddress creates a new address under control of the local wallet.
       rpc :NewAddress, NewAddressRequest, NewAddressResponse
-      # *
-      # NewWitnessAddress creates a new witness address under control of the local wallet.
-      rpc :NewWitnessAddress, NewWitnessAddressRequest, 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
@@ -165,6 +187,12 @@ module Lnrpc
       # 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, 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, AbandonChannelResponse
       # * lncli: `sendpayment`
       # SendPayment dispatches a bi-directional streaming RPC for sending payments
       # through the Lightning Network. A single RPC invocation creates a persistent
@@ -194,7 +222,12 @@ module Lnrpc
       rpc :AddInvoice, Invoice, AddInvoiceResponse
       # * lncli: `listinvoices`
       # ListInvoices returns a list of all the invoices currently stored within the
-      # database. Any active debug invoices are ignored.
+      # 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, ListInvoiceResponse
       # * lncli: `lookupinvoice`
       # LookupInvoice attempts to look up an invoice according to its payment hash.
@@ -202,8 +235,15 @@ module Lnrpc
       # returned.
       rpc :LookupInvoice, PaymentHash, Invoice
       # *
-      # SubscribeInvoices returns a uni-directional stream (sever -> client) for
-      # notifying the client of newly added/settled invoices.
+      # 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, stream(Invoice)
       # * lncli: `decodepayreq`
       # DecodePayReq takes an encoded payment request string and attempts to decode

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lightning_network
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ivan Acosta-Rubio