lnrpc 0.5.2 → 0.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +40 -17
- data/examples.rb +4 -0
- data/lib/lnrpc/client.rb +16 -9
- data/lib/lnrpc/rpc.proto +423 -31
- data/lib/lnrpc/rpc_pb.rb +145 -9
- data/lib/lnrpc/rpc_services_pb.rb +73 -5
- data/lib/lnrpc/version.rb +1 -1
- metadata +2 -2
data/lib/lnrpc/rpc_pb.rb
CHANGED
@@ -18,12 +18,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
18
18
|
repeated :cipher_seed_mnemonic, :string, 2
|
19
19
|
optional :aezeed_passphrase, :bytes, 3
|
20
20
|
optional :recovery_window, :int32, 4
|
21
|
+
optional :channel_backups, :message, 5, "lnrpc.ChanBackupSnapshot"
|
21
22
|
end
|
22
23
|
add_message "lnrpc.InitWalletResponse" do
|
23
24
|
end
|
24
25
|
add_message "lnrpc.UnlockWalletRequest" do
|
25
26
|
optional :wallet_password, :bytes, 1
|
26
27
|
optional :recovery_window, :int32, 2
|
28
|
+
optional :channel_backups, :message, 3, "lnrpc.ChanBackupSnapshot"
|
27
29
|
end
|
28
30
|
add_message "lnrpc.UnlockWalletResponse" do
|
29
31
|
end
|
@@ -33,6 +35,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
33
35
|
end
|
34
36
|
add_message "lnrpc.ChangePasswordResponse" do
|
35
37
|
end
|
38
|
+
add_message "lnrpc.Utxo" do
|
39
|
+
optional :type, :enum, 1, "lnrpc.AddressType"
|
40
|
+
optional :address, :string, 2
|
41
|
+
optional :amount_sat, :int64, 3
|
42
|
+
optional :pk_script, :string, 4
|
43
|
+
optional :outpoint, :message, 5, "lnrpc.OutPoint"
|
44
|
+
optional :confirmations, :int64, 6
|
45
|
+
end
|
36
46
|
add_message "lnrpc.Transaction" do
|
37
47
|
optional :tx_hash, :string, 1
|
38
48
|
optional :amount, :int64, 2
|
@@ -63,16 +73,20 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
63
73
|
optional :payment_request, :string, 6
|
64
74
|
optional :final_cltv_delta, :int32, 7
|
65
75
|
optional :fee_limit, :message, 8, "lnrpc.FeeLimit"
|
76
|
+
optional :outgoing_chan_id, :uint64, 9
|
77
|
+
optional :cltv_limit, :uint32, 10
|
66
78
|
end
|
67
79
|
add_message "lnrpc.SendResponse" do
|
68
80
|
optional :payment_error, :string, 1
|
69
81
|
optional :payment_preimage, :bytes, 2
|
70
82
|
optional :payment_route, :message, 3, "lnrpc.Route"
|
83
|
+
optional :payment_hash, :bytes, 4
|
71
84
|
end
|
72
85
|
add_message "lnrpc.SendToRouteRequest" do
|
73
86
|
optional :payment_hash, :bytes, 1
|
74
87
|
optional :payment_hash_string, :string, 2
|
75
88
|
repeated :routes, :message, 3, "lnrpc.Route"
|
89
|
+
optional :route, :message, 4, "lnrpc.Route"
|
76
90
|
end
|
77
91
|
add_message "lnrpc.ChannelPoint" do
|
78
92
|
optional :output_index, :uint32, 3
|
@@ -81,10 +95,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
81
95
|
optional :funding_txid_str, :string, 2
|
82
96
|
end
|
83
97
|
end
|
98
|
+
add_message "lnrpc.OutPoint" do
|
99
|
+
optional :txid_bytes, :bytes, 1
|
100
|
+
optional :txid_str, :string, 2
|
101
|
+
optional :output_index, :uint32, 3
|
102
|
+
end
|
84
103
|
add_message "lnrpc.LightningAddress" do
|
85
104
|
optional :pubkey, :string, 1
|
86
105
|
optional :host, :string, 2
|
87
106
|
end
|
107
|
+
add_message "lnrpc.EstimateFeeRequest" do
|
108
|
+
map :AddrToAmount, :string, :int64, 1
|
109
|
+
optional :target_conf, :int32, 2
|
110
|
+
end
|
111
|
+
add_message "lnrpc.EstimateFeeResponse" do
|
112
|
+
optional :fee_sat, :int64, 1
|
113
|
+
optional :feerate_sat_per_byte, :int64, 2
|
114
|
+
end
|
88
115
|
add_message "lnrpc.SendManyRequest" do
|
89
116
|
map :AddrToAmount, :string, :int64, 1
|
90
117
|
optional :target_conf, :int32, 3
|
@@ -98,16 +125,20 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
98
125
|
optional :amount, :int64, 2
|
99
126
|
optional :target_conf, :int32, 3
|
100
127
|
optional :sat_per_byte, :int64, 5
|
128
|
+
optional :send_all, :bool, 6
|
101
129
|
end
|
102
130
|
add_message "lnrpc.SendCoinsResponse" do
|
103
131
|
optional :txid, :string, 1
|
104
132
|
end
|
105
|
-
add_message "lnrpc.
|
106
|
-
optional :
|
133
|
+
add_message "lnrpc.ListUnspentRequest" do
|
134
|
+
optional :min_confs, :int32, 1
|
135
|
+
optional :max_confs, :int32, 2
|
107
136
|
end
|
108
|
-
|
109
|
-
|
110
|
-
|
137
|
+
add_message "lnrpc.ListUnspentResponse" do
|
138
|
+
repeated :utxos, :message, 1, "lnrpc.Utxo"
|
139
|
+
end
|
140
|
+
add_message "lnrpc.NewAddressRequest" do
|
141
|
+
optional :type, :enum, 1, "lnrpc.AddressType"
|
111
142
|
end
|
112
143
|
add_message "lnrpc.NewAddressResponse" do
|
113
144
|
optional :address, :string, 1
|
@@ -161,6 +192,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
161
192
|
repeated :pending_htlcs, :message, 15, "lnrpc.HTLC"
|
162
193
|
optional :csv_delay, :uint32, 16
|
163
194
|
optional :private, :bool, 17
|
195
|
+
optional :initiator, :bool, 18
|
196
|
+
optional :chan_status_flags, :string, 19
|
164
197
|
end
|
165
198
|
add_message "lnrpc.ListChannelsRequest" do
|
166
199
|
optional :active_only, :bool, 1
|
@@ -211,6 +244,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
211
244
|
optional :sat_recv, :int64, 7
|
212
245
|
optional :inbound, :bool, 8
|
213
246
|
optional :ping_time, :int64, 9
|
247
|
+
optional :sync_type, :enum, 10, "lnrpc.Peer.SyncType"
|
248
|
+
end
|
249
|
+
add_enum "lnrpc.Peer.SyncType" do
|
250
|
+
value :UNKNOWN_SYNC, 0
|
251
|
+
value :ACTIVE_SYNC, 1
|
252
|
+
value :PASSIVE_SYNC, 2
|
214
253
|
end
|
215
254
|
add_message "lnrpc.ListPeersRequest" do
|
216
255
|
end
|
@@ -229,11 +268,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
229
268
|
optional :block_hash, :string, 8
|
230
269
|
optional :synced_to_chain, :bool, 9
|
231
270
|
optional :testnet, :bool, 10
|
232
|
-
repeated :chains, :string, 11
|
233
271
|
repeated :uris, :string, 12
|
234
272
|
optional :best_header_timestamp, :int64, 13
|
235
273
|
optional :version, :string, 14
|
236
274
|
optional :num_inactive_channels, :uint32, 15
|
275
|
+
repeated :chains, :message, 16, "lnrpc.Chain"
|
276
|
+
end
|
277
|
+
add_message "lnrpc.Chain" do
|
278
|
+
optional :chain, :string, 1
|
279
|
+
optional :network, :string, 2
|
237
280
|
end
|
238
281
|
add_message "lnrpc.ConfirmationUpdate" do
|
239
282
|
optional :block_sha, :bytes, 1
|
@@ -256,7 +299,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
256
299
|
add_message "lnrpc.CloseStatusUpdate" do
|
257
300
|
oneof :update do
|
258
301
|
optional :close_pending, :message, 1, "lnrpc.PendingUpdate"
|
259
|
-
optional :confirmation, :message, 2, "lnrpc.ConfirmationUpdate"
|
260
302
|
optional :chan_close, :message, 3, "lnrpc.ChannelCloseUpdate"
|
261
303
|
end
|
262
304
|
end
|
@@ -280,7 +322,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
280
322
|
add_message "lnrpc.OpenStatusUpdate" do
|
281
323
|
oneof :update do
|
282
324
|
optional :chan_pending, :message, 1, "lnrpc.PendingUpdate"
|
283
|
-
optional :confirmation, :message, 2, "lnrpc.ConfirmationUpdate"
|
284
325
|
optional :chan_open, :message, 3, "lnrpc.ChannelOpenUpdate"
|
285
326
|
end
|
286
327
|
end
|
@@ -332,6 +373,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
332
373
|
optional :recovered_balance, :int64, 6
|
333
374
|
repeated :pending_htlcs, :message, 8, "lnrpc.PendingHTLC"
|
334
375
|
end
|
376
|
+
add_message "lnrpc.ChannelEventSubscription" do
|
377
|
+
end
|
378
|
+
add_message "lnrpc.ChannelEventUpdate" do
|
379
|
+
optional :type, :enum, 5, "lnrpc.ChannelEventUpdate.UpdateType"
|
380
|
+
oneof :channel do
|
381
|
+
optional :open_channel, :message, 1, "lnrpc.Channel"
|
382
|
+
optional :closed_channel, :message, 2, "lnrpc.ChannelCloseSummary"
|
383
|
+
optional :active_channel, :message, 3, "lnrpc.ChannelPoint"
|
384
|
+
optional :inactive_channel, :message, 4, "lnrpc.ChannelPoint"
|
385
|
+
end
|
386
|
+
end
|
387
|
+
add_enum "lnrpc.ChannelEventUpdate.UpdateType" do
|
388
|
+
value :OPEN_CHANNEL, 0
|
389
|
+
value :CLOSED_CHANNEL, 1
|
390
|
+
value :ACTIVE_CHANNEL, 2
|
391
|
+
value :INACTIVE_CHANNEL, 3
|
392
|
+
end
|
335
393
|
add_message "lnrpc.WalletBalanceRequest" do
|
336
394
|
end
|
337
395
|
add_message "lnrpc.WalletBalanceResponse" do
|
@@ -351,6 +409,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
351
409
|
optional :num_routes, :int32, 3
|
352
410
|
optional :final_cltv_delta, :int32, 4
|
353
411
|
optional :fee_limit, :message, 5, "lnrpc.FeeLimit"
|
412
|
+
repeated :ignored_nodes, :bytes, 6
|
413
|
+
repeated :ignored_edges, :message, 7, "lnrpc.EdgeLocator"
|
414
|
+
optional :source_pub_key, :string, 8
|
415
|
+
end
|
416
|
+
add_message "lnrpc.EdgeLocator" do
|
417
|
+
optional :channel_id, :uint64, 1
|
418
|
+
optional :direction_reverse, :bool, 2
|
354
419
|
end
|
355
420
|
add_message "lnrpc.QueryRoutesResponse" do
|
356
421
|
repeated :routes, :message, 1, "lnrpc.Route"
|
@@ -398,6 +463,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
398
463
|
optional :fee_base_msat, :int64, 3
|
399
464
|
optional :fee_rate_milli_msat, :int64, 4
|
400
465
|
optional :disabled, :bool, 5
|
466
|
+
optional :max_htlc_msat, :uint64, 6
|
401
467
|
end
|
402
468
|
add_message "lnrpc.ChannelEdge" do
|
403
469
|
optional :channel_id, :uint64, 1
|
@@ -431,6 +497,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
431
497
|
optional :avg_channel_size, :double, 7
|
432
498
|
optional :min_channel_size, :int64, 8
|
433
499
|
optional :max_channel_size, :int64, 9
|
500
|
+
optional :median_channel_size_sat, :int64, 10
|
434
501
|
end
|
435
502
|
add_message "lnrpc.StopRequest" do
|
436
503
|
end
|
@@ -494,6 +561,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
494
561
|
optional :amt_paid, :int64, 18
|
495
562
|
optional :amt_paid_sat, :int64, 19
|
496
563
|
optional :amt_paid_msat, :int64, 20
|
564
|
+
optional :state, :enum, 21, "lnrpc.Invoice.InvoiceState"
|
565
|
+
end
|
566
|
+
add_enum "lnrpc.Invoice.InvoiceState" do
|
567
|
+
value :OPEN, 0
|
568
|
+
value :SETTLED, 1
|
569
|
+
value :CANCELED, 2
|
570
|
+
value :ACCEPTED, 3
|
497
571
|
end
|
498
572
|
add_message "lnrpc.AddInvoiceResponse" do
|
499
573
|
optional :r_hash, :bytes, 1
|
@@ -603,11 +677,50 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
603
677
|
optional :amt_in, :uint64, 5
|
604
678
|
optional :amt_out, :uint64, 6
|
605
679
|
optional :fee, :uint64, 7
|
680
|
+
optional :fee_msat, :uint64, 8
|
606
681
|
end
|
607
682
|
add_message "lnrpc.ForwardingHistoryResponse" do
|
608
683
|
repeated :forwarding_events, :message, 1, "lnrpc.ForwardingEvent"
|
609
684
|
optional :last_offset_index, :uint32, 2
|
610
685
|
end
|
686
|
+
add_message "lnrpc.ExportChannelBackupRequest" do
|
687
|
+
optional :chan_point, :message, 1, "lnrpc.ChannelPoint"
|
688
|
+
end
|
689
|
+
add_message "lnrpc.ChannelBackup" do
|
690
|
+
optional :chan_point, :message, 1, "lnrpc.ChannelPoint"
|
691
|
+
optional :chan_backup, :bytes, 2
|
692
|
+
end
|
693
|
+
add_message "lnrpc.MultiChanBackup" do
|
694
|
+
repeated :chan_points, :message, 1, "lnrpc.ChannelPoint"
|
695
|
+
optional :multi_chan_backup, :bytes, 2
|
696
|
+
end
|
697
|
+
add_message "lnrpc.ChanBackupExportRequest" do
|
698
|
+
end
|
699
|
+
add_message "lnrpc.ChanBackupSnapshot" do
|
700
|
+
optional :single_chan_backups, :message, 1, "lnrpc.ChannelBackups"
|
701
|
+
optional :multi_chan_backup, :message, 2, "lnrpc.MultiChanBackup"
|
702
|
+
end
|
703
|
+
add_message "lnrpc.ChannelBackups" do
|
704
|
+
repeated :chan_backups, :message, 1, "lnrpc.ChannelBackup"
|
705
|
+
end
|
706
|
+
add_message "lnrpc.RestoreChanBackupRequest" do
|
707
|
+
oneof :backup do
|
708
|
+
optional :chan_backups, :message, 1, "lnrpc.ChannelBackups"
|
709
|
+
optional :multi_chan_backup, :bytes, 2
|
710
|
+
end
|
711
|
+
end
|
712
|
+
add_message "lnrpc.RestoreBackupResponse" do
|
713
|
+
end
|
714
|
+
add_message "lnrpc.ChannelBackupSubscription" do
|
715
|
+
end
|
716
|
+
add_message "lnrpc.VerifyChanBackupResponse" do
|
717
|
+
end
|
718
|
+
add_enum "lnrpc.AddressType" do
|
719
|
+
value :WITNESS_PUBKEY_HASH, 0
|
720
|
+
value :NESTED_PUBKEY_HASH, 1
|
721
|
+
value :UNUSED_WITNESS_PUBKEY_HASH, 2
|
722
|
+
value :UNUSED_NESTED_PUBKEY_HASH, 3
|
723
|
+
end
|
611
724
|
end
|
612
725
|
|
613
726
|
module Lnrpc
|
@@ -619,6 +732,7 @@ module Lnrpc
|
|
619
732
|
UnlockWalletResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.UnlockWalletResponse").msgclass
|
620
733
|
ChangePasswordRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordRequest").msgclass
|
621
734
|
ChangePasswordResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChangePasswordResponse").msgclass
|
735
|
+
Utxo = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Utxo").msgclass
|
622
736
|
Transaction = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Transaction").msgclass
|
623
737
|
GetTransactionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetTransactionsRequest").msgclass
|
624
738
|
TransactionDetails = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.TransactionDetails").msgclass
|
@@ -627,13 +741,17 @@ module Lnrpc
|
|
627
741
|
SendResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendResponse").msgclass
|
628
742
|
SendToRouteRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendToRouteRequest").msgclass
|
629
743
|
ChannelPoint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelPoint").msgclass
|
744
|
+
OutPoint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.OutPoint").msgclass
|
630
745
|
LightningAddress = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.LightningAddress").msgclass
|
746
|
+
EstimateFeeRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.EstimateFeeRequest").msgclass
|
747
|
+
EstimateFeeResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.EstimateFeeResponse").msgclass
|
631
748
|
SendManyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendManyRequest").msgclass
|
632
749
|
SendManyResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendManyResponse").msgclass
|
633
750
|
SendCoinsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendCoinsRequest").msgclass
|
634
751
|
SendCoinsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SendCoinsResponse").msgclass
|
752
|
+
ListUnspentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListUnspentRequest").msgclass
|
753
|
+
ListUnspentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListUnspentResponse").msgclass
|
635
754
|
NewAddressRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressRequest").msgclass
|
636
|
-
NewAddressRequest::AddressType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressRequest.AddressType").enummodule
|
637
755
|
NewAddressResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.NewAddressResponse").msgclass
|
638
756
|
SignMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SignMessageRequest").msgclass
|
639
757
|
SignMessageResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.SignMessageResponse").msgclass
|
@@ -652,10 +770,12 @@ module Lnrpc
|
|
652
770
|
ClosedChannelsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ClosedChannelsRequest").msgclass
|
653
771
|
ClosedChannelsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ClosedChannelsResponse").msgclass
|
654
772
|
Peer = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Peer").msgclass
|
773
|
+
Peer::SyncType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Peer.SyncType").enummodule
|
655
774
|
ListPeersRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListPeersRequest").msgclass
|
656
775
|
ListPeersResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListPeersResponse").msgclass
|
657
776
|
GetInfoRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetInfoRequest").msgclass
|
658
777
|
GetInfoResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.GetInfoResponse").msgclass
|
778
|
+
Chain = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Chain").msgclass
|
659
779
|
ConfirmationUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ConfirmationUpdate").msgclass
|
660
780
|
ChannelOpenUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelOpenUpdate").msgclass
|
661
781
|
ChannelCloseUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelCloseUpdate").msgclass
|
@@ -672,11 +792,15 @@ module Lnrpc
|
|
672
792
|
PendingChannelsResponse::WaitingCloseChannel = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PendingChannelsResponse.WaitingCloseChannel").msgclass
|
673
793
|
PendingChannelsResponse::ClosedChannel = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PendingChannelsResponse.ClosedChannel").msgclass
|
674
794
|
PendingChannelsResponse::ForceClosedChannel = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PendingChannelsResponse.ForceClosedChannel").msgclass
|
795
|
+
ChannelEventSubscription = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelEventSubscription").msgclass
|
796
|
+
ChannelEventUpdate = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelEventUpdate").msgclass
|
797
|
+
ChannelEventUpdate::UpdateType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelEventUpdate.UpdateType").enummodule
|
675
798
|
WalletBalanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.WalletBalanceRequest").msgclass
|
676
799
|
WalletBalanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.WalletBalanceResponse").msgclass
|
677
800
|
ChannelBalanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelBalanceRequest").msgclass
|
678
801
|
ChannelBalanceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelBalanceResponse").msgclass
|
679
802
|
QueryRoutesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.QueryRoutesRequest").msgclass
|
803
|
+
EdgeLocator = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.EdgeLocator").msgclass
|
680
804
|
QueryRoutesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.QueryRoutesResponse").msgclass
|
681
805
|
Hop = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Hop").msgclass
|
682
806
|
Route = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Route").msgclass
|
@@ -701,6 +825,7 @@ module Lnrpc
|
|
701
825
|
HopHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.HopHint").msgclass
|
702
826
|
RouteHint = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.RouteHint").msgclass
|
703
827
|
Invoice = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Invoice").msgclass
|
828
|
+
Invoice::InvoiceState = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.Invoice.InvoiceState").enummodule
|
704
829
|
AddInvoiceResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AddInvoiceResponse").msgclass
|
705
830
|
PaymentHash = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.PaymentHash").msgclass
|
706
831
|
ListInvoiceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ListInvoiceRequest").msgclass
|
@@ -725,4 +850,15 @@ module Lnrpc
|
|
725
850
|
ForwardingHistoryRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingHistoryRequest").msgclass
|
726
851
|
ForwardingEvent = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingEvent").msgclass
|
727
852
|
ForwardingHistoryResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ForwardingHistoryResponse").msgclass
|
853
|
+
ExportChannelBackupRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ExportChannelBackupRequest").msgclass
|
854
|
+
ChannelBackup = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelBackup").msgclass
|
855
|
+
MultiChanBackup = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.MultiChanBackup").msgclass
|
856
|
+
ChanBackupExportRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChanBackupExportRequest").msgclass
|
857
|
+
ChanBackupSnapshot = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChanBackupSnapshot").msgclass
|
858
|
+
ChannelBackups = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelBackups").msgclass
|
859
|
+
RestoreChanBackupRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.RestoreChanBackupRequest").msgclass
|
860
|
+
RestoreBackupResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.RestoreBackupResponse").msgclass
|
861
|
+
ChannelBackupSubscription = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.ChannelBackupSubscription").msgclass
|
862
|
+
VerifyChanBackupResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.VerifyChanBackupResponse").msgclass
|
863
|
+
AddressType = Google::Protobuf::DescriptorPool.generated_pool.lookup("lnrpc.AddressType").enummodule
|
728
864
|
end
|
@@ -6,6 +6,27 @@ require_relative 'rpc_pb'
|
|
6
6
|
|
7
7
|
module Lnrpc
|
8
8
|
module WalletUnlocker
|
9
|
+
# *
|
10
|
+
# Comments in this file will be directly parsed into the API
|
11
|
+
# Documentation as descriptions of the associated method, message, or field.
|
12
|
+
# These descriptions should go right above the definition of the object, and
|
13
|
+
# can be in either block or /// comment format.
|
14
|
+
#
|
15
|
+
# One edge case exists where a // comment followed by a /// comment in the
|
16
|
+
# next line will cause the description not to show up in the documentation. In
|
17
|
+
# that instance, simply separate the two comments with a blank line.
|
18
|
+
#
|
19
|
+
# An RPC method can be matched to an lncli command by placing a line in the
|
20
|
+
# beginning of the description in exactly the following format:
|
21
|
+
# lncli: `methodname`
|
22
|
+
#
|
23
|
+
# Failure to specify the exact name of the command will cause documentation
|
24
|
+
# generation to fail.
|
25
|
+
#
|
26
|
+
# More information on how exactly the gRPC documentation is generated from
|
27
|
+
# this proto file can be found here:
|
28
|
+
# https://github.com/lightninglabs/lightning-api
|
29
|
+
#
|
9
30
|
# The WalletUnlocker service is used to set up a wallet password for
|
10
31
|
# lnd at first startup, and unlock a previously set up wallet.
|
11
32
|
class Service
|
@@ -74,6 +95,10 @@ module Lnrpc
|
|
74
95
|
# GetTransactions returns a list describing all the known transactions
|
75
96
|
# relevant to the wallet.
|
76
97
|
rpc :GetTransactions, GetTransactionsRequest, TransactionDetails
|
98
|
+
# * lncli: `estimatefee`
|
99
|
+
# EstimateFee asks the chain backend to estimate the fee rate and total fees
|
100
|
+
# for a transaction that pays to multiple specified outputs.
|
101
|
+
rpc :EstimateFee, EstimateFeeRequest, EstimateFeeResponse
|
77
102
|
# * lncli: `sendcoins`
|
78
103
|
# SendCoins executes a request to send coins to a particular address. Unlike
|
79
104
|
# SendMany, this RPC call only allows creating a single output at a time. If
|
@@ -81,6 +106,10 @@ module Lnrpc
|
|
81
106
|
# consult its fee model to determine a fee for the default confirmation
|
82
107
|
# target.
|
83
108
|
rpc :SendCoins, SendCoinsRequest, SendCoinsResponse
|
109
|
+
# * lncli: `listunspent`
|
110
|
+
# ListUnspent returns a list of all utxos spendable by the wallet with a
|
111
|
+
# number of confirmations between the specified minimum and maximum.
|
112
|
+
rpc :ListUnspent, ListUnspentRequest, ListUnspentResponse
|
84
113
|
# *
|
85
114
|
# SubscribeTransactions creates a uni-directional stream from the server to
|
86
115
|
# the client in which any newly discovered transactions relevant to the
|
@@ -136,6 +165,12 @@ module Lnrpc
|
|
136
165
|
# ListChannels returns a description of all the open channels that this node
|
137
166
|
# is a participant in.
|
138
167
|
rpc :ListChannels, ListChannelsRequest, ListChannelsResponse
|
168
|
+
# * lncli: `subscribechannelevents`
|
169
|
+
# SubscribeChannelEvents creates a uni-directional stream from the server to
|
170
|
+
# the client in which any updates relevant to the state of the channels are
|
171
|
+
# sent over. Events include new active channels, inactive channels, and closed
|
172
|
+
# channels.
|
173
|
+
rpc :SubscribeChannelEvents, ChannelEventSubscription, stream(ChannelEventUpdate)
|
139
174
|
# * lncli: `closedchannels`
|
140
175
|
# ClosedChannels returns a description of all the closed channels that
|
141
176
|
# this node was a participant in.
|
@@ -201,10 +236,8 @@ module Lnrpc
|
|
201
236
|
# paginated responses, allowing users to query for specific invoices through
|
202
237
|
# their add_index. This can be done by using either the first_index_offset or
|
203
238
|
# last_index_offset fields included in the response as the index_offset of the
|
204
|
-
# next request.
|
205
|
-
#
|
206
|
-
# flag to false. If none of the parameters are specified, then the last 100
|
207
|
-
# invoices will be returned.
|
239
|
+
# next request. By default, the first 100 invoices created will be returned.
|
240
|
+
# Backwards pagination is also supported through the Reversed flag.
|
208
241
|
rpc :ListInvoices, ListInvoiceRequest, ListInvoiceResponse
|
209
242
|
# * lncli: `lookupinvoice`
|
210
243
|
# LookupInvoice attempts to look up an invoice according to its payment hash.
|
@@ -290,7 +323,7 @@ module Lnrpc
|
|
290
323
|
rpc :UpdateChannelPolicy, PolicyUpdateRequest, PolicyUpdateResponse
|
291
324
|
# * lncli: `fwdinghistory`
|
292
325
|
# ForwardingHistory allows the caller to query the htlcswitch for a record of
|
293
|
-
# all
|
326
|
+
# all HTLCs forwarded within the target time range, and integer offset
|
294
327
|
# within that time range. If no time-range is specified, then the first chunk
|
295
328
|
# of the past 24 hrs of forwarding history are returned.
|
296
329
|
#
|
@@ -300,6 +333,41 @@ module Lnrpc
|
|
300
333
|
# the index offset of the last entry. The index offset can be provided to the
|
301
334
|
# request to allow the caller to skip a series of records.
|
302
335
|
rpc :ForwardingHistory, ForwardingHistoryRequest, ForwardingHistoryResponse
|
336
|
+
# * lncli: `exportchanbackup`
|
337
|
+
# ExportChannelBackup attempts to return an encrypted static channel backup
|
338
|
+
# for the target channel identified by it channel point. The backup is
|
339
|
+
# encrypted with a key generated from the aezeed seed of the user. The
|
340
|
+
# returned backup can either be restored using the RestoreChannelBackup
|
341
|
+
# method once lnd is running, or via the InitWallet and UnlockWallet methods
|
342
|
+
# from the WalletUnlocker service.
|
343
|
+
rpc :ExportChannelBackup, ExportChannelBackupRequest, ChannelBackup
|
344
|
+
# *
|
345
|
+
# ExportAllChannelBackups returns static channel backups for all existing
|
346
|
+
# channels known to lnd. A set of regular singular static channel backups for
|
347
|
+
# each channel are returned. Additionally, a multi-channel backup is returned
|
348
|
+
# as well, which contains a single encrypted blob containing the backups of
|
349
|
+
# each channel.
|
350
|
+
rpc :ExportAllChannelBackups, ChanBackupExportRequest, ChanBackupSnapshot
|
351
|
+
# *
|
352
|
+
# VerifyChanBackup allows a caller to verify the integrity of a channel backup
|
353
|
+
# snapshot. This method will accept either a packed Single or a packed Multi.
|
354
|
+
# Specifying both will result in an error.
|
355
|
+
rpc :VerifyChanBackup, ChanBackupSnapshot, VerifyChanBackupResponse
|
356
|
+
# * lncli: `restorechanbackup`
|
357
|
+
# RestoreChannelBackups accepts a set of singular channel backups, or a
|
358
|
+
# single encrypted multi-chan backup and attempts to recover any funds
|
359
|
+
# remaining within the channel. If we are able to unpack the backup, then the
|
360
|
+
# new channel will be shown under listchannels, as well as pending channels.
|
361
|
+
rpc :RestoreChannelBackups, RestoreChanBackupRequest, RestoreBackupResponse
|
362
|
+
# *
|
363
|
+
# SubscribeChannelBackups allows a client to sub-subscribe to the most up to
|
364
|
+
# date information concerning the state of all channel backups. Each time a
|
365
|
+
# new channel is added, we return the new set of channels, along with a
|
366
|
+
# multi-chan backup containing the backup info for all channels. Each time a
|
367
|
+
# channel is closed, we send a new update, which contains new new chan back
|
368
|
+
# ups, but the updated set of encrypted multi-chan backups with the closed
|
369
|
+
# channel(s) removed.
|
370
|
+
rpc :SubscribeChannelBackups, ChannelBackupSubscription, stream(ChanBackupSnapshot)
|
303
371
|
end
|
304
372
|
|
305
373
|
Stub = Service.rpc_stub_class
|