1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
// This file is @generated by prost-build.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct LookupHtlcResolutionRequest {
#[prost(uint64, tag = "1")]
pub chan_id: u64,
#[prost(uint64, tag = "2")]
pub htlc_index: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct LookupHtlcResolutionResponse {
/// Settled is true is the htlc was settled. If false, the htlc was failed.
#[prost(bool, tag = "1")]
pub settled: bool,
/// Offchain indicates whether the htlc was resolved off-chain or on-chain.
#[prost(bool, tag = "2")]
pub offchain: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SubscribeCustomMessagesRequest {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CustomMessage {
/// Peer from which the message originates
#[prost(bytes = "vec", tag = "1")]
pub peer: ::prost::alloc::vec::Vec<u8>,
/// Message type. This value will be in the custom range (>= 32768).
#[prost(uint32, tag = "2")]
pub r#type: u32,
/// Raw message data
#[prost(bytes = "vec", tag = "3")]
pub data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SendCustomMessageRequest {
/// Peer to send the message to
#[prost(bytes = "vec", tag = "1")]
pub peer: ::prost::alloc::vec::Vec<u8>,
/// Message type. This value needs to be in the custom range (>= 32768).
/// To send a type \< custom range, lnd needs to be compiled with the `dev`
/// build tag, and the message type to override should be specified in lnd's
/// experimental protocol configuration.
#[prost(uint32, tag = "2")]
pub r#type: u32,
/// Raw message data.
#[prost(bytes = "vec", tag = "3")]
pub data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SendCustomMessageResponse {
/// The status of the send operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Utxo {
/// The type of address
#[prost(enumeration = "AddressType", tag = "1")]
pub address_type: i32,
/// The address
#[prost(string, tag = "2")]
pub address: ::prost::alloc::string::String,
/// The value of the unspent coin in satoshis
#[prost(int64, tag = "3")]
pub amount_sat: i64,
/// The pkscript in hex
#[prost(string, tag = "4")]
pub pk_script: ::prost::alloc::string::String,
/// The outpoint in format txid:n
#[prost(message, optional, tag = "5")]
pub outpoint: ::core::option::Option<OutPoint>,
/// The number of confirmations for the Utxo
#[prost(int64, tag = "6")]
pub confirmations: i64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct OutputDetail {
/// The type of the output
#[prost(enumeration = "OutputScriptType", tag = "1")]
pub output_type: i32,
/// The address
#[prost(string, tag = "2")]
pub address: ::prost::alloc::string::String,
/// The pkscript in hex
#[prost(string, tag = "3")]
pub pk_script: ::prost::alloc::string::String,
/// The output index used in the raw transaction
#[prost(int64, tag = "4")]
pub output_index: i64,
/// The value of the output coin in satoshis
#[prost(int64, tag = "5")]
pub amount: i64,
/// Denotes if the output is controlled by the internal wallet
#[prost(bool, tag = "6")]
pub is_our_address: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Transaction {
/// The transaction hash
#[prost(string, tag = "1")]
pub tx_hash: ::prost::alloc::string::String,
/// The transaction amount, denominated in satoshis
#[prost(int64, tag = "2")]
pub amount: i64,
/// The number of confirmations
#[prost(int32, tag = "3")]
pub num_confirmations: i32,
/// The hash of the block this transaction was included in
#[prost(string, tag = "4")]
pub block_hash: ::prost::alloc::string::String,
/// The height of the block this transaction was included in
#[prost(int32, tag = "5")]
pub block_height: i32,
/// Timestamp of this transaction
#[prost(int64, tag = "6")]
pub time_stamp: i64,
/// Fees paid for this transaction
#[prost(int64, tag = "7")]
pub total_fees: i64,
/// Addresses that received funds for this transaction. Deprecated as it is
/// now incorporated in the output_details field.
#[deprecated]
#[prost(string, repeated, tag = "8")]
pub dest_addresses: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Outputs that received funds for this transaction
#[prost(message, repeated, tag = "11")]
pub output_details: ::prost::alloc::vec::Vec<OutputDetail>,
/// The raw transaction hex.
#[prost(string, tag = "9")]
pub raw_tx_hex: ::prost::alloc::string::String,
/// A label that was optionally set on transaction broadcast.
#[prost(string, tag = "10")]
pub label: ::prost::alloc::string::String,
/// PreviousOutpoints/Inputs of this transaction.
#[prost(message, repeated, tag = "12")]
pub previous_outpoints: ::prost::alloc::vec::Vec<PreviousOutPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetTransactionsRequest {
/// The height from which to list transactions, inclusive. If this value is
/// greater than end_height, transactions will be read in reverse.
#[prost(int32, tag = "1")]
pub start_height: i32,
/// 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.
#[prost(int32, tag = "2")]
pub end_height: i32,
/// An optional filter to only include transactions relevant to an account.
#[prost(string, tag = "3")]
pub account: ::prost::alloc::string::String,
/// The index of a transaction that will be used in a query to determine which
/// transaction should be returned in the response.
#[prost(uint32, tag = "4")]
pub index_offset: u32,
/// The maximal number of transactions returned in the response to this query.
/// This value should be set to 0 to return all transactions.
#[prost(uint32, tag = "5")]
pub max_transactions: u32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TransactionDetails {
/// The list of transactions relevant to the wallet.
#[prost(message, repeated, tag = "1")]
pub transactions: ::prost::alloc::vec::Vec<Transaction>,
/// The index of the last item in the set of returned transactions. This can be
/// used to seek further, pagination style.
#[prost(uint64, tag = "2")]
pub last_index: u64,
/// The index of the last item in the set of returned transactions. This can be
/// used to seek backwards, pagination style.
#[prost(uint64, tag = "3")]
pub first_index: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FeeLimit {
#[prost(oneof = "fee_limit::Limit", tags = "1, 3, 2")]
pub limit: ::core::option::Option<fee_limit::Limit>,
}
/// Nested message and enum types in `FeeLimit`.
pub mod fee_limit {
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum Limit {
/// The fee limit expressed as a fixed amount of satoshis.
///
/// The fields fixed and fixed_msat are mutually exclusive.
#[prost(int64, tag = "1")]
Fixed(i64),
/// The fee limit expressed as a fixed amount of millisatoshis.
///
/// The fields fixed and fixed_msat are mutually exclusive.
#[prost(int64, tag = "3")]
FixedMsat(i64),
/// The fee limit expressed as a percentage of the payment amount.
#[prost(int64, tag = "2")]
Percent(i64),
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendRequest {
/// The identity pubkey of the payment recipient. When using REST, this field
/// must be encoded as base64.
#[prost(bytes = "vec", tag = "1")]
pub dest: ::prost::alloc::vec::Vec<u8>,
/// The hex-encoded identity pubkey of the payment recipient. Deprecated now
/// that the REST gateway supports base64 encoding of bytes fields.
#[deprecated]
#[prost(string, tag = "2")]
pub dest_string: ::prost::alloc::string::String,
/// The amount to send expressed in satoshis.
///
/// The fields amt and amt_msat are mutually exclusive.
#[prost(int64, tag = "3")]
pub amt: i64,
/// The amount to send expressed in millisatoshis.
///
/// The fields amt and amt_msat are mutually exclusive.
#[prost(int64, tag = "12")]
pub amt_msat: i64,
/// The hash to use within the payment's HTLC. When using REST, this field
/// must be encoded as base64.
#[prost(bytes = "vec", tag = "4")]
pub payment_hash: ::prost::alloc::vec::Vec<u8>,
/// The hex-encoded hash to use within the payment's HTLC. Deprecated now
/// that the REST gateway supports base64 encoding of bytes fields.
#[deprecated]
#[prost(string, tag = "5")]
pub payment_hash_string: ::prost::alloc::string::String,
/// 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.
#[prost(string, tag = "6")]
pub payment_request: ::prost::alloc::string::String,
/// The CLTV delta from the current height that should be used to set the
/// timelock for the final hop.
#[prost(int32, tag = "7")]
pub final_cltv_delta: i32,
/// 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. If not specified, lnd will use a default value of 100%
/// fees for small amounts (\<=1k sat) or 5% fees for larger amounts.
#[prost(message, optional, tag = "8")]
pub fee_limit: ::core::option::Option<FeeLimit>,
/// The channel id of the channel that must be taken to the first hop. If zero,
/// any channel may be used.
#[prost(uint64, tag = "9")]
pub outgoing_chan_id: u64,
/// The pubkey of the last hop of the route. If empty, any hop may be used.
#[prost(bytes = "vec", tag = "13")]
pub last_hop_pubkey: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(uint32, tag = "10")]
pub cltv_limit: u32,
/// 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.
#[prost(map = "uint64, bytes", tag = "11")]
pub dest_custom_records: ::std::collections::HashMap<
u64,
::prost::alloc::vec::Vec<u8>,
>,
/// If set, circular payments to self are permitted.
#[prost(bool, tag = "14")]
pub allow_self_payment: bool,
/// 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.
#[prost(enumeration = "FeatureBit", repeated, tag = "15")]
pub dest_features: ::prost::alloc::vec::Vec<i32>,
/// The payment address of the generated invoice. This is also called
/// payment secret in specifications (e.g. BOLT 11).
#[prost(bytes = "vec", tag = "16")]
pub payment_addr: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendResponse {
#[prost(string, tag = "1")]
pub payment_error: ::prost::alloc::string::String,
#[prost(bytes = "vec", tag = "2")]
pub payment_preimage: ::prost::alloc::vec::Vec<u8>,
#[prost(message, optional, tag = "3")]
pub payment_route: ::core::option::Option<Route>,
#[prost(bytes = "vec", tag = "4")]
pub payment_hash: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendToRouteRequest {
/// The payment hash to use for the HTLC. When using REST, this field must be
/// encoded as base64.
#[prost(bytes = "vec", tag = "1")]
pub payment_hash: ::prost::alloc::vec::Vec<u8>,
/// An optional hex-encoded payment hash to be used for the HTLC. Deprecated now
/// that the REST gateway supports base64 encoding of bytes fields.
#[deprecated]
#[prost(string, tag = "2")]
pub payment_hash_string: ::prost::alloc::string::String,
/// Route that should be used to attempt to complete the payment.
#[prost(message, optional, tag = "4")]
pub route: ::core::option::Option<Route>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelAcceptRequest {
/// The pubkey of the node that wishes to open an inbound channel.
#[prost(bytes = "vec", tag = "1")]
pub node_pubkey: ::prost::alloc::vec::Vec<u8>,
/// The hash of the genesis block that the proposed channel resides in.
#[prost(bytes = "vec", tag = "2")]
pub chain_hash: ::prost::alloc::vec::Vec<u8>,
/// The pending channel id.
#[prost(bytes = "vec", tag = "3")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// The funding amount in satoshis that initiator wishes to use in the
/// channel.
#[prost(uint64, tag = "4")]
pub funding_amt: u64,
/// The push amount of the proposed channel in millisatoshis.
#[prost(uint64, tag = "5")]
pub push_amt: u64,
/// The dust limit of the initiator's commitment tx.
#[prost(uint64, tag = "6")]
pub dust_limit: u64,
/// The maximum amount of coins in millisatoshis that can be pending in this
/// channel.
#[prost(uint64, tag = "7")]
pub max_value_in_flight: u64,
/// The minimum amount of satoshis the initiator requires us to have at all
/// times.
#[prost(uint64, tag = "8")]
pub channel_reserve: u64,
/// The smallest HTLC in millisatoshis that the initiator will accept.
#[prost(uint64, tag = "9")]
pub min_htlc: u64,
/// The initial fee rate that the initiator suggests for both commitment
/// transactions.
#[prost(uint64, tag = "10")]
pub fee_per_kw: u64,
/// The number of blocks to use for the relative time lock in the pay-to-self
/// output of both commitment transactions.
#[prost(uint32, tag = "11")]
pub csv_delay: u32,
/// The total number of incoming HTLC's that the initiator will accept.
#[prost(uint32, tag = "12")]
pub max_accepted_htlcs: u32,
/// A bit-field which the initiator uses to specify proposed channel
/// behavior.
#[prost(uint32, tag = "13")]
pub channel_flags: u32,
/// The commitment type the initiator wishes to use for the proposed channel.
#[prost(enumeration = "CommitmentType", tag = "14")]
pub commitment_type: i32,
/// Whether the initiator wants to open a zero-conf channel via the channel
/// type.
#[prost(bool, tag = "15")]
pub wants_zero_conf: bool,
/// Whether the initiator wants to use the scid-alias channel type. This is
/// separate from the feature bit.
#[prost(bool, tag = "16")]
pub wants_scid_alias: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelAcceptResponse {
/// Whether or not the client accepts the channel.
#[prost(bool, tag = "1")]
pub accept: bool,
/// The pending channel id to which this response applies.
#[prost(bytes = "vec", tag = "2")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// An optional error to send the initiating party to indicate why the channel
/// was rejected. This field *should not* contain sensitive information, it will
/// be sent to the initiating party. This field should only be set if accept is
/// false, the channel will be rejected if an error is set with accept=true
/// because the meaning of this response is ambiguous. Limited to 500
/// characters.
#[prost(string, tag = "3")]
pub error: ::prost::alloc::string::String,
/// The upfront shutdown address to use if the initiating peer supports option
/// upfront shutdown script (see ListPeers for the features supported). Note
/// that the channel open will fail if this value is set for a peer that does
/// not support this feature bit.
#[prost(string, tag = "4")]
pub upfront_shutdown: ::prost::alloc::string::String,
/// The csv delay (in blocks) that we require for the remote party.
#[prost(uint32, tag = "5")]
pub csv_delay: u32,
/// The reserve amount in satoshis that we require the remote peer to adhere to.
/// We require that the remote peer always have some reserve amount allocated to
/// them so that there is always a disincentive to broadcast old state (if they
/// hold 0 sats on their side of the channel, there is nothing to lose).
#[prost(uint64, tag = "6")]
pub reserve_sat: u64,
/// The maximum amount of funds in millisatoshis that we allow the remote peer
/// to have in outstanding htlcs.
#[prost(uint64, tag = "7")]
pub in_flight_max_msat: u64,
/// The maximum number of htlcs that the remote peer can offer us.
#[prost(uint32, tag = "8")]
pub max_htlc_count: u32,
/// The minimum value in millisatoshis for incoming htlcs on the channel.
#[prost(uint64, tag = "9")]
pub min_htlc_in: u64,
/// The number of confirmations we require before we consider the channel open.
#[prost(uint32, tag = "10")]
pub min_accept_depth: u32,
/// Whether the responder wants this to be a zero-conf channel. This will fail
/// if either side does not have the scid-alias feature bit set. The minimum
/// depth field must be zero if this is true.
#[prost(bool, tag = "11")]
pub zero_conf: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelPoint {
/// The index of the output of the funding transaction
#[prost(uint32, tag = "3")]
pub output_index: u32,
#[prost(oneof = "channel_point::FundingTxid", tags = "1, 2")]
pub funding_txid: ::core::option::Option<channel_point::FundingTxid>,
}
/// Nested message and enum types in `ChannelPoint`.
pub mod channel_point {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum FundingTxid {
/// Txid of the funding transaction. When using REST, this field must be
/// encoded as base64.
#[prost(bytes, tag = "1")]
FundingTxidBytes(::prost::alloc::vec::Vec<u8>),
/// Hex-encoded string representing the byte-reversed hash of the funding
/// transaction.
#[prost(string, tag = "2")]
FundingTxidStr(::prost::alloc::string::String),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct OutPoint {
/// Raw bytes representing the transaction id.
#[prost(bytes = "vec", tag = "1")]
pub txid_bytes: ::prost::alloc::vec::Vec<u8>,
/// Reversed, hex-encoded string representing the transaction id.
#[prost(string, tag = "2")]
pub txid_str: ::prost::alloc::string::String,
/// The index of the output on the transaction.
#[prost(uint32, tag = "3")]
pub output_index: u32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PreviousOutPoint {
/// The outpoint in format txid:n.
#[prost(string, tag = "1")]
pub outpoint: ::prost::alloc::string::String,
/// Denotes if the outpoint is controlled by the internal wallet.
/// The flag will only detect p2wkh, np2wkh and p2tr inputs as its own.
#[prost(bool, tag = "2")]
pub is_our_output: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct LightningAddress {
/// The identity pubkey of the Lightning node.
#[prost(string, tag = "1")]
pub pubkey: ::prost::alloc::string::String,
/// The network location of the lightning node, e.g. `69.69.69.69:1337` or
/// `localhost:10011`.
#[prost(string, tag = "2")]
pub host: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EstimateFeeRequest {
/// The map from addresses to amounts for the transaction.
#[prost(map = "string, int64", tag = "1")]
pub addr_to_amount: ::std::collections::HashMap<::prost::alloc::string::String, i64>,
/// The target number of blocks that this transaction should be confirmed
/// by.
#[prost(int32, tag = "2")]
pub target_conf: i32,
/// The minimum number of confirmations each one of your outputs used for
/// the transaction must satisfy.
#[prost(int32, tag = "3")]
pub min_confs: i32,
/// Whether unconfirmed outputs should be used as inputs for the transaction.
#[prost(bool, tag = "4")]
pub spend_unconfirmed: bool,
/// The strategy to use for selecting coins during fees estimation.
#[prost(enumeration = "CoinSelectionStrategy", tag = "5")]
pub coin_selection_strategy: i32,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct EstimateFeeResponse {
/// The total fee in satoshis.
#[prost(int64, tag = "1")]
pub fee_sat: i64,
/// Deprecated, use sat_per_vbyte.
/// The fee rate in satoshi/vbyte.
#[deprecated]
#[prost(int64, tag = "2")]
pub feerate_sat_per_byte: i64,
/// The fee rate in satoshi/vbyte.
#[prost(uint64, tag = "3")]
pub sat_per_vbyte: u64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendManyRequest {
/// The map from addresses to amounts
#[prost(map = "string, int64", tag = "1")]
pub addr_to_amount: ::std::collections::HashMap<::prost::alloc::string::String, i64>,
/// The target number of blocks that this transaction should be confirmed
/// by.
#[prost(int32, tag = "3")]
pub target_conf: i32,
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// transaction.
#[prost(uint64, tag = "4")]
pub sat_per_vbyte: u64,
/// Deprecated, use sat_per_vbyte.
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// transaction.
#[deprecated]
#[prost(int64, tag = "5")]
pub sat_per_byte: i64,
/// An optional label for the transaction, limited to 500 characters.
#[prost(string, tag = "6")]
pub label: ::prost::alloc::string::String,
/// The minimum number of confirmations each one of your outputs used for
/// the transaction must satisfy.
#[prost(int32, tag = "7")]
pub min_confs: i32,
/// Whether unconfirmed outputs should be used as inputs for the transaction.
#[prost(bool, tag = "8")]
pub spend_unconfirmed: bool,
/// The strategy to use for selecting coins during sending many requests.
#[prost(enumeration = "CoinSelectionStrategy", tag = "9")]
pub coin_selection_strategy: i32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SendManyResponse {
/// The id of the transaction
#[prost(string, tag = "1")]
pub txid: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendCoinsRequest {
/// The address to send coins to
#[prost(string, tag = "1")]
pub addr: ::prost::alloc::string::String,
/// The amount in satoshis to send
#[prost(int64, tag = "2")]
pub amount: i64,
/// The target number of blocks that this transaction should be confirmed
/// by.
#[prost(int32, tag = "3")]
pub target_conf: i32,
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// transaction.
#[prost(uint64, tag = "4")]
pub sat_per_vbyte: u64,
/// Deprecated, use sat_per_vbyte.
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// transaction.
#[deprecated]
#[prost(int64, tag = "5")]
pub sat_per_byte: i64,
/// If set, the amount field should be unset. It indicates lnd will send all
/// wallet coins or all selected coins to the specified address.
#[prost(bool, tag = "6")]
pub send_all: bool,
/// An optional label for the transaction, limited to 500 characters.
#[prost(string, tag = "7")]
pub label: ::prost::alloc::string::String,
/// The minimum number of confirmations each one of your outputs used for
/// the transaction must satisfy.
#[prost(int32, tag = "8")]
pub min_confs: i32,
/// Whether unconfirmed outputs should be used as inputs for the transaction.
#[prost(bool, tag = "9")]
pub spend_unconfirmed: bool,
/// The strategy to use for selecting coins.
#[prost(enumeration = "CoinSelectionStrategy", tag = "10")]
pub coin_selection_strategy: i32,
/// A list of selected outpoints as inputs for the transaction.
#[prost(message, repeated, tag = "11")]
pub outpoints: ::prost::alloc::vec::Vec<OutPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SendCoinsResponse {
/// The transaction ID of the transaction
#[prost(string, tag = "1")]
pub txid: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListUnspentRequest {
/// The minimum number of confirmations to be included.
#[prost(int32, tag = "1")]
pub min_confs: i32,
/// The maximum number of confirmations to be included.
#[prost(int32, tag = "2")]
pub max_confs: i32,
/// An optional filter to only include outputs belonging to an account.
#[prost(string, tag = "3")]
pub account: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListUnspentResponse {
/// A list of utxos
#[prost(message, repeated, tag = "1")]
pub utxos: ::prost::alloc::vec::Vec<Utxo>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NewAddressRequest {
/// The type of address to generate.
#[prost(enumeration = "AddressType", tag = "1")]
pub r#type: i32,
/// The name of the account to generate a new address for. If empty, the
/// default wallet account is used.
#[prost(string, tag = "2")]
pub account: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NewAddressResponse {
/// The newly generated wallet address
#[prost(string, tag = "1")]
pub address: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SignMessageRequest {
/// The message to be signed. When using REST, this field must be encoded as
/// base64.
#[prost(bytes = "vec", tag = "1")]
pub msg: ::prost::alloc::vec::Vec<u8>,
/// Instead of the default double-SHA256 hashing of the message before signing,
/// only use one round of hashing instead.
#[prost(bool, tag = "2")]
pub single_hash: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SignMessageResponse {
/// The signature for the given message
#[prost(string, tag = "1")]
pub signature: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct VerifyMessageRequest {
/// The message over which the signature is to be verified. When using REST,
/// this field must be encoded as base64.
#[prost(bytes = "vec", tag = "1")]
pub msg: ::prost::alloc::vec::Vec<u8>,
/// The signature to be verified over the given message
#[prost(string, tag = "2")]
pub signature: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct VerifyMessageResponse {
/// Whether the signature was valid over the given message
#[prost(bool, tag = "1")]
pub valid: bool,
/// The pubkey recovered from the signature
#[prost(string, tag = "2")]
pub pubkey: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ConnectPeerRequest {
/// Lightning address of the peer to connect to.
#[prost(message, optional, tag = "1")]
pub addr: ::core::option::Option<LightningAddress>,
/// If set, the daemon will attempt to persistently connect to the target
/// peer. Otherwise, the call will be synchronous.
#[prost(bool, tag = "2")]
pub perm: bool,
/// The connection timeout value (in seconds) for this request. It won't affect
/// other requests.
#[prost(uint64, tag = "3")]
pub timeout: u64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ConnectPeerResponse {
/// The status of the connect operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DisconnectPeerRequest {
/// The pubkey of the node to disconnect from
#[prost(string, tag = "1")]
pub pub_key: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DisconnectPeerResponse {
/// The status of the disconnect operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Htlc {
#[prost(bool, tag = "1")]
pub incoming: bool,
#[prost(int64, tag = "2")]
pub amount: i64,
#[prost(bytes = "vec", tag = "3")]
pub hash_lock: ::prost::alloc::vec::Vec<u8>,
#[prost(uint32, tag = "4")]
pub expiration_height: u32,
/// Index identifying the htlc on the channel.
#[prost(uint64, tag = "5")]
pub htlc_index: u64,
/// If this HTLC is involved in a forwarding operation, this field indicates
/// the forwarding channel. For an outgoing htlc, it is the incoming channel.
/// For an incoming htlc, it is the outgoing channel. When the htlc
/// originates from this node or this node is the final destination,
/// forwarding_channel will be zero. The forwarding channel will also be zero
/// for htlcs that need to be forwarded but don't have a forwarding decision
/// persisted yet.
#[prost(uint64, tag = "6")]
pub forwarding_channel: u64,
/// Index identifying the htlc on the forwarding channel.
#[prost(uint64, tag = "7")]
pub forwarding_htlc_index: u64,
/// Whether the HTLC is locked in. An HTLC is considered locked in when the
/// remote party has sent us the `revoke_and_ack` to irrevocably commit this
/// HTLC.
#[prost(bool, tag = "8")]
pub locked_in: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(uint32, tag = "1")]
pub csv_delay: u32,
/// The minimum satoshis this node is required to reserve in its balance.
#[prost(uint64, tag = "2")]
pub chan_reserve_sat: u64,
/// The dust limit (in satoshis) of the initiator's commitment tx.
#[prost(uint64, tag = "3")]
pub dust_limit_sat: u64,
/// The maximum amount of coins in millisatoshis that can be pending in this
/// channel.
#[prost(uint64, tag = "4")]
pub max_pending_amt_msat: u64,
/// The smallest HTLC in millisatoshis that the initiator will accept.
#[prost(uint64, tag = "5")]
pub min_htlc_msat: u64,
/// The total number of incoming HTLC's that the initiator will accept.
#[prost(uint32, tag = "6")]
pub max_accepted_htlcs: u32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Channel {
/// Whether this channel is active or not
#[prost(bool, tag = "1")]
pub active: bool,
/// The identity pubkey of the remote node
#[prost(string, tag = "2")]
pub remote_pubkey: ::prost::alloc::string::String,
/// 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.
#[prost(string, tag = "3")]
pub channel_point: ::prost::alloc::string::String,
/// 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.
#[prost(uint64, tag = "4")]
pub chan_id: u64,
/// The total amount of funds held in this channel
#[prost(int64, tag = "5")]
pub capacity: i64,
/// This node's current balance in this channel
#[prost(int64, tag = "6")]
pub local_balance: i64,
/// The counterparty's current balance in this channel
#[prost(int64, tag = "7")]
pub remote_balance: i64,
/// 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.
#[prost(int64, tag = "8")]
pub commit_fee: i64,
/// The weight of the commitment transaction
#[prost(int64, tag = "9")]
pub commit_weight: i64,
/// 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.
#[prost(int64, tag = "10")]
pub fee_per_kw: i64,
/// The unsettled balance in this channel
#[prost(int64, tag = "11")]
pub unsettled_balance: i64,
/// The total number of satoshis we've sent within this channel.
#[prost(int64, tag = "12")]
pub total_satoshis_sent: i64,
/// The total number of satoshis we've received within this channel.
#[prost(int64, tag = "13")]
pub total_satoshis_received: i64,
/// The total number of updates conducted within this channel.
#[prost(uint64, tag = "14")]
pub num_updates: u64,
/// The list of active, uncleared HTLCs currently pending within the channel.
#[prost(message, repeated, tag = "15")]
pub pending_htlcs: ::prost::alloc::vec::Vec<Htlc>,
/// 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.
#[deprecated]
#[prost(uint32, tag = "16")]
pub csv_delay: u32,
/// Whether this channel is advertised to the network or not.
#[prost(bool, tag = "17")]
pub private: bool,
/// True if we were the ones that created the channel.
#[prost(bool, tag = "18")]
pub initiator: bool,
/// A set of flags showing the current state of the channel.
#[prost(string, tag = "19")]
pub chan_status_flags: ::prost::alloc::string::String,
/// Deprecated. The minimum satoshis this node is required to reserve in its
/// balance.
#[deprecated]
#[prost(int64, tag = "20")]
pub local_chan_reserve_sat: i64,
/// Deprecated. The minimum satoshis the other node is required to reserve in
/// its balance.
#[deprecated]
#[prost(int64, tag = "21")]
pub remote_chan_reserve_sat: i64,
/// Deprecated. Use commitment_type.
#[deprecated]
#[prost(bool, tag = "22")]
pub static_remote_key: bool,
/// The commitment type used by this channel.
#[prost(enumeration = "CommitmentType", tag = "26")]
pub commitment_type: i32,
/// 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\].
#[prost(int64, tag = "23")]
pub lifetime: i64,
/// 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\].
#[prost(int64, tag = "24")]
pub uptime: i64,
/// 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.
#[prost(string, tag = "25")]
pub close_address: ::prost::alloc::string::String,
/// 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.
#[prost(uint64, tag = "27")]
pub push_amount_sat: u64,
/// 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.
#[prost(uint32, tag = "28")]
pub thaw_height: u32,
/// List constraints for the local node.
#[prost(message, optional, tag = "29")]
pub local_constraints: ::core::option::Option<ChannelConstraints>,
/// List constraints for the remote node.
#[prost(message, optional, tag = "30")]
pub remote_constraints: ::core::option::Option<ChannelConstraints>,
/// This lists out the set of alias short channel ids that exist for a channel.
/// This may be empty.
#[prost(uint64, repeated, tag = "31")]
pub alias_scids: ::prost::alloc::vec::Vec<u64>,
/// Whether or not this is a zero-conf channel.
#[prost(bool, tag = "32")]
pub zero_conf: bool,
/// This is the confirmed / on-chain zero-conf SCID.
#[prost(uint64, tag = "33")]
pub zero_conf_confirmed_scid: u64,
/// The configured alias name of our peer.
#[prost(string, tag = "34")]
pub peer_alias: ::prost::alloc::string::String,
/// This is the peer SCID alias.
#[prost(uint64, tag = "35")]
pub peer_scid_alias: u64,
/// An optional note-to-self to go along with the channel containing some
/// useful information. This is only ever stored locally and in no way impacts
/// the channel's operation.
#[prost(string, tag = "36")]
pub memo: ::prost::alloc::string::String,
/// Custom channel data that might be populated in custom channels.
#[prost(bytes = "vec", tag = "37")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListChannelsRequest {
#[prost(bool, tag = "1")]
pub active_only: bool,
#[prost(bool, tag = "2")]
pub inactive_only: bool,
#[prost(bool, tag = "3")]
pub public_only: bool,
#[prost(bool, tag = "4")]
pub private_only: bool,
/// Filters the response for channels with a target peer's pubkey. If peer is
/// empty, all channels will be returned.
#[prost(bytes = "vec", tag = "5")]
pub peer: ::prost::alloc::vec::Vec<u8>,
/// Informs the server if the peer alias lookup per channel should be
/// enabled. It is turned off by default in order to avoid degradation of
/// performance for existing clients.
#[prost(bool, tag = "6")]
pub peer_alias_lookup: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListChannelsResponse {
/// The list of active channels
#[prost(message, repeated, tag = "11")]
pub channels: ::prost::alloc::vec::Vec<Channel>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AliasMap {
/// For non-zero-conf channels, this is the confirmed SCID. Otherwise, this is
/// the first assigned "base" alias.
#[prost(uint64, tag = "1")]
pub base_scid: u64,
/// The set of all aliases stored for the base SCID.
#[prost(uint64, repeated, tag = "2")]
pub aliases: ::prost::alloc::vec::Vec<u64>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListAliasesRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListAliasesResponse {
#[prost(message, repeated, tag = "1")]
pub alias_maps: ::prost::alloc::vec::Vec<AliasMap>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelCloseSummary {
/// The outpoint (txid:index) of the funding transaction.
#[prost(string, tag = "1")]
pub channel_point: ::prost::alloc::string::String,
/// The unique channel ID for the channel.
#[prost(uint64, tag = "2")]
pub chan_id: u64,
/// The hash of the genesis block that this channel resides within.
#[prost(string, tag = "3")]
pub chain_hash: ::prost::alloc::string::String,
/// The txid of the transaction which ultimately closed this channel.
#[prost(string, tag = "4")]
pub closing_tx_hash: ::prost::alloc::string::String,
/// Public key of the remote peer that we formerly had a channel with.
#[prost(string, tag = "5")]
pub remote_pubkey: ::prost::alloc::string::String,
/// Total capacity of the channel.
#[prost(int64, tag = "6")]
pub capacity: i64,
/// Height at which the funding transaction was spent.
#[prost(uint32, tag = "7")]
pub close_height: u32,
/// Settled balance at the time of channel closure
#[prost(int64, tag = "8")]
pub settled_balance: i64,
/// The sum of all the time-locked outputs at the time of channel closure
#[prost(int64, tag = "9")]
pub time_locked_balance: i64,
/// Details on how the channel was closed.
#[prost(enumeration = "channel_close_summary::ClosureType", tag = "10")]
pub close_type: i32,
/// 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.
#[prost(enumeration = "Initiator", tag = "11")]
pub open_initiator: i32,
/// 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.
#[prost(enumeration = "Initiator", tag = "12")]
pub close_initiator: i32,
#[prost(message, repeated, tag = "13")]
pub resolutions: ::prost::alloc::vec::Vec<Resolution>,
/// This lists out the set of alias short channel ids that existed for the
/// closed channel. This may be empty.
#[prost(uint64, repeated, tag = "14")]
pub alias_scids: ::prost::alloc::vec::Vec<u64>,
/// The confirmed SCID for a zero-conf channel.
#[prost(uint64, tag = "15")]
pub zero_conf_confirmed_scid: u64,
/// The TLV encoded custom channel data records for this output, which might
/// be set for custom channels.
#[prost(bytes = "vec", tag = "16")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
/// Nested message and enum types in `ChannelCloseSummary`.
pub mod channel_close_summary {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ClosureType {
CooperativeClose = 0,
LocalForceClose = 1,
RemoteForceClose = 2,
BreachClose = 3,
FundingCanceled = 4,
Abandoned = 5,
}
impl ClosureType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::CooperativeClose => "COOPERATIVE_CLOSE",
Self::LocalForceClose => "LOCAL_FORCE_CLOSE",
Self::RemoteForceClose => "REMOTE_FORCE_CLOSE",
Self::BreachClose => "BREACH_CLOSE",
Self::FundingCanceled => "FUNDING_CANCELED",
Self::Abandoned => "ABANDONED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"COOPERATIVE_CLOSE" => Some(Self::CooperativeClose),
"LOCAL_FORCE_CLOSE" => Some(Self::LocalForceClose),
"REMOTE_FORCE_CLOSE" => Some(Self::RemoteForceClose),
"BREACH_CLOSE" => Some(Self::BreachClose),
"FUNDING_CANCELED" => Some(Self::FundingCanceled),
"ABANDONED" => Some(Self::Abandoned),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Resolution {
/// The type of output we are resolving.
#[prost(enumeration = "ResolutionType", tag = "1")]
pub resolution_type: i32,
/// The outcome of our on chain action that resolved the outpoint.
#[prost(enumeration = "ResolutionOutcome", tag = "2")]
pub outcome: i32,
/// The outpoint that was spent by the resolution.
#[prost(message, optional, tag = "3")]
pub outpoint: ::core::option::Option<OutPoint>,
/// The amount that was claimed by the resolution.
#[prost(uint64, tag = "4")]
pub amount_sat: u64,
/// The hex-encoded transaction ID of the sweep transaction that spent the
/// output.
#[prost(string, tag = "5")]
pub sweep_txid: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ClosedChannelsRequest {
#[prost(bool, tag = "1")]
pub cooperative: bool,
#[prost(bool, tag = "2")]
pub local_force: bool,
#[prost(bool, tag = "3")]
pub remote_force: bool,
#[prost(bool, tag = "4")]
pub breach: bool,
#[prost(bool, tag = "5")]
pub funding_canceled: bool,
#[prost(bool, tag = "6")]
pub abandoned: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ClosedChannelsResponse {
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<ChannelCloseSummary>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Peer {
/// The identity pubkey of the peer
#[prost(string, tag = "1")]
pub pub_key: ::prost::alloc::string::String,
/// Network address of the peer; eg `127.0.0.1:10011`
#[prost(string, tag = "3")]
pub address: ::prost::alloc::string::String,
/// Bytes of data transmitted to this peer
#[prost(uint64, tag = "4")]
pub bytes_sent: u64,
/// Bytes of data transmitted from this peer
#[prost(uint64, tag = "5")]
pub bytes_recv: u64,
/// Satoshis sent to this peer
#[prost(int64, tag = "6")]
pub sat_sent: i64,
/// Satoshis received from this peer
#[prost(int64, tag = "7")]
pub sat_recv: i64,
/// A channel is inbound if the counterparty initiated the channel
#[prost(bool, tag = "8")]
pub inbound: bool,
/// Ping time to this peer
#[prost(int64, tag = "9")]
pub ping_time: i64,
/// The type of sync we are currently performing with this peer.
#[prost(enumeration = "peer::SyncType", tag = "10")]
pub sync_type: i32,
/// Features advertised by the remote peer in their init message.
#[prost(map = "uint32, message", tag = "11")]
pub features: ::std::collections::HashMap<u32, Feature>,
/// 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.
#[prost(message, repeated, tag = "12")]
pub errors: ::prost::alloc::vec::Vec<TimestampedError>,
/// This field is populated when the peer has at least one channel with us.
/// The number of times we have recorded this peer going offline or coming
/// online, recorded across restarts. Note that this value is decreased over
/// time if the peer has not recently flapped, so that we can forgive peers
/// with historically high flap counts.
#[prost(int32, tag = "13")]
pub flap_count: i32,
/// This field is populated when the peer has at least one channel with us.
/// The timestamp of the last flap we observed for this peer. If this value is
/// zero, we have not observed any flaps for this peer.
#[prost(int64, tag = "14")]
pub last_flap_ns: i64,
/// The last ping payload the peer has sent to us.
#[prost(bytes = "vec", tag = "15")]
pub last_ping_payload: ::prost::alloc::vec::Vec<u8>,
}
/// Nested message and enum types in `Peer`.
pub mod peer {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum SyncType {
/// Denotes that we cannot determine the peer's current sync type.
UnknownSync = 0,
/// Denotes that we are actively receiving new graph updates from the peer.
ActiveSync = 1,
/// Denotes that we are not receiving new graph updates from the peer.
PassiveSync = 2,
/// Denotes that this peer is pinned into an active sync.
PinnedSync = 3,
}
impl SyncType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::UnknownSync => "UNKNOWN_SYNC",
Self::ActiveSync => "ACTIVE_SYNC",
Self::PassiveSync => "PASSIVE_SYNC",
Self::PinnedSync => "PINNED_SYNC",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN_SYNC" => Some(Self::UnknownSync),
"ACTIVE_SYNC" => Some(Self::ActiveSync),
"PASSIVE_SYNC" => Some(Self::PassiveSync),
"PINNED_SYNC" => Some(Self::PinnedSync),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct TimestampedError {
/// The unix timestamp in seconds when the error occurred.
#[prost(uint64, tag = "1")]
pub timestamp: u64,
/// The string representation of the error sent by our peer.
#[prost(string, tag = "2")]
pub error: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(bool, tag = "1")]
pub latest_error: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPeersResponse {
/// The list of currently connected peers
#[prost(message, repeated, tag = "1")]
pub peers: ::prost::alloc::vec::Vec<Peer>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PeerEventSubscription {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PeerEvent {
/// The identity pubkey of the peer.
#[prost(string, tag = "1")]
pub pub_key: ::prost::alloc::string::String,
#[prost(enumeration = "peer_event::EventType", tag = "2")]
pub r#type: i32,
}
/// Nested message and enum types in `PeerEvent`.
pub mod peer_event {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum EventType {
PeerOnline = 0,
PeerOffline = 1,
}
impl EventType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::PeerOnline => "PEER_ONLINE",
Self::PeerOffline => "PEER_OFFLINE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"PEER_ONLINE" => Some(Self::PeerOnline),
"PEER_OFFLINE" => Some(Self::PeerOffline),
_ => None,
}
}
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetInfoRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetInfoResponse {
/// The version of the LND software that the node is running.
#[prost(string, tag = "14")]
pub version: ::prost::alloc::string::String,
/// The SHA1 commit hash that the daemon is compiled with.
#[prost(string, tag = "20")]
pub commit_hash: ::prost::alloc::string::String,
/// The identity pubkey of the current node.
#[prost(string, tag = "1")]
pub identity_pubkey: ::prost::alloc::string::String,
/// If applicable, the alias of the current node, e.g. "bob"
#[prost(string, tag = "2")]
pub alias: ::prost::alloc::string::String,
/// The color of the current node in hex code format
#[prost(string, tag = "17")]
pub color: ::prost::alloc::string::String,
/// Number of pending channels
#[prost(uint32, tag = "3")]
pub num_pending_channels: u32,
/// Number of active channels
#[prost(uint32, tag = "4")]
pub num_active_channels: u32,
/// Number of inactive channels
#[prost(uint32, tag = "15")]
pub num_inactive_channels: u32,
/// Number of peers
#[prost(uint32, tag = "5")]
pub num_peers: u32,
/// The node's current view of the height of the best block
#[prost(uint32, tag = "6")]
pub block_height: u32,
/// The node's current view of the hash of the best block
#[prost(string, tag = "8")]
pub block_hash: ::prost::alloc::string::String,
/// Timestamp of the block best known to the wallet
#[prost(int64, tag = "13")]
pub best_header_timestamp: i64,
/// Whether the wallet's view is synced to the main chain
#[prost(bool, tag = "9")]
pub synced_to_chain: bool,
/// Whether we consider ourselves synced with the public channel graph.
#[prost(bool, tag = "18")]
pub synced_to_graph: bool,
/// Whether the current node is connected to testnet or testnet4. This field is
/// deprecated and the network field should be used instead.
#[deprecated]
#[prost(bool, tag = "10")]
pub testnet: bool,
/// A list of active chains the node is connected to. This will only
/// ever contain a single entry since LND will only ever have a single
/// chain backend during its lifetime.
#[prost(message, repeated, tag = "16")]
pub chains: ::prost::alloc::vec::Vec<Chain>,
/// The URIs of the current node.
#[prost(string, repeated, tag = "12")]
pub uris: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Features that our node has advertised in our init message, node
/// announcements and invoices.
#[prost(map = "uint32, message", tag = "19")]
pub features: ::std::collections::HashMap<u32, Feature>,
/// Indicates whether the HTLC interceptor API is in always-on mode.
#[prost(bool, tag = "21")]
pub require_htlc_interceptor: bool,
/// Indicates whether final htlc resolutions are stored on disk.
#[prost(bool, tag = "22")]
pub store_final_htlc_resolutions: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetDebugInfoRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDebugInfoResponse {
#[prost(map = "string, string", tag = "1")]
pub config: ::std::collections::HashMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
#[prost(string, repeated, tag = "2")]
pub log: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetRecoveryInfoRequest {}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct GetRecoveryInfoResponse {
/// Whether the wallet is in recovery mode
#[prost(bool, tag = "1")]
pub recovery_mode: bool,
/// Whether the wallet recovery progress is finished
#[prost(bool, tag = "2")]
pub recovery_finished: bool,
/// The recovery progress, ranging from 0 to 1.
#[prost(double, tag = "3")]
pub progress: f64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Chain {
/// Deprecated. The chain is now always assumed to be bitcoin.
/// The blockchain the node is on (must be bitcoin)
#[deprecated]
#[prost(string, tag = "1")]
pub chain: ::prost::alloc::string::String,
/// The network the node is on (eg regtest, testnet, mainnet)
#[prost(string, tag = "2")]
pub network: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelOpenUpdate {
#[prost(message, optional, tag = "1")]
pub channel_point: ::core::option::Option<ChannelPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CloseOutput {
/// The amount in satoshi of this close output. This amount is the final
/// commitment balance of the channel and the actual amount paid out on chain
/// might be smaller due to subtracted fees.
#[prost(int64, tag = "1")]
pub amount_sat: i64,
/// The pkScript of the close output.
#[prost(bytes = "vec", tag = "2")]
pub pk_script: ::prost::alloc::vec::Vec<u8>,
/// Whether this output is for the local or remote node.
#[prost(bool, tag = "3")]
pub is_local: bool,
/// The TLV encoded custom channel data records for this output, which might
/// be set for custom channels.
#[prost(bytes = "vec", tag = "4")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelCloseUpdate {
#[prost(bytes = "vec", tag = "1")]
pub closing_txid: ::prost::alloc::vec::Vec<u8>,
#[prost(bool, tag = "2")]
pub success: bool,
/// The local channel close output. If the local channel balance was dust to
/// begin with, this output will not be set.
#[prost(message, optional, tag = "3")]
pub local_close_output: ::core::option::Option<CloseOutput>,
/// The remote channel close output. If the remote channel balance was dust
/// to begin with, this output will not be set.
#[prost(message, optional, tag = "4")]
pub remote_close_output: ::core::option::Option<CloseOutput>,
/// Any additional outputs that might be added for custom channel types.
#[prost(message, repeated, tag = "5")]
pub additional_outputs: ::prost::alloc::vec::Vec<CloseOutput>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(message, optional, tag = "1")]
pub channel_point: ::core::option::Option<ChannelPoint>,
/// If true, then the channel will be closed forcibly. This means the
/// current commitment transaction will be signed and broadcast.
#[prost(bool, tag = "2")]
pub force: bool,
/// The target number of blocks that the closure transaction should be
/// confirmed by.
#[prost(int32, tag = "3")]
pub target_conf: i32,
/// Deprecated, use sat_per_vbyte.
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// closure transaction.
#[deprecated]
#[prost(int64, tag = "4")]
pub sat_per_byte: i64,
/// 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.
#[prost(string, tag = "5")]
pub delivery_address: ::prost::alloc::string::String,
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// closure transaction.
#[prost(uint64, tag = "6")]
pub sat_per_vbyte: u64,
/// The maximum fee rate the closer is willing to pay.
///
/// NOTE: This field is only respected if we're the initiator of the channel.
#[prost(uint64, tag = "7")]
pub max_fee_per_vbyte: u64,
/// If true, then the rpc call will not block while it awaits a closing txid
/// to be broadcasted to the mempool. To obtain the closing tx one has to
/// listen to the stream for the particular updates. Moreover if a coop close
/// is specified and this flag is set to true the coop closing flow will be
/// initiated even if HTLCs are active on the channel. The channel will wait
/// until all HTLCs are resolved and then start the coop closing process. The
/// channel will be disabled in the meantime and will disallow any new HTLCs.
#[prost(bool, tag = "8")]
pub no_wait: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CloseStatusUpdate {
#[prost(oneof = "close_status_update::Update", tags = "1, 3, 4")]
pub update: ::core::option::Option<close_status_update::Update>,
}
/// Nested message and enum types in `CloseStatusUpdate`.
pub mod close_status_update {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Update {
#[prost(message, tag = "1")]
ClosePending(super::PendingUpdate),
#[prost(message, tag = "3")]
ChanClose(super::ChannelCloseUpdate),
#[prost(message, tag = "4")]
CloseInstant(super::InstantUpdate),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingUpdate {
#[prost(bytes = "vec", tag = "1")]
pub txid: ::prost::alloc::vec::Vec<u8>,
#[prost(uint32, tag = "2")]
pub output_index: u32,
#[prost(int64, tag = "3")]
pub fee_per_vbyte: i64,
#[prost(bool, tag = "4")]
pub local_close_tx: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct InstantUpdate {
/// The number of pending HTLCs that are currently active on the channel.
/// These HTLCs need to be resolved before the channel can be closed
/// cooperatively.
#[prost(int32, tag = "1")]
pub num_pending_htlcs: i32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ReadyForPsbtFunding {
/// The P2WSH address of the channel funding multisig address that the below
/// specified amount in satoshis needs to be sent to.
#[prost(string, tag = "1")]
pub funding_address: ::prost::alloc::string::String,
/// The exact amount in satoshis that needs to be sent to the above address to
/// fund the pending channel.
#[prost(int64, tag = "2")]
pub funding_amount: i64,
/// 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.
#[prost(bytes = "vec", tag = "3")]
pub psbt: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchOpenChannelRequest {
/// The list of channels to open.
#[prost(message, repeated, tag = "1")]
pub channels: ::prost::alloc::vec::Vec<BatchOpenChannel>,
/// The target number of blocks that the funding transaction should be
/// confirmed by.
#[prost(int32, tag = "2")]
pub target_conf: i32,
/// A manual fee rate set in sat/vByte that should be used when crafting the
/// funding transaction.
#[prost(int64, tag = "3")]
pub sat_per_vbyte: i64,
/// The minimum number of confirmations each one of your outputs used for
/// the funding transaction must satisfy.
#[prost(int32, tag = "4")]
pub min_confs: i32,
/// Whether unconfirmed outputs should be used as inputs for the funding
/// transaction.
#[prost(bool, tag = "5")]
pub spend_unconfirmed: bool,
/// An optional label for the batch transaction, limited to 500 characters.
#[prost(string, tag = "6")]
pub label: ::prost::alloc::string::String,
/// The strategy to use for selecting coins during batch opening channels.
#[prost(enumeration = "CoinSelectionStrategy", tag = "7")]
pub coin_selection_strategy: i32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct BatchOpenChannel {
/// The pubkey of the node to open a channel with. When using REST, this
/// field must be encoded as base64.
#[prost(bytes = "vec", tag = "1")]
pub node_pubkey: ::prost::alloc::vec::Vec<u8>,
/// The number of satoshis the wallet should commit to the channel.
#[prost(int64, tag = "2")]
pub local_funding_amount: i64,
/// The number of satoshis to push to the remote side as part of the initial
/// commitment state.
#[prost(int64, tag = "3")]
pub push_sat: i64,
/// Whether this channel should be private, not announced to the greater
/// network.
#[prost(bool, tag = "4")]
pub private: bool,
/// The minimum value in millisatoshi we will require for incoming HTLCs on
/// the channel.
#[prost(int64, tag = "5")]
pub min_htlc_msat: i64,
/// The delay we require on the remote's commitment transaction. If this is
/// not set, it will be scaled automatically with the channel size.
#[prost(uint32, tag = "6")]
pub remote_csv_delay: u32,
/// 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.
#[prost(string, tag = "7")]
pub close_address: ::prost::alloc::string::String,
/// An optional, unique identifier of 32 random bytes that will be used as the
/// pending channel ID to identify the channel while it is in the pre-pending
/// state.
#[prost(bytes = "vec", tag = "8")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// The explicit commitment type to use. Note this field will only be used if
/// the remote peer supports explicit channel negotiation.
#[prost(enumeration = "CommitmentType", tag = "9")]
pub commitment_type: i32,
/// The maximum amount of coins in millisatoshi that can be pending within
/// the channel. It only applies to the remote party.
#[prost(uint64, tag = "10")]
pub remote_max_value_in_flight_msat: u64,
/// The maximum number of concurrent HTLCs we will allow the remote party to add
/// to the commitment transaction.
#[prost(uint32, tag = "11")]
pub remote_max_htlcs: u32,
/// Max local csv is the maximum csv delay we will allow for our own commitment
/// transaction.
#[prost(uint32, tag = "12")]
pub max_local_csv: u32,
/// If this is true, then a zero-conf channel open will be attempted.
#[prost(bool, tag = "13")]
pub zero_conf: bool,
/// If this is true, then an option-scid-alias channel-type open will be
/// attempted.
#[prost(bool, tag = "14")]
pub scid_alias: bool,
/// The base fee charged regardless of the number of milli-satoshis sent.
#[prost(uint64, tag = "15")]
pub base_fee: u64,
/// The fee rate in ppm (parts per million) that will be charged in
/// proportion of the value of each forwarded HTLC.
#[prost(uint64, tag = "16")]
pub fee_rate: u64,
/// If use_base_fee is true the open channel announcement will update the
/// channel base fee with the value specified in base_fee. In the case of
/// a base_fee of 0 use_base_fee is needed downstream to distinguish whether
/// to use the default base fee value specified in the config or 0.
#[prost(bool, tag = "17")]
pub use_base_fee: bool,
/// If use_fee_rate is true the open channel announcement will update the
/// channel fee rate with the value specified in fee_rate. In the case of
/// a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether
/// to use the default fee rate value specified in the config or 0.
#[prost(bool, tag = "18")]
pub use_fee_rate: bool,
/// The number of satoshis we require the remote peer to reserve. This value,
/// if specified, must be above the dust limit and below 20% of the channel
/// capacity.
#[prost(uint64, tag = "19")]
pub remote_chan_reserve_sat: u64,
/// An optional note-to-self to go along with the channel containing some
/// useful information. This is only ever stored locally and in no way impacts
/// the channel's operation.
#[prost(string, tag = "20")]
pub memo: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchOpenChannelResponse {
#[prost(message, repeated, tag = "1")]
pub pending_channels: ::prost::alloc::vec::Vec<PendingUpdate>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpenChannelRequest {
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// funding transaction.
#[prost(uint64, tag = "1")]
pub sat_per_vbyte: u64,
/// The pubkey of the node to open a channel with. When using REST, this field
/// must be encoded as base64.
#[prost(bytes = "vec", tag = "2")]
pub node_pubkey: ::prost::alloc::vec::Vec<u8>,
/// The hex encoded pubkey of the node to open a channel with. Deprecated now
/// that the REST gateway supports base64 encoding of bytes fields.
#[deprecated]
#[prost(string, tag = "3")]
pub node_pubkey_string: ::prost::alloc::string::String,
/// The number of satoshis the wallet should commit to the channel
#[prost(int64, tag = "4")]
pub local_funding_amount: i64,
/// The number of satoshis to push to the remote side as part of the initial
/// commitment state
#[prost(int64, tag = "5")]
pub push_sat: i64,
/// The target number of blocks that the funding transaction should be
/// confirmed by.
#[prost(int32, tag = "6")]
pub target_conf: i32,
/// Deprecated, use sat_per_vbyte.
/// A manual fee rate set in sat/vbyte that should be used when crafting the
/// funding transaction.
#[deprecated]
#[prost(int64, tag = "7")]
pub sat_per_byte: i64,
/// Whether this channel should be private, not announced to the greater
/// network.
#[prost(bool, tag = "8")]
pub private: bool,
/// The minimum value in millisatoshi we will require for incoming HTLCs on
/// the channel.
#[prost(int64, tag = "9")]
pub min_htlc_msat: i64,
/// The delay we require on the remote's commitment transaction. If this is
/// not set, it will be scaled automatically with the channel size.
#[prost(uint32, tag = "10")]
pub remote_csv_delay: u32,
/// The minimum number of confirmations each one of your outputs used for
/// the funding transaction must satisfy.
#[prost(int32, tag = "11")]
pub min_confs: i32,
/// Whether unconfirmed outputs should be used as inputs for the funding
/// transaction.
#[prost(bool, tag = "12")]
pub spend_unconfirmed: bool,
/// 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.
#[prost(string, tag = "13")]
pub close_address: ::prost::alloc::string::String,
/// 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).
#[prost(message, optional, tag = "14")]
pub funding_shim: ::core::option::Option<FundingShim>,
/// The maximum amount of coins in millisatoshi that can be pending within
/// the channel. It only applies to the remote party.
#[prost(uint64, tag = "15")]
pub remote_max_value_in_flight_msat: u64,
/// The maximum number of concurrent HTLCs we will allow the remote party to add
/// to the commitment transaction.
#[prost(uint32, tag = "16")]
pub remote_max_htlcs: u32,
/// Max local csv is the maximum csv delay we will allow for our own commitment
/// transaction.
#[prost(uint32, tag = "17")]
pub max_local_csv: u32,
/// The explicit commitment type to use. Note this field will only be used if
/// the remote peer supports explicit channel negotiation.
#[prost(enumeration = "CommitmentType", tag = "18")]
pub commitment_type: i32,
/// If this is true, then a zero-conf channel open will be attempted.
#[prost(bool, tag = "19")]
pub zero_conf: bool,
/// If this is true, then an option-scid-alias channel-type open will be
/// attempted.
#[prost(bool, tag = "20")]
pub scid_alias: bool,
/// The base fee charged regardless of the number of milli-satoshis sent.
#[prost(uint64, tag = "21")]
pub base_fee: u64,
/// The fee rate in ppm (parts per million) that will be charged in
/// proportion of the value of each forwarded HTLC.
#[prost(uint64, tag = "22")]
pub fee_rate: u64,
/// If use_base_fee is true the open channel announcement will update the
/// channel base fee with the value specified in base_fee. In the case of
/// a base_fee of 0 use_base_fee is needed downstream to distinguish whether
/// to use the default base fee value specified in the config or 0.
#[prost(bool, tag = "23")]
pub use_base_fee: bool,
/// If use_fee_rate is true the open channel announcement will update the
/// channel fee rate with the value specified in fee_rate. In the case of
/// a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether
/// to use the default fee rate value specified in the config or 0.
#[prost(bool, tag = "24")]
pub use_fee_rate: bool,
/// The number of satoshis we require the remote peer to reserve. This value,
/// if specified, must be above the dust limit and below 20% of the channel
/// capacity.
#[prost(uint64, tag = "25")]
pub remote_chan_reserve_sat: u64,
/// If set, then lnd will attempt to commit all the coins under control of the
/// internal wallet to open the channel, and the LocalFundingAmount field must
/// be zero and is ignored.
#[prost(bool, tag = "26")]
pub fund_max: bool,
/// An optional note-to-self to go along with the channel containing some
/// useful information. This is only ever stored locally and in no way impacts
/// the channel's operation.
#[prost(string, tag = "27")]
pub memo: ::prost::alloc::string::String,
/// A list of selected outpoints that are allocated for channel funding.
#[prost(message, repeated, tag = "28")]
pub outpoints: ::prost::alloc::vec::Vec<OutPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct OpenStatusUpdate {
/// The pending channel ID of the created channel. This value may be used to
/// further the funding flow manually via the FundingStateStep method.
#[prost(bytes = "vec", tag = "4")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
#[prost(oneof = "open_status_update::Update", tags = "1, 3, 5")]
pub update: ::core::option::Option<open_status_update::Update>,
}
/// Nested message and enum types in `OpenStatusUpdate`.
pub mod open_status_update {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum Update {
/// Signals that the channel is now fully negotiated and the funding
/// transaction published.
#[prost(message, tag = "1")]
ChanPending(super::PendingUpdate),
/// Signals that the channel's funding transaction has now reached the
/// required number of confirmations on chain and can be used.
#[prost(message, tag = "3")]
ChanOpen(super::ChannelOpenUpdate),
/// Signals that the funding process has been suspended and the construction
/// of a PSBT that funds the channel PK script is now required.
#[prost(message, tag = "5")]
PsbtFund(super::ReadyForPsbtFunding),
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct KeyLocator {
/// The family of key being identified.
#[prost(int32, tag = "1")]
pub key_family: i32,
/// The precise index of the key being identified.
#[prost(int32, tag = "2")]
pub key_index: i32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct KeyDescriptor {
/// The raw bytes of the key being identified.
#[prost(bytes = "vec", tag = "1")]
pub raw_key_bytes: ::prost::alloc::vec::Vec<u8>,
/// The key locator that identifies which key to use for signing.
#[prost(message, optional, tag = "2")]
pub key_loc: ::core::option::Option<KeyLocator>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChanPointShim {
/// The size of the pre-crafted output to be used as the channel point for this
/// channel funding.
#[prost(int64, tag = "1")]
pub amt: i64,
/// The target channel point to refrence in created commitment transactions.
#[prost(message, optional, tag = "2")]
pub chan_point: ::core::option::Option<ChannelPoint>,
/// Our local key to use when creating the multi-sig output.
#[prost(message, optional, tag = "3")]
pub local_key: ::core::option::Option<KeyDescriptor>,
/// The key of the remote party to use when creating the multi-sig output.
#[prost(bytes = "vec", tag = "4")]
pub remote_key: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(bytes = "vec", tag = "5")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(uint32, tag = "6")]
pub thaw_height: u32,
/// Indicates that the funding output is using a MuSig2 multi-sig output.
#[prost(bool, tag = "7")]
pub musig2: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(bytes = "vec", tag = "1")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// An optional base PSBT the new channel output will be added to. If this is
/// non-empty, it must be a binary serialized PSBT.
#[prost(bytes = "vec", tag = "2")]
pub base_psbt: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(bool, tag = "3")]
pub no_publish: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FundingShim {
#[prost(oneof = "funding_shim::Shim", tags = "1, 2")]
pub shim: ::core::option::Option<funding_shim::Shim>,
}
/// Nested message and enum types in `FundingShim`.
pub mod funding_shim {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum Shim {
/// A channel shim where the channel point was fully constructed outside
/// of lnd's wallet and the transaction might already be published.
#[prost(message, tag = "1")]
ChanPointShim(super::ChanPointShim),
/// A channel shim that uses a PSBT to fund and sign the channel funding
/// transaction.
#[prost(message, tag = "2")]
PsbtShim(super::PsbtShim),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FundingShimCancel {
/// The pending channel ID of the channel to cancel the funding shim for.
#[prost(bytes = "vec", tag = "1")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(bytes = "vec", tag = "1")]
pub funded_psbt: ::prost::alloc::vec::Vec<u8>,
/// The pending channel ID of the channel to get the PSBT for.
#[prost(bytes = "vec", tag = "2")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// Can only be used if the no_publish flag was set to true in the OpenChannel
/// call meaning that the caller is solely responsible for publishing the final
/// funding transaction. If skip_finalize is set to true then lnd will not wait
/// for a FundingPsbtFinalize state step and instead assumes that a transaction
/// with the same TXID as the passed in PSBT will eventually confirm.
/// IT IS ABSOLUTELY IMPERATIVE that the TXID of the transaction that is
/// eventually published does have the *same TXID* as the verified PSBT. That
/// means no inputs or outputs can change, only signatures can be added. If the
/// TXID changes between this call and the publish step then the channel will
/// never be created and the funds will be in limbo.
#[prost(bool, tag = "3")]
pub skip_finalize: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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. Cannot be set at the same time as final_raw_tx.
#[prost(bytes = "vec", tag = "1")]
pub signed_psbt: ::prost::alloc::vec::Vec<u8>,
/// The pending channel ID of the channel to get the PSBT for.
#[prost(bytes = "vec", tag = "2")]
pub pending_chan_id: ::prost::alloc::vec::Vec<u8>,
/// As an alternative to the signed PSBT with all witness data, the final raw
/// wire format transaction can also be specified directly. Cannot be set at the
/// same time as signed_psbt.
#[prost(bytes = "vec", tag = "3")]
pub final_raw_tx: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FundingTransitionMsg {
#[prost(oneof = "funding_transition_msg::Trigger", tags = "1, 2, 3, 4")]
pub trigger: ::core::option::Option<funding_transition_msg::Trigger>,
}
/// Nested message and enum types in `FundingTransitionMsg`.
pub mod funding_transition_msg {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum 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.
#[prost(message, tag = "1")]
ShimRegister(super::FundingShim),
/// Used to cancel an existing registered funding shim.
#[prost(message, tag = "2")]
ShimCancel(super::FundingShimCancel),
/// 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.
#[prost(message, tag = "3")]
PsbtVerify(super::FundingPsbtVerify),
/// 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.
#[prost(message, tag = "4")]
PsbtFinalize(super::FundingPsbtFinalize),
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FundingStateStepResp {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingHtlc {
/// The direction within the channel that the htlc was sent
#[prost(bool, tag = "1")]
pub incoming: bool,
/// The total value of the htlc
#[prost(int64, tag = "2")]
pub amount: i64,
/// The final output to be swept back to the user's wallet
#[prost(string, tag = "3")]
pub outpoint: ::prost::alloc::string::String,
/// The next block height at which we can spend the current stage
#[prost(uint32, tag = "4")]
pub maturity_height: u32,
/// The number of blocks remaining until the current stage can be swept.
/// Negative values indicate how many blocks have passed since becoming
/// mature.
#[prost(int32, tag = "5")]
pub blocks_til_maturity: i32,
/// Indicates whether the htlc is in its first or second stage of recovery
#[prost(uint32, tag = "6")]
pub stage: u32,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingChannelsRequest {
/// Indicates whether to include the raw transaction hex for
/// waiting_close_channels.
#[prost(bool, tag = "1")]
pub include_raw_tx: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PendingChannelsResponse {
/// The balance in satoshis encumbered in pending channels
#[prost(int64, tag = "1")]
pub total_limbo_balance: i64,
/// Channels pending opening
#[prost(message, repeated, tag = "2")]
pub pending_open_channels: ::prost::alloc::vec::Vec<
pending_channels_response::PendingOpenChannel,
>,
/// 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.
#[deprecated]
#[prost(message, repeated, tag = "3")]
pub pending_closing_channels: ::prost::alloc::vec::Vec<
pending_channels_response::ClosedChannel,
>,
/// Channels pending force closing
#[prost(message, repeated, tag = "4")]
pub pending_force_closing_channels: ::prost::alloc::vec::Vec<
pending_channels_response::ForceClosedChannel,
>,
/// Channels waiting for closing tx to confirm
#[prost(message, repeated, tag = "5")]
pub waiting_close_channels: ::prost::alloc::vec::Vec<
pending_channels_response::WaitingCloseChannel,
>,
}
/// Nested message and enum types in `PendingChannelsResponse`.
pub mod pending_channels_response {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingChannel {
#[prost(string, tag = "1")]
pub remote_node_pub: ::prost::alloc::string::String,
#[prost(string, tag = "2")]
pub channel_point: ::prost::alloc::string::String,
#[prost(int64, tag = "3")]
pub capacity: i64,
#[prost(int64, tag = "4")]
pub local_balance: i64,
#[prost(int64, tag = "5")]
pub remote_balance: i64,
/// The minimum satoshis this node is required to reserve in its
/// balance.
#[prost(int64, tag = "6")]
pub local_chan_reserve_sat: i64,
/// The minimum satoshis the other node is required to reserve in its
/// balance.
#[prost(int64, tag = "7")]
pub remote_chan_reserve_sat: i64,
/// The party that initiated opening the channel.
#[prost(enumeration = "super::Initiator", tag = "8")]
pub initiator: i32,
/// The commitment type used by this channel.
#[prost(enumeration = "super::CommitmentType", tag = "9")]
pub commitment_type: i32,
/// Total number of forwarding packages created in this channel.
#[prost(int64, tag = "10")]
pub num_forwarding_packages: i64,
/// A set of flags showing the current state of the channel.
#[prost(string, tag = "11")]
pub chan_status_flags: ::prost::alloc::string::String,
/// Whether this channel is advertised to the network or not.
#[prost(bool, tag = "12")]
pub private: bool,
/// An optional note-to-self to go along with the channel containing some
/// useful information. This is only ever stored locally and in no way
/// impacts the channel's operation.
#[prost(string, tag = "13")]
pub memo: ::prost::alloc::string::String,
/// Custom channel data that might be populated in custom channels.
#[prost(bytes = "vec", tag = "34")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PendingOpenChannel {
/// The pending channel
#[prost(message, optional, tag = "1")]
pub channel: ::core::option::Option<PendingChannel>,
/// 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.
#[prost(int64, tag = "4")]
pub commit_fee: i64,
/// The weight of the commitment transaction
#[prost(int64, tag = "5")]
pub commit_weight: i64,
/// 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.
#[prost(int64, tag = "6")]
pub fee_per_kw: i64,
/// The number of blocks until the funding transaction is considered
/// expired. If this value gets close to zero, there is a risk that the
/// channel funding will be canceled by the channel responder. The
/// channel should be fee bumped using CPFP (see walletrpc.BumpFee) to
/// ensure that the channel confirms in time. Otherwise a force-close
/// will be necessary if the channel confirms after the funding
/// transaction expires. A negative value means the channel responder has
/// very likely canceled the funding and the channel will never become
/// fully operational.
#[prost(int32, tag = "3")]
pub funding_expiry_blocks: i32,
/// The number of blocks remaining until the channel status changes from
/// pending to active. A value of 0 indicates that the channel is now
/// active.
///
/// "Active" here means both channel peers have the channel marked OPEN
/// and can immediately start using it. For public channels, this does
/// not imply a channel_announcement has been gossiped. It only becomes
/// public on the network after 6 on‐chain confirmations.
/// See BOLT07 "Routing Gossip":
/// <https://github.com/lightning/bolts/blob/master/07-routing-gossip.md>
///
/// ZeroConf channels bypass the pending state entirely: they are marked
/// active immediately upon creation, so they never show up as "pending".
#[prost(uint32, tag = "7")]
pub confirmations_until_active: u32,
/// The confirmation height records the block height at which the funding
/// transaction was first confirmed.
#[prost(uint32, tag = "8")]
pub confirmation_height: u32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct WaitingCloseChannel {
/// The pending channel waiting for closing tx to confirm
#[prost(message, optional, tag = "1")]
pub channel: ::core::option::Option<PendingChannel>,
/// The balance in satoshis encumbered in this channel
#[prost(int64, tag = "2")]
pub limbo_balance: i64,
/// A list of valid commitment transactions. Any of these can confirm at
/// this point.
#[prost(message, optional, tag = "3")]
pub commitments: ::core::option::Option<Commitments>,
/// The transaction id of the closing transaction
#[prost(string, tag = "4")]
pub closing_txid: ::prost::alloc::string::String,
/// The raw hex encoded bytes of the closing transaction. Included if
/// include_raw_tx in the request is true.
#[prost(string, tag = "5")]
pub closing_tx_hex: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Commitments {
/// Hash of the local version of the commitment tx.
#[prost(string, tag = "1")]
pub local_txid: ::prost::alloc::string::String,
/// Hash of the remote version of the commitment tx.
#[prost(string, tag = "2")]
pub remote_txid: ::prost::alloc::string::String,
/// Hash of the remote pending version of the commitment tx.
#[prost(string, tag = "3")]
pub remote_pending_txid: ::prost::alloc::string::String,
/// The amount in satoshis calculated to be paid in fees for the local
/// commitment.
#[prost(uint64, tag = "4")]
pub local_commit_fee_sat: u64,
/// The amount in satoshis calculated to be paid in fees for the remote
/// commitment.
#[prost(uint64, tag = "5")]
pub remote_commit_fee_sat: u64,
/// The amount in satoshis calculated to be paid in fees for the remote
/// pending commitment.
#[prost(uint64, tag = "6")]
pub remote_pending_commit_fee_sat: u64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ClosedChannel {
/// The pending channel to be closed
#[prost(message, optional, tag = "1")]
pub channel: ::core::option::Option<PendingChannel>,
/// The transaction id of the closing transaction
#[prost(string, tag = "2")]
pub closing_txid: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ForceClosedChannel {
/// The pending channel to be force closed
#[prost(message, optional, tag = "1")]
pub channel: ::core::option::Option<PendingChannel>,
/// The transaction id of the closing transaction
#[prost(string, tag = "2")]
pub closing_txid: ::prost::alloc::string::String,
/// The balance in satoshis encumbered in this pending channel
#[prost(int64, tag = "3")]
pub limbo_balance: i64,
/// The height at which funds can be swept into the wallet
#[prost(uint32, tag = "4")]
pub maturity_height: u32,
/// Remaining # of blocks until the commitment output can be swept.
/// Negative values indicate how many blocks have passed since becoming
/// mature.
#[prost(int32, tag = "5")]
pub blocks_til_maturity: i32,
/// The total value of funds successfully recovered from this channel
#[prost(int64, tag = "6")]
pub recovered_balance: i64,
#[prost(message, repeated, tag = "8")]
pub pending_htlcs: ::prost::alloc::vec::Vec<super::PendingHtlc>,
#[prost(enumeration = "force_closed_channel::AnchorState", tag = "9")]
pub anchor: i32,
}
/// Nested message and enum types in `ForceClosedChannel`.
pub mod force_closed_channel {
/// There are three resolution states for the anchor:
/// limbo, lost and recovered. Derive the current state
/// from the limbo and recovered balances.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum AnchorState {
/// The recovered_balance is zero and limbo_balance is non-zero.
Limbo = 0,
/// The recovered_balance is non-zero.
Recovered = 1,
/// A state that is neither LIMBO nor RECOVERED.
Lost = 2,
}
impl AnchorState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Limbo => "LIMBO",
Self::Recovered => "RECOVERED",
Self::Lost => "LOST",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LIMBO" => Some(Self::Limbo),
"RECOVERED" => Some(Self::Recovered),
"LOST" => Some(Self::Lost),
_ => None,
}
}
}
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelEventSubscription {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelEventUpdate {
#[prost(enumeration = "channel_event_update::UpdateType", tag = "5")]
pub r#type: i32,
#[prost(oneof = "channel_event_update::Channel", tags = "1, 2, 3, 4, 6, 7, 8")]
pub channel: ::core::option::Option<channel_event_update::Channel>,
}
/// Nested message and enum types in `ChannelEventUpdate`.
pub mod channel_event_update {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum UpdateType {
OpenChannel = 0,
ClosedChannel = 1,
ActiveChannel = 2,
InactiveChannel = 3,
PendingOpenChannel = 4,
FullyResolvedChannel = 5,
ChannelFundingTimeout = 6,
}
impl UpdateType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::OpenChannel => "OPEN_CHANNEL",
Self::ClosedChannel => "CLOSED_CHANNEL",
Self::ActiveChannel => "ACTIVE_CHANNEL",
Self::InactiveChannel => "INACTIVE_CHANNEL",
Self::PendingOpenChannel => "PENDING_OPEN_CHANNEL",
Self::FullyResolvedChannel => "FULLY_RESOLVED_CHANNEL",
Self::ChannelFundingTimeout => "CHANNEL_FUNDING_TIMEOUT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPEN_CHANNEL" => Some(Self::OpenChannel),
"CLOSED_CHANNEL" => Some(Self::ClosedChannel),
"ACTIVE_CHANNEL" => Some(Self::ActiveChannel),
"INACTIVE_CHANNEL" => Some(Self::InactiveChannel),
"PENDING_OPEN_CHANNEL" => Some(Self::PendingOpenChannel),
"FULLY_RESOLVED_CHANNEL" => Some(Self::FullyResolvedChannel),
"CHANNEL_FUNDING_TIMEOUT" => Some(Self::ChannelFundingTimeout),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Channel {
#[prost(message, tag = "1")]
OpenChannel(super::Channel),
#[prost(message, tag = "2")]
ClosedChannel(super::ChannelCloseSummary),
#[prost(message, tag = "3")]
ActiveChannel(super::ChannelPoint),
#[prost(message, tag = "4")]
InactiveChannel(super::ChannelPoint),
#[prost(message, tag = "6")]
PendingOpenChannel(super::PendingUpdate),
#[prost(message, tag = "7")]
FullyResolvedChannel(super::ChannelPoint),
#[prost(message, tag = "8")]
ChannelFundingTimeout(super::ChannelPoint),
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct WalletAccountBalance {
/// The confirmed balance of the account (with >= 1 confirmations).
#[prost(int64, tag = "1")]
pub confirmed_balance: i64,
/// The unconfirmed balance of the account (with 0 confirmations).
#[prost(int64, tag = "2")]
pub unconfirmed_balance: i64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct WalletBalanceRequest {
/// The wallet account the balance is shown for.
/// If this is not specified, the balance of the "default" account is shown.
#[prost(string, tag = "1")]
pub account: ::prost::alloc::string::String,
/// The minimum number of confirmations each one of your outputs used for the
/// funding transaction must satisfy. If this is not specified, the default
/// value of 1 is used.
#[prost(int32, tag = "2")]
pub min_confs: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WalletBalanceResponse {
/// The balance of the wallet
#[prost(int64, tag = "1")]
pub total_balance: i64,
/// The confirmed balance of a wallet(with >= 1 confirmations)
#[prost(int64, tag = "2")]
pub confirmed_balance: i64,
/// The unconfirmed balance of a wallet(with 0 confirmations)
#[prost(int64, tag = "3")]
pub unconfirmed_balance: i64,
/// The total amount of wallet UTXOs held in outputs that are locked for
/// other usage.
#[prost(int64, tag = "5")]
pub locked_balance: i64,
/// The amount of reserve required.
#[prost(int64, tag = "6")]
pub reserved_balance_anchor_chan: i64,
/// A mapping of each wallet account's name to its balance.
#[prost(map = "string, message", tag = "4")]
pub account_balance: ::std::collections::HashMap<
::prost::alloc::string::String,
WalletAccountBalance,
>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Amount {
/// Value denominated in satoshis.
#[prost(uint64, tag = "1")]
pub sat: u64,
/// Value denominated in milli-satoshis.
#[prost(uint64, tag = "2")]
pub msat: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelBalanceRequest {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelBalanceResponse {
/// Deprecated. Sum of channels balances denominated in satoshis
#[deprecated]
#[prost(int64, tag = "1")]
pub balance: i64,
/// Deprecated. Sum of channels pending balances denominated in satoshis
#[deprecated]
#[prost(int64, tag = "2")]
pub pending_open_balance: i64,
/// Sum of channels local balances.
#[prost(message, optional, tag = "3")]
pub local_balance: ::core::option::Option<Amount>,
/// Sum of channels remote balances.
#[prost(message, optional, tag = "4")]
pub remote_balance: ::core::option::Option<Amount>,
/// Sum of channels local unsettled balances.
#[prost(message, optional, tag = "5")]
pub unsettled_local_balance: ::core::option::Option<Amount>,
/// Sum of channels remote unsettled balances.
#[prost(message, optional, tag = "6")]
pub unsettled_remote_balance: ::core::option::Option<Amount>,
/// Sum of channels pending local balances.
#[prost(message, optional, tag = "7")]
pub pending_open_local_balance: ::core::option::Option<Amount>,
/// Sum of channels pending remote balances.
#[prost(message, optional, tag = "8")]
pub pending_open_remote_balance: ::core::option::Option<Amount>,
/// Custom channel data that might be populated if there are custom channels
/// present.
#[prost(bytes = "vec", tag = "9")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryRoutesRequest {
/// The 33-byte hex-encoded public key for the payment destination
#[prost(string, tag = "1")]
pub pub_key: ::prost::alloc::string::String,
/// The amount to send expressed in satoshis.
///
/// The fields amt and amt_msat are mutually exclusive.
#[prost(int64, tag = "2")]
pub amt: i64,
/// The amount to send expressed in millisatoshis.
///
/// The fields amt and amt_msat are mutually exclusive.
#[prost(int64, tag = "12")]
pub amt_msat: i64,
/// 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.
///
/// Note: must not be set if making a payment to a blinded path (delta is
/// set by the aggregate parameters provided by blinded_payment_paths)
#[prost(int32, tag = "4")]
pub final_cltv_delta: i32,
/// 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. If not specified, lnd will use a default value of 100%
/// fees for small amounts (\<=1k sat) or 5% fees for larger amounts.
#[prost(message, optional, tag = "5")]
pub fee_limit: ::core::option::Option<FeeLimit>,
/// A list of nodes to ignore during path finding. When using REST, these fields
/// must be encoded as base64.
#[prost(bytes = "vec", repeated, tag = "6")]
pub ignored_nodes: ::prost::alloc::vec::Vec<::prost::alloc::vec::Vec<u8>>,
/// Deprecated. A list of edges to ignore during path finding.
#[deprecated]
#[prost(message, repeated, tag = "7")]
pub ignored_edges: ::prost::alloc::vec::Vec<EdgeLocator>,
/// The source node where the request route should originated from. If empty,
/// self is assumed.
#[prost(string, tag = "8")]
pub source_pub_key: ::prost::alloc::string::String,
/// If set to true, edge probabilities from mission control will be used to get
/// the optimal route.
#[prost(bool, tag = "9")]
pub use_mission_control: bool,
/// A list of directed node pairs that will be ignored during path finding.
#[prost(message, repeated, tag = "10")]
pub ignored_pairs: ::prost::alloc::vec::Vec<NodePair>,
/// 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.
#[prost(uint32, tag = "11")]
pub cltv_limit: u32,
/// 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 records, an 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.
#[prost(map = "uint64, bytes", tag = "13")]
pub dest_custom_records: ::std::collections::HashMap<
u64,
::prost::alloc::vec::Vec<u8>,
>,
/// Deprecated, use outgoing_chan_ids. The channel id of the channel that must
/// be taken to the first hop. If zero, any channel may be used.
#[deprecated]
#[prost(uint64, tag = "14")]
pub outgoing_chan_id: u64,
/// The pubkey of the last hop of the route. If empty, any hop may be used.
#[prost(bytes = "vec", tag = "15")]
pub last_hop_pubkey: ::prost::alloc::vec::Vec<u8>,
/// Optional route hints to reach the destination through private channels.
#[prost(message, repeated, tag = "16")]
pub route_hints: ::prost::alloc::vec::Vec<RouteHint>,
/// An optional blinded path(s) to reach the destination. Note that the
/// introduction node must be provided as the first hop in the route.
#[prost(message, repeated, tag = "19")]
pub blinded_payment_paths: ::prost::alloc::vec::Vec<BlindedPaymentPath>,
/// 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.
///
/// Note: must not be set if making a payment to a blinded route (features
/// are provided in blinded_payment_paths).
#[prost(enumeration = "FeatureBit", repeated, tag = "17")]
pub dest_features: ::prost::alloc::vec::Vec<i32>,
/// The time preference for this payment. Set to -1 to optimize for fees
/// only, to 1 to optimize for reliability only or a value inbetween for a mix.
#[prost(double, tag = "18")]
pub time_pref: f64,
/// The channel ids of the channels allowed for the first hop. If empty, any
/// channel may be used.
#[prost(uint64, repeated, tag = "20")]
pub outgoing_chan_ids: ::prost::alloc::vec::Vec<u64>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NodePair {
/// The sending node of the pair. When using REST, this field must be encoded as
/// base64.
#[prost(bytes = "vec", tag = "1")]
pub from: ::prost::alloc::vec::Vec<u8>,
/// The receiving node of the pair. When using REST, this field must be encoded
/// as base64.
#[prost(bytes = "vec", tag = "2")]
pub to: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct EdgeLocator {
/// The short channel id of this edge.
#[prost(uint64, tag = "1")]
pub channel_id: u64,
/// 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.
#[prost(bool, tag = "2")]
pub direction_reverse: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryRoutesResponse {
/// The route that results from the path finding operation. This is still a
/// repeated field to retain backwards compatibility.
#[prost(message, repeated, tag = "1")]
pub routes: ::prost::alloc::vec::Vec<Route>,
/// The success probability of the returned route based on the current mission
/// control state. \[EXPERIMENTAL\]
#[prost(double, tag = "2")]
pub success_prob: f64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub chan_id: u64,
#[deprecated]
#[prost(int64, tag = "2")]
pub chan_capacity: i64,
#[deprecated]
#[prost(int64, tag = "3")]
pub amt_to_forward: i64,
#[deprecated]
#[prost(int64, tag = "4")]
pub fee: i64,
#[prost(uint32, tag = "5")]
pub expiry: u32,
#[prost(int64, tag = "6")]
pub amt_to_forward_msat: i64,
#[prost(int64, tag = "7")]
pub fee_msat: i64,
/// 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.
#[prost(string, tag = "8")]
pub pub_key: ::prost::alloc::string::String,
/// 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.
#[deprecated]
#[prost(bool, tag = "9")]
pub tlv_payload: bool,
/// An optional TLV record that signals the use of an MPP payment. If present,
/// the receiver will enforce 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.
#[prost(message, optional, tag = "10")]
pub mpp_record: ::core::option::Option<MppRecord>,
/// An optional TLV record that signals the use of an AMP payment. If present,
/// the receiver will treat all received payments including the same
/// (payment_addr, set_id) pair as being part of one logical payment. The
/// payment will be settled by XORing the root_share's together and deriving the
/// child hashes and preimages according to BOLT XX. Must be used in conjunction
/// with mpp_record.
#[prost(message, optional, tag = "12")]
pub amp_record: ::core::option::Option<AmpRecord>,
/// 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.
#[prost(map = "uint64, bytes", tag = "11")]
pub custom_records: ::std::collections::HashMap<u64, ::prost::alloc::vec::Vec<u8>>,
/// The payment metadata to send along with the payment to the payee.
#[prost(bytes = "vec", tag = "13")]
pub metadata: ::prost::alloc::vec::Vec<u8>,
/// Blinding point is an optional blinding point included for introduction
/// nodes in blinded paths. This field is mandatory for hops that represents
/// the introduction point in a blinded path.
#[prost(bytes = "vec", tag = "14")]
pub blinding_point: ::prost::alloc::vec::Vec<u8>,
/// Encrypted data is a receiver-produced blob of data that provides hops
/// in a blinded route with forwarding data. As this data is encrypted by
/// the recipient, we will not be able to parse it - it is essentially an
/// arbitrary blob of data from our node's perspective. This field is
/// mandatory for all hops in a blinded path, including the introduction
/// node.
#[prost(bytes = "vec", tag = "15")]
pub encrypted_data: ::prost::alloc::vec::Vec<u8>,
/// The total amount that is sent to the recipient (possibly across multiple
/// HTLCs), as specified by the sender when making a payment to a blinded path.
/// This value is only set in the final hop payload of a blinded payment. This
/// value is analogous to the MPPRecord that is used for regular (non-blinded)
/// MPP payments.
#[prost(uint64, tag = "16")]
pub total_amt_msat: u64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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. This is also called
/// payment secret in specifications (e.g. BOLT 11).
#[prost(bytes = "vec", tag = "11")]
pub payment_addr: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(int64, tag = "10")]
pub total_amt_msat: i64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AmpRecord {
#[prost(bytes = "vec", tag = "1")]
pub root_share: ::prost::alloc::vec::Vec<u8>,
#[prost(bytes = "vec", tag = "2")]
pub set_id: ::prost::alloc::vec::Vec<u8>,
#[prost(uint32, tag = "3")]
pub child_index: u32,
}
/// 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.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(uint32, tag = "1")]
pub total_time_lock: u32,
/// 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.
#[deprecated]
#[prost(int64, tag = "2")]
pub total_fees: i64,
/// 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.
#[deprecated]
#[prost(int64, tag = "3")]
pub total_amt: i64,
/// Contains details concerning the specific forwarding details at each hop.
#[prost(message, repeated, tag = "4")]
pub hops: ::prost::alloc::vec::Vec<Hop>,
/// The total fees in millisatoshis.
#[prost(int64, tag = "5")]
pub total_fees_msat: i64,
/// The total amount in millisatoshis.
#[prost(int64, tag = "6")]
pub total_amt_msat: i64,
/// The actual on-chain amount that was sent out to the first hop. This value is
/// only different from the total_amt_msat field if this is a custom channel
/// payment and the value transported in the HTLC is different from the BTC
/// amount in the HTLC. If this value is zero, then this is an old payment that
/// didn't have this value yet and can be ignored.
#[prost(int64, tag = "7")]
pub first_hop_amount_msat: i64,
/// Custom channel data that might be populated in custom channels.
#[prost(bytes = "vec", tag = "8")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NodeInfoRequest {
/// The 33-byte hex-encoded compressed public of the target node
#[prost(string, tag = "1")]
pub pub_key: ::prost::alloc::string::String,
/// If true, will include all known channels associated with the node.
#[prost(bool, tag = "2")]
pub include_channels: bool,
/// If true, will include announcements' signatures into ChannelEdge.
/// Depends on include_channels.
#[prost(bool, tag = "3")]
pub include_auth_proof: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(message, optional, tag = "1")]
pub node: ::core::option::Option<LightningNode>,
/// The total number of channels for the node.
#[prost(uint32, tag = "2")]
pub num_channels: u32,
/// The sum of all channels capacity for the node, denominated in satoshis.
#[prost(int64, tag = "3")]
pub total_capacity: i64,
/// A list of all public channels for the node.
#[prost(message, repeated, tag = "4")]
pub channels: ::prost::alloc::vec::Vec<ChannelEdge>,
}
/// 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.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LightningNode {
#[prost(uint32, tag = "1")]
pub last_update: u32,
#[prost(string, tag = "2")]
pub pub_key: ::prost::alloc::string::String,
#[prost(string, tag = "3")]
pub alias: ::prost::alloc::string::String,
#[prost(message, repeated, tag = "4")]
pub addresses: ::prost::alloc::vec::Vec<NodeAddress>,
#[prost(string, tag = "5")]
pub color: ::prost::alloc::string::String,
#[prost(map = "uint32, message", tag = "6")]
pub features: ::std::collections::HashMap<u32, Feature>,
/// Custom node announcement tlv records.
#[prost(map = "uint64, bytes", tag = "7")]
pub custom_records: ::std::collections::HashMap<u64, ::prost::alloc::vec::Vec<u8>>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NodeAddress {
#[prost(string, tag = "1")]
pub network: ::prost::alloc::string::String,
#[prost(string, tag = "2")]
pub addr: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RoutingPolicy {
#[prost(uint32, tag = "1")]
pub time_lock_delta: u32,
#[prost(int64, tag = "2")]
pub min_htlc: i64,
#[prost(int64, tag = "3")]
pub fee_base_msat: i64,
#[prost(int64, tag = "4")]
pub fee_rate_milli_msat: i64,
#[prost(bool, tag = "5")]
pub disabled: bool,
#[prost(uint64, tag = "6")]
pub max_htlc_msat: u64,
#[prost(uint32, tag = "7")]
pub last_update: u32,
/// Custom channel update tlv records. These are customized fields that are
/// not defined by LND and cannot be extracted.
#[prost(map = "uint64, bytes", tag = "8")]
pub custom_records: ::std::collections::HashMap<u64, ::prost::alloc::vec::Vec<u8>>,
#[prost(int32, tag = "9")]
pub inbound_fee_base_msat: i32,
#[prost(int32, tag = "10")]
pub inbound_fee_rate_milli_msat: i32,
}
/// ChannelAuthProof is the authentication proof (the signature portion) for a
/// channel. Using the four signatures contained in the struct, and some
/// auxiliary knowledge (the funding script, node identities, and outpoint) nodes
/// on the network are able to validate the authenticity and existence of a
/// channel.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelAuthProof {
/// node_sig1 are the raw bytes of the first node signature encoded
/// in DER format.
#[prost(bytes = "vec", tag = "1")]
pub node_sig1: ::prost::alloc::vec::Vec<u8>,
/// bitcoin_sig1 are the raw bytes of the first bitcoin signature of the
/// MultiSigKey key of the channel encoded in DER format.
#[prost(bytes = "vec", tag = "2")]
pub bitcoin_sig1: ::prost::alloc::vec::Vec<u8>,
/// node_sig2 are the raw bytes of the second node signature encoded
/// in DER format.
#[prost(bytes = "vec", tag = "3")]
pub node_sig2: ::prost::alloc::vec::Vec<u8>,
/// bitcoin_sig2 are the raw bytes of the second bitcoin signature of the
/// MultiSigKey key of the channel encoded in DER format.
#[prost(bytes = "vec", tag = "4")]
pub bitcoin_sig2: ::prost::alloc::vec::Vec<u8>,
}
/// 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.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub channel_id: u64,
#[prost(string, tag = "2")]
pub chan_point: ::prost::alloc::string::String,
#[deprecated]
#[prost(uint32, tag = "3")]
pub last_update: u32,
#[prost(string, tag = "4")]
pub node1_pub: ::prost::alloc::string::String,
#[prost(string, tag = "5")]
pub node2_pub: ::prost::alloc::string::String,
#[prost(int64, tag = "6")]
pub capacity: i64,
#[prost(message, optional, tag = "7")]
pub node1_policy: ::core::option::Option<RoutingPolicy>,
#[prost(message, optional, tag = "8")]
pub node2_policy: ::core::option::Option<RoutingPolicy>,
/// Custom channel announcement tlv records.
#[prost(map = "uint64, bytes", tag = "9")]
pub custom_records: ::std::collections::HashMap<u64, ::prost::alloc::vec::Vec<u8>>,
/// Authentication proof for this channel. This proof contains a set of
/// signatures binding four identities, which attests to the legitimacy of
/// the advertised channel. This only is available for advertised channels.
/// This field is not filled by default. Pass include_auth_proof flag to
/// DescribeGraph, GetNodeInfo or GetChanInfo to get this data.
#[prost(message, optional, tag = "10")]
pub auth_proof: ::core::option::Option<ChannelAuthProof>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(bool, tag = "1")]
pub include_unannounced: bool,
/// If true, will include announcements' signatures into ChannelEdge.
#[prost(bool, tag = "2")]
pub include_auth_proof: bool,
}
/// Returns a new instance of the directed channel graph.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelGraph {
/// The list of `LightningNode`s in this channel graph
#[prost(message, repeated, tag = "1")]
pub nodes: ::prost::alloc::vec::Vec<LightningNode>,
/// The list of `ChannelEdge`s in this channel graph
#[prost(message, repeated, tag = "2")]
pub edges: ::prost::alloc::vec::Vec<ChannelEdge>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NodeMetricsRequest {
/// The requested node metrics.
#[prost(enumeration = "NodeMetricType", repeated, tag = "1")]
pub types: ::prost::alloc::vec::Vec<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(map = "string, message", tag = "1")]
pub betweenness_centrality: ::std::collections::HashMap<
::prost::alloc::string::String,
FloatMetric,
>,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct FloatMetric {
/// Arbitrary float value.
#[prost(double, tag = "1")]
pub value: f64,
/// The value normalized to \[0,1\] or \[-1,1\].
#[prost(double, tag = "2")]
pub normalized_value: f64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub chan_id: u64,
/// The channel point of the channel in format funding_txid:output_index. If
/// chan_id is specified, this field is ignored.
#[prost(string, tag = "2")]
pub chan_point: ::prost::alloc::string::String,
/// If true, will include announcements' signatures into ChannelEdge.
#[prost(bool, tag = "3")]
pub include_auth_proof: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct NetworkInfoRequest {}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct NetworkInfo {
#[prost(uint32, tag = "1")]
pub graph_diameter: u32,
#[prost(double, tag = "2")]
pub avg_out_degree: f64,
#[prost(uint32, tag = "3")]
pub max_out_degree: u32,
#[prost(uint32, tag = "4")]
pub num_nodes: u32,
#[prost(uint32, tag = "5")]
pub num_channels: u32,
#[prost(int64, tag = "6")]
pub total_network_capacity: i64,
#[prost(double, tag = "7")]
pub avg_channel_size: f64,
#[prost(int64, tag = "8")]
pub min_channel_size: i64,
#[prost(int64, tag = "9")]
pub max_channel_size: i64,
#[prost(int64, tag = "10")]
pub median_channel_size_sat: i64,
/// The number of edges marked as zombies.
#[prost(uint64, tag = "11")]
pub num_zombie_chans: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct StopRequest {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct StopResponse {
/// The status of the stop operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GraphTopologySubscription {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GraphTopologyUpdate {
#[prost(message, repeated, tag = "1")]
pub node_updates: ::prost::alloc::vec::Vec<NodeUpdate>,
#[prost(message, repeated, tag = "2")]
pub channel_updates: ::prost::alloc::vec::Vec<ChannelEdgeUpdate>,
#[prost(message, repeated, tag = "3")]
pub closed_chans: ::prost::alloc::vec::Vec<ClosedChannelUpdate>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NodeUpdate {
/// Deprecated, use node_addresses.
#[deprecated]
#[prost(string, repeated, tag = "1")]
pub addresses: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
#[prost(string, tag = "2")]
pub identity_key: ::prost::alloc::string::String,
/// Deprecated, use features.
#[deprecated]
#[prost(bytes = "vec", tag = "3")]
pub global_features: ::prost::alloc::vec::Vec<u8>,
#[prost(string, tag = "4")]
pub alias: ::prost::alloc::string::String,
#[prost(string, tag = "5")]
pub color: ::prost::alloc::string::String,
#[prost(message, repeated, tag = "7")]
pub node_addresses: ::prost::alloc::vec::Vec<NodeAddress>,
/// Features that the node has advertised in the init message, node
/// announcements and invoices.
#[prost(map = "uint32, message", tag = "6")]
pub features: ::std::collections::HashMap<u32, Feature>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub chan_id: u64,
#[prost(message, optional, tag = "2")]
pub chan_point: ::core::option::Option<ChannelPoint>,
#[prost(int64, tag = "3")]
pub capacity: i64,
#[prost(message, optional, tag = "4")]
pub routing_policy: ::core::option::Option<RoutingPolicy>,
#[prost(string, tag = "5")]
pub advertising_node: ::prost::alloc::string::String,
#[prost(string, tag = "6")]
pub connecting_node: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub chan_id: u64,
#[prost(int64, tag = "2")]
pub capacity: i64,
#[prost(uint32, tag = "3")]
pub closed_height: u32,
#[prost(message, optional, tag = "4")]
pub chan_point: ::core::option::Option<ChannelPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct HopHint {
/// The public key of the node at the start of the channel.
#[prost(string, tag = "1")]
pub node_id: ::prost::alloc::string::String,
/// The unique identifier of the channel.
#[prost(uint64, tag = "2")]
pub chan_id: u64,
/// The base fee of the channel denominated in millisatoshis.
#[prost(uint32, tag = "3")]
pub fee_base_msat: u32,
/// The fee rate of the channel for sending one satoshi across it denominated in
/// millionths of a satoshi.
#[prost(uint32, tag = "4")]
pub fee_proportional_millionths: u32,
/// The time-lock delta of the channel.
#[prost(uint32, tag = "5")]
pub cltv_expiry_delta: u32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct SetId {
#[prost(bytes = "vec", tag = "1")]
pub set_id: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RouteHint {
/// A list of hop hints that when chained together can assist in reaching a
/// specific destination.
#[prost(message, repeated, tag = "1")]
pub hop_hints: ::prost::alloc::vec::Vec<HopHint>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BlindedPaymentPath {
/// The blinded path to send the payment to.
#[prost(message, optional, tag = "1")]
pub blinded_path: ::core::option::Option<BlindedPath>,
/// The base fee for the blinded path provided, expressed in msat.
#[prost(uint64, tag = "2")]
pub base_fee_msat: u64,
/// The proportional fee for the blinded path provided, expressed in parts
/// per million.
#[prost(uint32, tag = "3")]
pub proportional_fee_rate: u32,
/// The total CLTV delta for the blinded path provided, including the
/// final CLTV delta for the receiving node.
#[prost(uint32, tag = "4")]
pub total_cltv_delta: u32,
/// The minimum hltc size that may be sent over the blinded path, expressed
/// in msat.
#[prost(uint64, tag = "5")]
pub htlc_min_msat: u64,
/// The maximum htlc size that may be sent over the blinded path, expressed
/// in msat.
#[prost(uint64, tag = "6")]
pub htlc_max_msat: u64,
/// The feature bits for the route.
#[prost(enumeration = "FeatureBit", repeated, tag = "7")]
pub features: ::prost::alloc::vec::Vec<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BlindedPath {
/// The unblinded pubkey of the introduction node for the route.
#[prost(bytes = "vec", tag = "1")]
pub introduction_node: ::prost::alloc::vec::Vec<u8>,
/// The ephemeral pubkey used by nodes in the blinded route.
#[prost(bytes = "vec", tag = "2")]
pub blinding_point: ::prost::alloc::vec::Vec<u8>,
/// A set of blinded node keys and data blobs for the blinded portion of the
/// route. Note that the first hop is expected to be the introduction node,
/// so the route is always expected to have at least one hop.
#[prost(message, repeated, tag = "3")]
pub blinded_hops: ::prost::alloc::vec::Vec<BlindedHop>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct BlindedHop {
/// The blinded public key of the node.
#[prost(bytes = "vec", tag = "1")]
pub blinded_node: ::prost::alloc::vec::Vec<u8>,
/// An encrypted blob of data provided to the blinded node.
#[prost(bytes = "vec", tag = "2")]
pub encrypted_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AmpInvoiceState {
/// The state the HTLCs associated with this setID are in.
#[prost(enumeration = "InvoiceHtlcState", tag = "1")]
pub state: i32,
/// The settle index of this HTLC set, if the invoice state is settled.
#[prost(uint64, tag = "2")]
pub settle_index: u64,
/// The time this HTLC set was settled expressed in unix epoch.
#[prost(int64, tag = "3")]
pub settle_time: i64,
/// The total amount paid for the sub-invoice expressed in milli satoshis.
#[prost(int64, tag = "5")]
pub amt_paid_msat: i64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct 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.
#[prost(string, tag = "1")]
pub memo: ::prost::alloc::string::String,
/// 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.
#[prost(bytes = "vec", tag = "3")]
pub r_preimage: ::prost::alloc::vec::Vec<u8>,
/// The hash of the preimage. When using REST, this field must be encoded as
/// base64.
/// Note: Output only, don't specify for creating an invoice.
#[prost(bytes = "vec", tag = "4")]
pub r_hash: ::prost::alloc::vec::Vec<u8>,
/// The value of this invoice in satoshis
///
/// The fields value and value_msat are mutually exclusive.
#[prost(int64, tag = "5")]
pub value: i64,
/// The value of this invoice in millisatoshis
///
/// The fields value and value_msat are mutually exclusive.
#[prost(int64, tag = "23")]
pub value_msat: i64,
/// Whether this invoice has been fulfilled.
///
/// The field is deprecated. Use the state field instead (compare to SETTLED).
#[deprecated]
#[prost(bool, tag = "6")]
pub settled: bool,
/// When this invoice was created.
/// Measured in seconds since the unix epoch.
/// Note: Output only, don't specify for creating an invoice.
#[prost(int64, tag = "7")]
pub creation_date: i64,
/// When this invoice was settled.
/// Measured in seconds since the unix epoch.
/// Note: Output only, don't specify for creating an invoice.
#[prost(int64, tag = "8")]
pub settle_date: i64,
/// 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.
/// Note: Output only, don't specify for creating an invoice.
#[prost(string, tag = "9")]
pub payment_request: ::prost::alloc::string::String,
/// 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.
#[prost(bytes = "vec", tag = "10")]
pub description_hash: ::prost::alloc::vec::Vec<u8>,
/// Payment request expiry time in seconds. Default is 86400 (24 hours).
#[prost(int64, tag = "11")]
pub expiry: i64,
/// Fallback on-chain address.
#[prost(string, tag = "12")]
pub fallback_addr: ::prost::alloc::string::String,
/// Delta to use for the time-lock of the CLTV extended to the final hop.
#[prost(uint64, tag = "13")]
pub cltv_expiry: u64,
/// Route hints that can each be individually used to assist in reaching the
/// invoice's destination.
#[prost(message, repeated, tag = "14")]
pub route_hints: ::prost::alloc::vec::Vec<RouteHint>,
/// Whether this invoice should include routing hints for private channels.
/// Note: When enabled, if value and value_msat are zero, a large number of
/// hints with these channels can be included, which might not be desirable.
#[prost(bool, tag = "15")]
pub private: bool,
/// 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.
/// Note: Output only, don't specify for creating an invoice.
#[prost(uint64, tag = "16")]
pub add_index: u64,
/// 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.
/// Note: Output only, don't specify for creating an invoice.
#[prost(uint64, tag = "17")]
pub settle_index: u64,
/// Deprecated, use amt_paid_sat or amt_paid_msat.
#[deprecated]
#[prost(int64, tag = "18")]
pub amt_paid: i64,
/// The amount that was accepted for this invoice, in satoshis. This will ONLY
/// be set if this invoice has been settled or accepted. 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.
/// Note: Output only, don't specify for creating an invoice.
#[prost(int64, tag = "19")]
pub amt_paid_sat: i64,
/// The amount that was accepted for this invoice, in millisatoshis. This will
/// ONLY be set if this invoice has been settled or accepted. 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.
/// Note: Output only, don't specify for creating an invoice.
#[prost(int64, tag = "20")]
pub amt_paid_msat: i64,
/// The state the invoice is in.
/// Note: Output only, don't specify for creating an invoice.
#[prost(enumeration = "invoice::InvoiceState", tag = "21")]
pub state: i32,
/// List of HTLCs paying to this invoice \[EXPERIMENTAL\].
/// Note: Output only, don't specify for creating an invoice.
#[prost(message, repeated, tag = "22")]
pub htlcs: ::prost::alloc::vec::Vec<InvoiceHtlc>,
/// List of features advertised on the invoice.
/// Note: Output only, don't specify for creating an invoice.
#[prost(map = "uint32, message", tag = "24")]
pub features: ::std::collections::HashMap<u32, Feature>,
/// Indicates if this invoice was a spontaneous payment that arrived via keysend
/// \[EXPERIMENTAL\].
/// Note: Output only, don't specify for creating an invoice.
#[prost(bool, tag = "25")]
pub is_keysend: bool,
/// The payment address of this invoice. This is also called payment secret in
/// specifications (e.g. BOLT 11). This value will be used in MPP payments, and
/// also for newer invoices that always require the MPP payload for added
/// end-to-end security.
/// Note: Output only, don't specify for creating an invoice.
#[prost(bytes = "vec", tag = "26")]
pub payment_addr: ::prost::alloc::vec::Vec<u8>,
/// Signals whether or not this is an AMP invoice.
#[prost(bool, tag = "27")]
pub is_amp: bool,
/// \[EXPERIMENTAL\]:
///
/// Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
/// given set ID. This field is always populated for AMP invoices, and can be
/// used along side LookupInvoice to obtain the HTLC information related to a
/// given sub-invoice.
/// Note: Output only, don't specify for creating an invoice.
#[prost(map = "string, message", tag = "28")]
pub amp_invoice_state: ::std::collections::HashMap<
::prost::alloc::string::String,
AmpInvoiceState,
>,
/// Signals that the invoice should include blinded paths to hide the true
/// identity of the recipient.
#[prost(bool, tag = "29")]
pub is_blinded: bool,
/// Config values to use when creating blinded paths for this invoice. These
/// can be used to override the defaults config values provided in by the
/// global config. This field is only used if is_blinded is true.
#[prost(message, optional, tag = "30")]
pub blinded_path_config: ::core::option::Option<BlindedPathConfig>,
}
/// Nested message and enum types in `Invoice`.
pub mod invoice {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum InvoiceState {
Open = 0,
Settled = 1,
Canceled = 2,
Accepted = 3,
}
impl InvoiceState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Open => "OPEN",
Self::Settled => "SETTLED",
Self::Canceled => "CANCELED",
Self::Accepted => "ACCEPTED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPEN" => Some(Self::Open),
"SETTLED" => Some(Self::Settled),
"CANCELED" => Some(Self::Canceled),
"ACCEPTED" => Some(Self::Accepted),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct BlindedPathConfig {
/// The minimum number of real hops to include in a blinded path. This doesn't
/// include our node, so if the minimum is 1, then the path will contain at
/// minimum our node along with an introduction node hop. If it is zero then
/// the shortest path will use our node as an introduction node.
#[prost(uint32, optional, tag = "1")]
pub min_num_real_hops: ::core::option::Option<u32>,
/// The number of hops to include in a blinded path. This doesn't include our
/// node, so if it is 1, then the path will contain our node along with an
/// introduction node or dummy node hop. If paths shorter than NumHops is
/// found, then they will be padded using dummy hops.
#[prost(uint32, optional, tag = "2")]
pub num_hops: ::core::option::Option<u32>,
/// The maximum number of blinded paths to select and add to an invoice.
#[prost(uint32, optional, tag = "3")]
pub max_num_paths: ::core::option::Option<u32>,
/// A list of node IDs of nodes that should not be used in any of our generated
/// blinded paths.
#[prost(bytes = "vec", repeated, tag = "4")]
pub node_omission_list: ::prost::alloc::vec::Vec<::prost::alloc::vec::Vec<u8>>,
/// The chained channels list specified via channel id (separated by commas),
/// starting from a channel owned by the receiver node.
#[prost(uint64, repeated, tag = "5")]
pub incoming_channel_list: ::prost::alloc::vec::Vec<u64>,
}
/// Details of an HTLC that paid to an invoice
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct InvoiceHtlc {
/// Short channel id over which the htlc was received.
#[prost(uint64, tag = "1")]
pub chan_id: u64,
/// Index identifying the htlc on the channel.
#[prost(uint64, tag = "2")]
pub htlc_index: u64,
/// The amount of the htlc in msat.
#[prost(uint64, tag = "3")]
pub amt_msat: u64,
/// Block height at which this htlc was accepted.
#[prost(int32, tag = "4")]
pub accept_height: i32,
/// Time at which this htlc was accepted.
#[prost(int64, tag = "5")]
pub accept_time: i64,
/// Time at which this htlc was settled or canceled.
#[prost(int64, tag = "6")]
pub resolve_time: i64,
/// Block height at which this htlc expires.
#[prost(int32, tag = "7")]
pub expiry_height: i32,
/// Current state the htlc is in.
#[prost(enumeration = "InvoiceHtlcState", tag = "8")]
pub state: i32,
/// Custom tlv records.
#[prost(map = "uint64, bytes", tag = "9")]
pub custom_records: ::std::collections::HashMap<u64, ::prost::alloc::vec::Vec<u8>>,
/// The total amount of the mpp payment in msat.
#[prost(uint64, tag = "10")]
pub mpp_total_amt_msat: u64,
/// Details relevant to AMP HTLCs, only populated if this is an AMP HTLC.
#[prost(message, optional, tag = "11")]
pub amp: ::core::option::Option<Amp>,
/// Custom channel data that might be populated in custom channels.
#[prost(bytes = "vec", tag = "12")]
pub custom_channel_data: ::prost::alloc::vec::Vec<u8>,
}
/// Details specific to AMP HTLCs.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Amp {
/// An n-of-n secret share of the root seed from which child payment hashes
/// and preimages are derived.
#[prost(bytes = "vec", tag = "1")]
pub root_share: ::prost::alloc::vec::Vec<u8>,
/// An identifier for the HTLC set that this HTLC belongs to.
#[prost(bytes = "vec", tag = "2")]
pub set_id: ::prost::alloc::vec::Vec<u8>,
/// A nonce used to randomize the child preimage and child hash from a given
/// root_share.
#[prost(uint32, tag = "3")]
pub child_index: u32,
/// The payment hash of the AMP HTLC.
#[prost(bytes = "vec", tag = "4")]
pub hash: ::prost::alloc::vec::Vec<u8>,
/// The preimage used to settle this AMP htlc. This field will only be
/// populated if the invoice is in InvoiceState_ACCEPTED or
/// InvoiceState_SETTLED.
#[prost(bytes = "vec", tag = "5")]
pub preimage: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AddInvoiceResponse {
#[prost(bytes = "vec", tag = "1")]
pub r_hash: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(string, tag = "2")]
pub payment_request: ::prost::alloc::string::String,
/// 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.
#[prost(uint64, tag = "16")]
pub add_index: u64,
/// The payment address of the generated invoice. This is also called
/// payment secret in specifications (e.g. BOLT 11). This value should be used
/// in all payments for this invoice as we require it for end to end security.
#[prost(bytes = "vec", tag = "17")]
pub payment_addr: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[deprecated]
#[prost(string, tag = "1")]
pub r_hash_str: ::prost::alloc::string::String,
/// The payment hash of the invoice to be looked up. When using REST, this field
/// must be encoded as base64.
#[prost(bytes = "vec", tag = "2")]
pub r_hash: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListInvoiceRequest {
/// If set, only invoices that are not settled and not canceled will be returned
/// in the response.
#[prost(bool, tag = "1")]
pub pending_only: bool,
/// 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.
#[prost(uint64, tag = "4")]
pub index_offset: u64,
/// The max number of invoices to return in the response to this query.
#[prost(uint64, tag = "5")]
pub num_max_invoices: u64,
/// If set, the invoices returned will result from seeking backwards from the
/// specified index offset. This can be used to paginate backwards.
#[prost(bool, tag = "6")]
pub reversed: bool,
/// If set, returns all invoices with a creation date greater than or equal
/// to it. Measured in seconds since the unix epoch.
#[prost(uint64, tag = "7")]
pub creation_date_start: u64,
/// If set, returns all invoices with a creation date less than or equal to
/// it. Measured in seconds since the unix epoch.
#[prost(uint64, tag = "8")]
pub creation_date_end: u64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListInvoiceResponse {
/// A list of invoices from the time slice of the time series specified in the
/// request.
#[prost(message, repeated, tag = "1")]
pub invoices: ::prost::alloc::vec::Vec<Invoice>,
/// The index of the last item in the set of returned invoices. This can be used
/// to seek further, pagination style.
#[prost(uint64, tag = "2")]
pub last_index_offset: u64,
/// The index of the last item in the set of returned invoices. This can be used
/// to seek backwards, pagination style.
#[prost(uint64, tag = "3")]
pub first_index_offset: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub add_index: u64,
/// 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.
#[prost(uint64, tag = "2")]
pub settle_index: u64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DelCanceledInvoiceReq {
/// Invoice payment hash to delete.
#[prost(string, tag = "1")]
pub invoice_hash: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DelCanceledInvoiceResp {
/// The status of the delete operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payment {
/// The payment hash
#[prost(string, tag = "1")]
pub payment_hash: ::prost::alloc::string::String,
/// Deprecated, use value_sat or value_msat.
#[deprecated]
#[prost(int64, tag = "2")]
pub value: i64,
/// Deprecated, use creation_time_ns
#[deprecated]
#[prost(int64, tag = "3")]
pub creation_date: i64,
/// Deprecated, use fee_sat or fee_msat.
#[deprecated]
#[prost(int64, tag = "5")]
pub fee: i64,
/// The payment preimage
#[prost(string, tag = "6")]
pub payment_preimage: ::prost::alloc::string::String,
/// The value of the payment in satoshis
#[prost(int64, tag = "7")]
pub value_sat: i64,
/// The value of the payment in milli-satoshis
#[prost(int64, tag = "8")]
pub value_msat: i64,
/// The optional payment request being fulfilled.
#[prost(string, tag = "9")]
pub payment_request: ::prost::alloc::string::String,
/// The status of the payment.
#[prost(enumeration = "payment::PaymentStatus", tag = "10")]
pub status: i32,
/// The fee paid for this payment in satoshis
#[prost(int64, tag = "11")]
pub fee_sat: i64,
/// The fee paid for this payment in milli-satoshis
#[prost(int64, tag = "12")]
pub fee_msat: i64,
/// The time in UNIX nanoseconds at which the payment was created.
#[prost(int64, tag = "13")]
pub creation_time_ns: i64,
/// The HTLCs made in attempt to settle the payment.
#[prost(message, repeated, tag = "14")]
pub htlcs: ::prost::alloc::vec::Vec<HtlcAttempt>,
/// 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.
#[prost(uint64, tag = "15")]
pub payment_index: u64,
#[prost(enumeration = "PaymentFailureReason", tag = "16")]
pub failure_reason: i32,
/// The custom TLV records that were sent to the first hop as part of the HTLC
/// wire message for this payment.
#[prost(map = "uint64, bytes", tag = "17")]
pub first_hop_custom_records: ::std::collections::HashMap<
u64,
::prost::alloc::vec::Vec<u8>,
>,
}
/// Nested message and enum types in `Payment`.
pub mod payment {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum PaymentStatus {
/// Deprecated. This status will never be returned.
#[deprecated]
Unknown = 0,
/// Payment has inflight HTLCs.
InFlight = 1,
/// Payment is settled.
Succeeded = 2,
/// Payment is failed.
Failed = 3,
/// Payment is created and has not attempted any HTLCs.
Initiated = 4,
}
impl PaymentStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
#[allow(deprecated)]
Self::Unknown => "UNKNOWN",
Self::InFlight => "IN_FLIGHT",
Self::Succeeded => "SUCCEEDED",
Self::Failed => "FAILED",
Self::Initiated => "INITIATED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN" => Some(#[allow(deprecated)] Self::Unknown),
"IN_FLIGHT" => Some(Self::InFlight),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
"INITIATED" => Some(Self::Initiated),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HtlcAttempt {
/// The unique ID that is used for this attempt.
#[prost(uint64, tag = "7")]
pub attempt_id: u64,
/// The status of the HTLC.
#[prost(enumeration = "htlc_attempt::HtlcStatus", tag = "1")]
pub status: i32,
/// The route taken by this HTLC.
#[prost(message, optional, tag = "2")]
pub route: ::core::option::Option<Route>,
/// The time in UNIX nanoseconds at which this HTLC was sent.
#[prost(int64, tag = "3")]
pub attempt_time_ns: i64,
/// 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.
#[prost(int64, tag = "4")]
pub resolve_time_ns: i64,
/// Detailed htlc failure info.
#[prost(message, optional, tag = "5")]
pub failure: ::core::option::Option<Failure>,
/// The preimage that was used to settle the HTLC.
#[prost(bytes = "vec", tag = "6")]
pub preimage: ::prost::alloc::vec::Vec<u8>,
}
/// Nested message and enum types in `HTLCAttempt`.
pub mod htlc_attempt {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HtlcStatus {
InFlight = 0,
Succeeded = 1,
Failed = 2,
}
impl HtlcStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::InFlight => "IN_FLIGHT",
Self::Succeeded => "SUCCEEDED",
Self::Failed => "FAILED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"IN_FLIGHT" => Some(Self::InFlight),
"SUCCEEDED" => Some(Self::Succeeded),
"FAILED" => Some(Self::Failed),
_ => None,
}
}
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(bool, tag = "1")]
pub include_incomplete: bool,
/// 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.
#[prost(uint64, tag = "2")]
pub index_offset: u64,
/// The maximal number of payments returned in the response to this query.
#[prost(uint64, tag = "3")]
pub max_payments: u64,
/// 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).
#[prost(bool, tag = "4")]
pub reversed: bool,
/// If set, all payments (complete and incomplete, independent of the
/// max_payments parameter) will be counted. Note that setting this to true will
/// increase the run time of the call significantly on systems that have a lot
/// of payments, as all of them have to be iterated through to be counted.
#[prost(bool, tag = "5")]
pub count_total_payments: bool,
/// If set, returns all payments with a creation date greater than or equal
/// to it. Measured in seconds since the unix epoch.
#[prost(uint64, tag = "6")]
pub creation_date_start: u64,
/// If set, returns all payments with a creation date less than or equal to
/// it. Measured in seconds since the unix epoch.
#[prost(uint64, tag = "7")]
pub creation_date_end: u64,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPaymentsResponse {
/// The list of payments
#[prost(message, repeated, tag = "1")]
pub payments: ::prost::alloc::vec::Vec<Payment>,
/// 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.
#[prost(uint64, tag = "2")]
pub first_index_offset: u64,
/// 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.
#[prost(uint64, tag = "3")]
pub last_index_offset: u64,
/// Will only be set if count_total_payments in the request was set. Represents
/// the total number of payments (complete and incomplete, independent of the
/// number of payments requested in the query) currently present in the payments
/// database.
#[prost(uint64, tag = "4")]
pub total_num_payments: u64,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeletePaymentRequest {
/// Payment hash to delete.
#[prost(bytes = "vec", tag = "1")]
pub payment_hash: ::prost::alloc::vec::Vec<u8>,
/// Only delete failed HTLCs from the payment, not the payment itself.
#[prost(bool, tag = "2")]
pub failed_htlcs_only: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeleteAllPaymentsRequest {
/// Only delete failed payments.
#[prost(bool, tag = "1")]
pub failed_payments_only: bool,
/// Only delete failed HTLCs from payments, not the payment itself.
#[prost(bool, tag = "2")]
pub failed_htlcs_only: bool,
/// Delete all payments. NOTE: Using this option requires careful
/// consideration as it is a destructive operation.
#[prost(bool, tag = "3")]
pub all_payments: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeletePaymentResponse {
/// The status of the delete operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeleteAllPaymentsResponse {
/// The status of the delete operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AbandonChannelRequest {
#[prost(message, optional, tag = "1")]
pub channel_point: ::core::option::Option<ChannelPoint>,
#[prost(bool, tag = "2")]
pub pending_funding_shim_only: bool,
/// Override the requirement for being in dev mode by setting this to true and
/// confirming the user knows what they are doing and this is a potential foot
/// gun to lose funds if used on active channels.
#[prost(bool, tag = "3")]
pub i_know_what_i_am_doing: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct AbandonChannelResponse {
/// The status of the abandon operation.
#[prost(string, tag = "1")]
pub status: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DebugLevelRequest {
#[prost(bool, tag = "1")]
pub show: bool,
#[prost(string, tag = "2")]
pub level_spec: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DebugLevelResponse {
#[prost(string, tag = "1")]
pub sub_systems: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct PayReqString {
/// The payment request string to be decoded
#[prost(string, tag = "1")]
pub pay_req: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PayReq {
#[prost(string, tag = "1")]
pub destination: ::prost::alloc::string::String,
#[prost(string, tag = "2")]
pub payment_hash: ::prost::alloc::string::String,
#[prost(int64, tag = "3")]
pub num_satoshis: i64,
#[prost(int64, tag = "4")]
pub timestamp: i64,
#[prost(int64, tag = "5")]
pub expiry: i64,
#[prost(string, tag = "6")]
pub description: ::prost::alloc::string::String,
#[prost(string, tag = "7")]
pub description_hash: ::prost::alloc::string::String,
#[prost(string, tag = "8")]
pub fallback_addr: ::prost::alloc::string::String,
#[prost(int64, tag = "9")]
pub cltv_expiry: i64,
#[prost(message, repeated, tag = "10")]
pub route_hints: ::prost::alloc::vec::Vec<RouteHint>,
#[prost(bytes = "vec", tag = "11")]
pub payment_addr: ::prost::alloc::vec::Vec<u8>,
#[prost(int64, tag = "12")]
pub num_msat: i64,
#[prost(map = "uint32, message", tag = "13")]
pub features: ::std::collections::HashMap<u32, Feature>,
#[prost(message, repeated, tag = "14")]
pub blinded_paths: ::prost::alloc::vec::Vec<BlindedPaymentPath>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Feature {
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
#[prost(bool, tag = "3")]
pub is_required: bool,
#[prost(bool, tag = "4")]
pub is_known: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FeeReportRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelFeeReport {
/// The short channel id that this fee report belongs to.
#[prost(uint64, tag = "5")]
pub chan_id: u64,
/// The channel that this fee report belongs to.
#[prost(string, tag = "1")]
pub channel_point: ::prost::alloc::string::String,
/// The base fee charged regardless of the number of milli-satoshis sent.
#[prost(int64, tag = "2")]
pub base_fee_msat: i64,
/// The amount charged per milli-satoshis transferred expressed in
/// millionths of a satoshi.
#[prost(int64, tag = "3")]
pub fee_per_mil: i64,
/// The effective fee rate in milli-satoshis. Computed by dividing the
/// fee_per_mil value by 1 million.
#[prost(double, tag = "4")]
pub fee_rate: f64,
/// The base fee charged regardless of the number of milli-satoshis sent.
#[prost(int32, tag = "6")]
pub inbound_base_fee_msat: i32,
/// The amount charged per milli-satoshis transferred expressed in
/// millionths of a satoshi.
#[prost(int32, tag = "7")]
pub inbound_fee_per_mil: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeeReportResponse {
/// An array of channel fee reports which describes the current fee schedule
/// for each channel.
#[prost(message, repeated, tag = "1")]
pub channel_fees: ::prost::alloc::vec::Vec<ChannelFeeReport>,
/// The total amount of fee revenue (in satoshis) the switch has collected
/// over the past 24 hrs.
#[prost(uint64, tag = "2")]
pub day_fee_sum: u64,
/// The total amount of fee revenue (in satoshis) the switch has collected
/// over the past 1 week.
#[prost(uint64, tag = "3")]
pub week_fee_sum: u64,
/// The total amount of fee revenue (in satoshis) the switch has collected
/// over the past 1 month.
#[prost(uint64, tag = "4")]
pub month_fee_sum: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct InboundFee {
/// The inbound base fee charged regardless of the number of milli-satoshis
/// received in the channel. By default, only negative values are accepted.
#[prost(int32, tag = "1")]
pub base_fee_msat: i32,
/// The effective inbound fee rate in micro-satoshis (parts per million).
/// By default, only negative values are accepted.
#[prost(int32, tag = "2")]
pub fee_rate_ppm: i32,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PolicyUpdateRequest {
/// The base fee charged regardless of the number of milli-satoshis sent.
#[prost(int64, tag = "3")]
pub base_fee_msat: i64,
/// The effective fee rate in milli-satoshis. The precision of this value
/// goes up to 6 decimal places, so 1e-6.
#[prost(double, tag = "4")]
pub fee_rate: f64,
/// The effective fee rate in micro-satoshis (parts per million).
#[prost(uint32, tag = "9")]
pub fee_rate_ppm: u32,
/// The required timelock delta for HTLCs forwarded over the channel.
#[prost(uint32, tag = "5")]
pub time_lock_delta: u32,
/// If set, the maximum HTLC size in milli-satoshis. If unset, the maximum
/// HTLC will be unchanged.
#[prost(uint64, tag = "6")]
pub max_htlc_msat: u64,
/// The minimum HTLC size in milli-satoshis. Only applied if
/// min_htlc_msat_specified is true.
#[prost(uint64, tag = "7")]
pub min_htlc_msat: u64,
/// If true, min_htlc_msat is applied.
#[prost(bool, tag = "8")]
pub min_htlc_msat_specified: bool,
/// Optional inbound fee. If unset, the previously set value will be
/// retained \[EXPERIMENTAL\].
#[prost(message, optional, tag = "10")]
pub inbound_fee: ::core::option::Option<InboundFee>,
/// Under unknown circumstances a channel can exist with a missing edge in
/// the graph database. This can cause an 'edge not found' error when calling
/// `getchaninfo` and/or cause the default channel policy to be used during
/// forwards. Setting this flag will recreate the edge if not found, allowing
/// updating this channel policy and fixing the missing edge problem for this
/// channel permanently. For fields not set in this command, the default
/// policy will be created.
#[prost(bool, tag = "11")]
pub create_missing_edge: bool,
#[prost(oneof = "policy_update_request::Scope", tags = "1, 2")]
pub scope: ::core::option::Option<policy_update_request::Scope>,
}
/// Nested message and enum types in `PolicyUpdateRequest`.
pub mod policy_update_request {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum Scope {
/// If set, then this update applies to all currently active channels.
#[prost(bool, tag = "1")]
Global(bool),
/// If set, this update will target a specific channel.
#[prost(message, tag = "2")]
ChanPoint(super::ChannelPoint),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct FailedUpdate {
/// The outpoint in format txid:n
#[prost(message, optional, tag = "1")]
pub outpoint: ::core::option::Option<OutPoint>,
/// Reason for the policy update failure.
#[prost(enumeration = "UpdateFailure", tag = "2")]
pub reason: i32,
/// A string representation of the policy update error.
#[prost(string, tag = "3")]
pub update_error: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PolicyUpdateResponse {
/// List of failed policy updates.
#[prost(message, repeated, tag = "1")]
pub failed_updates: ::prost::alloc::vec::Vec<FailedUpdate>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct 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.
#[prost(uint64, tag = "1")]
pub start_time: u64,
/// 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.
#[prost(uint64, tag = "2")]
pub end_time: u64,
/// 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.
#[prost(uint32, tag = "3")]
pub index_offset: u32,
/// The max number of events to return in the response to this query.
#[prost(uint32, tag = "4")]
pub num_max_events: u32,
/// Informs the server if the peer alias should be looked up for each
/// forwarding event.
#[prost(bool, tag = "5")]
pub peer_alias_lookup: bool,
/// List of incoming channel ids to filter htlcs received from a
/// particular channel
#[prost(uint64, repeated, tag = "6")]
pub incoming_chan_ids: ::prost::alloc::vec::Vec<u64>,
/// List of outgoing channel ids to filter htlcs being forwarded to a
/// particular channel
#[prost(uint64, repeated, tag = "7")]
pub outgoing_chan_ids: ::prost::alloc::vec::Vec<u64>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ForwardingEvent {
/// Timestamp is the time (unix epoch offset) that this circuit was
/// completed. Deprecated by timestamp_ns.
#[deprecated]
#[prost(uint64, tag = "1")]
pub timestamp: u64,
/// The incoming channel ID that carried the HTLC that created the circuit.
#[prost(uint64, tag = "2")]
pub chan_id_in: u64,
/// The outgoing channel ID that carried the preimage that completed the
/// circuit.
#[prost(uint64, tag = "4")]
pub chan_id_out: u64,
/// The total amount (in satoshis) of the incoming HTLC that created half
/// the circuit.
#[prost(uint64, tag = "5")]
pub amt_in: u64,
/// The total amount (in satoshis) of the outgoing HTLC that created the
/// second half of the circuit.
#[prost(uint64, tag = "6")]
pub amt_out: u64,
/// The total fee (in satoshis) that this payment circuit carried.
#[prost(uint64, tag = "7")]
pub fee: u64,
/// The total fee (in milli-satoshis) that this payment circuit carried.
#[prost(uint64, tag = "8")]
pub fee_msat: u64,
/// The total amount (in milli-satoshis) of the incoming HTLC that created
/// half the circuit.
#[prost(uint64, tag = "9")]
pub amt_in_msat: u64,
/// The total amount (in milli-satoshis) of the outgoing HTLC that created
/// the second half of the circuit.
#[prost(uint64, tag = "10")]
pub amt_out_msat: u64,
/// The number of nanoseconds elapsed since January 1, 1970 UTC when this
/// circuit was completed.
#[prost(uint64, tag = "11")]
pub timestamp_ns: u64,
/// The peer alias of the incoming channel.
#[prost(string, tag = "12")]
pub peer_alias_in: ::prost::alloc::string::String,
/// The peer alias of the outgoing channel.
#[prost(string, tag = "13")]
pub peer_alias_out: ::prost::alloc::string::String,
/// The ID of the incoming HTLC in the payment circuit. This field is
/// optional and is unset for forwarding events happened before v0.20.
#[prost(uint64, optional, tag = "14")]
pub incoming_htlc_id: ::core::option::Option<u64>,
/// The ID of the outgoing HTLC in the payment circuit. This field is
/// optional and may be unset for legacy forwarding events.
#[prost(uint64, optional, tag = "15")]
pub outgoing_htlc_id: ::core::option::Option<u64>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ForwardingHistoryResponse {
/// A list of forwarding events from the time slice of the time series
/// specified in the request.
#[prost(message, repeated, tag = "1")]
pub forwarding_events: ::prost::alloc::vec::Vec<ForwardingEvent>,
/// The index of the last time in the set of returned forwarding events. Can
/// be used to seek further, pagination style.
#[prost(uint32, tag = "2")]
pub last_offset_index: u32,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ExportChannelBackupRequest {
/// The target channel point to obtain a back up for.
#[prost(message, optional, tag = "1")]
pub chan_point: ::core::option::Option<ChannelPoint>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelBackup {
/// Identifies the channel that this backup belongs to.
#[prost(message, optional, tag = "1")]
pub chan_point: ::core::option::Option<ChannelPoint>,
/// 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.
#[prost(bytes = "vec", tag = "2")]
pub chan_backup: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MultiChanBackup {
/// Is the set of all channels that are included in this multi-channel backup.
#[prost(message, repeated, tag = "1")]
pub chan_points: ::prost::alloc::vec::Vec<ChannelPoint>,
/// 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.
#[prost(bytes = "vec", tag = "2")]
pub multi_chan_backup: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChanBackupExportRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChanBackupSnapshot {
/// The set of new channels that have been added since the last channel backup
/// snapshot was requested.
#[prost(message, optional, tag = "1")]
pub single_chan_backups: ::core::option::Option<ChannelBackups>,
/// A multi-channel backup that covers all open channels currently known to
/// lnd.
#[prost(message, optional, tag = "2")]
pub multi_chan_backup: ::core::option::Option<MultiChanBackup>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelBackups {
/// A set of single-chan static channel backups.
#[prost(message, repeated, tag = "1")]
pub chan_backups: ::prost::alloc::vec::Vec<ChannelBackup>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RestoreChanBackupRequest {
#[prost(oneof = "restore_chan_backup_request::Backup", tags = "1, 2")]
pub backup: ::core::option::Option<restore_chan_backup_request::Backup>,
}
/// Nested message and enum types in `RestoreChanBackupRequest`.
pub mod restore_chan_backup_request {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Backup {
/// The channels to restore as a list of channel/backup pairs.
#[prost(message, tag = "1")]
ChanBackups(super::ChannelBackups),
/// The channels to restore in the packed multi backup format. When using
/// REST, this field must be encoded as base64.
#[prost(bytes, tag = "2")]
MultiChanBackup(::prost::alloc::vec::Vec<u8>),
}
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct RestoreBackupResponse {
/// The number of channels successfully restored.
#[prost(uint32, tag = "1")]
pub num_restored: u32,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelBackupSubscription {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct VerifyChanBackupResponse {
#[prost(string, repeated, tag = "1")]
pub chan_points: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct MacaroonPermission {
/// The entity a permission grants access to.
#[prost(string, tag = "1")]
pub entity: ::prost::alloc::string::String,
/// The action that is granted.
#[prost(string, tag = "2")]
pub action: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BakeMacaroonRequest {
/// The list of permissions the new macaroon should grant.
#[prost(message, repeated, tag = "1")]
pub permissions: ::prost::alloc::vec::Vec<MacaroonPermission>,
/// The root key ID used to create the macaroon, must be a positive integer.
#[prost(uint64, tag = "2")]
pub root_key_id: u64,
/// Informs the RPC on whether to allow external permissions that LND is not
/// aware of.
#[prost(bool, tag = "3")]
pub allow_external_permissions: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct BakeMacaroonResponse {
/// The hex encoded macaroon, serialized in binary format.
#[prost(string, tag = "1")]
pub macaroon: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListMacaroonIDsRequest {}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListMacaroonIDsResponse {
/// The list of root key IDs that are in use.
#[prost(uint64, repeated, tag = "1")]
pub root_key_ids: ::prost::alloc::vec::Vec<u64>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeleteMacaroonIdRequest {
/// The root key ID to be removed.
#[prost(uint64, tag = "1")]
pub root_key_id: u64,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeleteMacaroonIdResponse {
/// A boolean indicates that the deletion is successful.
#[prost(bool, tag = "1")]
pub deleted: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MacaroonPermissionList {
/// A list of macaroon permissions.
#[prost(message, repeated, tag = "1")]
pub permissions: ::prost::alloc::vec::Vec<MacaroonPermission>,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListPermissionsRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPermissionsResponse {
/// A map between all RPC method URIs and their required macaroon permissions to
/// access them.
#[prost(map = "string, message", tag = "1")]
pub method_permissions: ::std::collections::HashMap<
::prost::alloc::string::String,
MacaroonPermissionList,
>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Failure {
/// Failure code as defined in the Lightning spec
#[prost(enumeration = "failure::FailureCode", tag = "1")]
pub code: i32,
/// An optional channel update message.
#[prost(message, optional, tag = "3")]
pub channel_update: ::core::option::Option<ChannelUpdate>,
/// A failure type-dependent htlc value.
#[prost(uint64, tag = "4")]
pub htlc_msat: u64,
/// The sha256 sum of the onion payload.
#[prost(bytes = "vec", tag = "5")]
pub onion_sha_256: ::prost::alloc::vec::Vec<u8>,
/// A failure type-dependent cltv expiry value.
#[prost(uint32, tag = "6")]
pub cltv_expiry: u32,
/// A failure type-dependent flags value.
#[prost(uint32, tag = "7")]
pub flags: u32,
/// The position in the path of the intermediate or final node that generated
/// the failure message. Position zero is the sender node.
#[prost(uint32, tag = "8")]
pub failure_source_index: u32,
/// A failure type-dependent block height.
#[prost(uint32, tag = "9")]
pub height: u32,
}
/// Nested message and enum types in `Failure`.
pub mod failure {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub 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,
IncorrectOrUnknownPaymentDetails = 1,
IncorrectPaymentAmount = 2,
FinalIncorrectCltvExpiry = 3,
FinalIncorrectHtlcAmount = 4,
FinalExpiryTooSoon = 5,
InvalidRealm = 6,
ExpiryTooSoon = 7,
InvalidOnionVersion = 8,
InvalidOnionHmac = 9,
InvalidOnionKey = 10,
AmountBelowMinimum = 11,
FeeInsufficient = 12,
IncorrectCltvExpiry = 13,
ChannelDisabled = 14,
TemporaryChannelFailure = 15,
RequiredNodeFeatureMissing = 16,
RequiredChannelFeatureMissing = 17,
UnknownNextPeer = 18,
TemporaryNodeFailure = 19,
PermanentNodeFailure = 20,
PermanentChannelFailure = 21,
ExpiryTooFar = 22,
MppTimeout = 23,
InvalidOnionPayload = 24,
InvalidOnionBlinding = 25,
/// An internal error occurred.
InternalFailure = 997,
/// The error source is known, but the failure itself couldn't be decoded.
UnknownFailure = 998,
/// An unreadable failure result is returned if the received failure message
/// cannot be decrypted. In that case the error source is unknown.
UnreadableFailure = 999,
}
impl FailureCode {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Reserved => "RESERVED",
Self::IncorrectOrUnknownPaymentDetails => {
"INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS"
}
Self::IncorrectPaymentAmount => "INCORRECT_PAYMENT_AMOUNT",
Self::FinalIncorrectCltvExpiry => "FINAL_INCORRECT_CLTV_EXPIRY",
Self::FinalIncorrectHtlcAmount => "FINAL_INCORRECT_HTLC_AMOUNT",
Self::FinalExpiryTooSoon => "FINAL_EXPIRY_TOO_SOON",
Self::InvalidRealm => "INVALID_REALM",
Self::ExpiryTooSoon => "EXPIRY_TOO_SOON",
Self::InvalidOnionVersion => "INVALID_ONION_VERSION",
Self::InvalidOnionHmac => "INVALID_ONION_HMAC",
Self::InvalidOnionKey => "INVALID_ONION_KEY",
Self::AmountBelowMinimum => "AMOUNT_BELOW_MINIMUM",
Self::FeeInsufficient => "FEE_INSUFFICIENT",
Self::IncorrectCltvExpiry => "INCORRECT_CLTV_EXPIRY",
Self::ChannelDisabled => "CHANNEL_DISABLED",
Self::TemporaryChannelFailure => "TEMPORARY_CHANNEL_FAILURE",
Self::RequiredNodeFeatureMissing => "REQUIRED_NODE_FEATURE_MISSING",
Self::RequiredChannelFeatureMissing => "REQUIRED_CHANNEL_FEATURE_MISSING",
Self::UnknownNextPeer => "UNKNOWN_NEXT_PEER",
Self::TemporaryNodeFailure => "TEMPORARY_NODE_FAILURE",
Self::PermanentNodeFailure => "PERMANENT_NODE_FAILURE",
Self::PermanentChannelFailure => "PERMANENT_CHANNEL_FAILURE",
Self::ExpiryTooFar => "EXPIRY_TOO_FAR",
Self::MppTimeout => "MPP_TIMEOUT",
Self::InvalidOnionPayload => "INVALID_ONION_PAYLOAD",
Self::InvalidOnionBlinding => "INVALID_ONION_BLINDING",
Self::InternalFailure => "INTERNAL_FAILURE",
Self::UnknownFailure => "UNKNOWN_FAILURE",
Self::UnreadableFailure => "UNREADABLE_FAILURE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"RESERVED" => Some(Self::Reserved),
"INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS" => {
Some(Self::IncorrectOrUnknownPaymentDetails)
}
"INCORRECT_PAYMENT_AMOUNT" => Some(Self::IncorrectPaymentAmount),
"FINAL_INCORRECT_CLTV_EXPIRY" => Some(Self::FinalIncorrectCltvExpiry),
"FINAL_INCORRECT_HTLC_AMOUNT" => Some(Self::FinalIncorrectHtlcAmount),
"FINAL_EXPIRY_TOO_SOON" => Some(Self::FinalExpiryTooSoon),
"INVALID_REALM" => Some(Self::InvalidRealm),
"EXPIRY_TOO_SOON" => Some(Self::ExpiryTooSoon),
"INVALID_ONION_VERSION" => Some(Self::InvalidOnionVersion),
"INVALID_ONION_HMAC" => Some(Self::InvalidOnionHmac),
"INVALID_ONION_KEY" => Some(Self::InvalidOnionKey),
"AMOUNT_BELOW_MINIMUM" => Some(Self::AmountBelowMinimum),
"FEE_INSUFFICIENT" => Some(Self::FeeInsufficient),
"INCORRECT_CLTV_EXPIRY" => Some(Self::IncorrectCltvExpiry),
"CHANNEL_DISABLED" => Some(Self::ChannelDisabled),
"TEMPORARY_CHANNEL_FAILURE" => Some(Self::TemporaryChannelFailure),
"REQUIRED_NODE_FEATURE_MISSING" => Some(Self::RequiredNodeFeatureMissing),
"REQUIRED_CHANNEL_FEATURE_MISSING" => {
Some(Self::RequiredChannelFeatureMissing)
}
"UNKNOWN_NEXT_PEER" => Some(Self::UnknownNextPeer),
"TEMPORARY_NODE_FAILURE" => Some(Self::TemporaryNodeFailure),
"PERMANENT_NODE_FAILURE" => Some(Self::PermanentNodeFailure),
"PERMANENT_CHANNEL_FAILURE" => Some(Self::PermanentChannelFailure),
"EXPIRY_TOO_FAR" => Some(Self::ExpiryTooFar),
"MPP_TIMEOUT" => Some(Self::MppTimeout),
"INVALID_ONION_PAYLOAD" => Some(Self::InvalidOnionPayload),
"INVALID_ONION_BLINDING" => Some(Self::InvalidOnionBlinding),
"INTERNAL_FAILURE" => Some(Self::InternalFailure),
"UNKNOWN_FAILURE" => Some(Self::UnknownFailure),
"UNREADABLE_FAILURE" => Some(Self::UnreadableFailure),
_ => None,
}
}
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ChannelUpdate {
/// The signature that validates the announced data and proves the ownership
/// of node id.
#[prost(bytes = "vec", tag = "1")]
pub signature: ::prost::alloc::vec::Vec<u8>,
/// 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.
#[prost(bytes = "vec", tag = "2")]
pub chain_hash: ::prost::alloc::vec::Vec<u8>,
/// The unique description of the funding transaction.
#[prost(uint64, tag = "3")]
pub chan_id: u64,
/// 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.
#[prost(uint32, tag = "4")]
pub timestamp: u32,
/// 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.
#[prost(uint32, tag = "10")]
pub message_flags: u32,
/// 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.
#[prost(uint32, tag = "5")]
pub channel_flags: u32,
/// 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.
#[prost(uint32, tag = "6")]
pub time_lock_delta: u32,
/// The minimum HTLC value which will be accepted.
#[prost(uint64, tag = "7")]
pub htlc_minimum_msat: u64,
/// 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.
#[prost(uint32, tag = "8")]
pub base_fee: u32,
/// The fee rate that will be charged per millionth of a satoshi.
#[prost(uint32, tag = "9")]
pub fee_rate: u32,
/// The maximum HTLC value which will be accepted.
#[prost(uint64, tag = "11")]
pub htlc_maximum_msat: u64,
/// 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.
#[prost(bytes = "vec", tag = "12")]
pub extra_opaque_data: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MacaroonId {
#[prost(bytes = "vec", tag = "1")]
pub nonce: ::prost::alloc::vec::Vec<u8>,
#[prost(bytes = "vec", tag = "2")]
pub storage_id: ::prost::alloc::vec::Vec<u8>,
#[prost(message, repeated, tag = "3")]
pub ops: ::prost::alloc::vec::Vec<Op>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Op {
#[prost(string, tag = "1")]
pub entity: ::prost::alloc::string::String,
#[prost(string, repeated, tag = "2")]
pub actions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CheckMacPermRequest {
/// The macaroon to check permissions for, serialized in binary format. For
/// a macaroon to be valid, it must have been issued by lnd, must succeed all
/// caveat conditions, and must contain all of the permissions specified in
/// the permissions field.
#[prost(bytes = "vec", tag = "1")]
pub macaroon: ::prost::alloc::vec::Vec<u8>,
/// The list of permissions the macaroon should be checked against. Only if
/// the macaroon contains all of these permissions, it is considered valid.
/// If the list of permissions given is empty, then the macaroon is
/// considered valid only based on issuance authority and caveat validity.
/// An empty list of permissions is therefore equivalent to saying "skip
/// checking permissions" (unless check_default_perms_from_full_method is
/// specified).
#[prost(message, repeated, tag = "2")]
pub permissions: ::prost::alloc::vec::Vec<MacaroonPermission>,
/// The RPC method to check the macaroon against. This is only used if there
/// are custom `uri:<rpcpackage>.<ServiceName>/<MethodName>` permissions in
/// the permission list above. To check a macaroon against the list of
/// permissions of a certain RPC method, query the `ListPermissions` RPC
/// first, extract the permissions for the method, and then pass them in the
/// `permissions` field above.
#[prost(string, tag = "3")]
pub full_method: ::prost::alloc::string::String,
/// If this field is set to true, then the permissions list above MUST be
/// empty. The default permissions for the provided fullMethod will be used
/// to check the macaroon. This is equivalent to looking up the permissions
/// for a method in the `ListPermissions` RPC and then calling this RPC with
/// the permission list returned from that call. Without this flag, the list
/// of permissions must be non-empty for the check to actually perform a
/// permission check.
#[prost(bool, tag = "4")]
pub check_default_perms_from_full_method: bool,
}
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct CheckMacPermResponse {
#[prost(bool, tag = "1")]
pub valid: bool,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RpcMiddlewareRequest {
/// The unique ID of the intercepted original gRPC request. Useful for mapping
/// request to response when implementing full duplex message interception. For
/// streaming requests, this will be the same ID for all incoming and outgoing
/// middleware intercept messages of the *same* stream.
#[prost(uint64, tag = "1")]
pub request_id: u64,
/// The raw bytes of the complete macaroon as sent by the gRPC client in the
/// original request. This might be empty for a request that doesn't require
/// macaroons such as the wallet unlocker RPCs.
#[prost(bytes = "vec", tag = "2")]
pub raw_macaroon: ::prost::alloc::vec::Vec<u8>,
/// The parsed condition of the macaroon's custom caveat for convenient access.
/// This field only contains the value of the custom caveat that the handling
/// middleware has registered itself for. The condition *must* be validated for
/// messages of intercept_type stream_auth and request!
#[prost(string, tag = "3")]
pub custom_caveat_condition: ::prost::alloc::string::String,
/// The unique message ID of this middleware intercept message. There can be
/// multiple middleware intercept messages per single gRPC request (one for the
/// incoming request and one for the outgoing response) or gRPC stream (one for
/// each incoming message and one for each outgoing response). This message ID
/// must be referenced when responding (accepting/rejecting/modifying) to an
/// intercept message.
#[prost(uint64, tag = "7")]
pub msg_id: u64,
/// The metadata pairs that were sent along with the original gRPC request via
/// the golang context.Context using explicit [gRPC
/// metadata](<https://grpc.io/docs/guides/metadata/>). Context values are not
/// propagated via gRPC and so we send any pairs along explicitly here so that
/// the interceptor can access them.
#[prost(map = "string, message", tag = "9")]
pub metadata_pairs: ::std::collections::HashMap<
::prost::alloc::string::String,
MetadataValues,
>,
/// There are three types of messages that will be sent to the middleware for
/// inspection and approval: Stream authentication, request and response
/// interception. The first two can only be accepted (=forward to main RPC
/// server) or denied (=return error to client). Intercepted responses can also
/// be replaced/overwritten.
#[prost(oneof = "rpc_middleware_request::InterceptType", tags = "4, 5, 6, 8")]
pub intercept_type: ::core::option::Option<rpc_middleware_request::InterceptType>,
}
/// Nested message and enum types in `RPCMiddlewareRequest`.
pub mod rpc_middleware_request {
/// There are three types of messages that will be sent to the middleware for
/// inspection and approval: Stream authentication, request and response
/// interception. The first two can only be accepted (=forward to main RPC
/// server) or denied (=return error to client). Intercepted responses can also
/// be replaced/overwritten.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum InterceptType {
/// Intercept stream authentication: each new streaming RPC call that is
/// initiated against lnd and contains the middleware's custom macaroon
/// caveat can be approved or denied based upon the macaroon in the stream
/// header. This message will only be sent for streaming RPCs, unary RPCs
/// must handle the macaroon authentication in the request interception to
/// avoid an additional message round trip between lnd and the middleware.
#[prost(message, tag = "4")]
StreamAuth(super::StreamAuth),
/// Intercept incoming gRPC client request message: all incoming messages,
/// both on streaming and unary RPCs, are forwarded to the middleware for
/// inspection. For unary RPC messages the middleware is also expected to
/// validate the custom macaroon caveat of the request.
#[prost(message, tag = "5")]
Request(super::RpcMessage),
/// Intercept outgoing gRPC response message: all outgoing messages, both on
/// streaming and unary RPCs, are forwarded to the middleware for inspection
/// and amendment. The response in this message is the original response as
/// it was generated by the main RPC server. It can either be accepted
/// (=forwarded to the client), replaced/overwritten with a new message of
/// the same type, or replaced by an error message.
#[prost(message, tag = "6")]
Response(super::RpcMessage),
/// This is used to indicate to the client that the server has successfully
/// registered the interceptor. This is only used in the very first message
/// that the server sends to the client after the client sends the server
/// the middleware registration message.
#[prost(bool, tag = "8")]
RegComplete(bool),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct MetadataValues {
/// The set of metadata values that correspond to the metadata key.
#[prost(string, repeated, tag = "1")]
pub values: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct StreamAuth {
/// The full URI (in the format /<rpcpackage>.<ServiceName>/MethodName, for
/// example /lnrpc.Lightning/GetInfo) of the streaming RPC method that was just
/// established.
#[prost(string, tag = "1")]
pub method_full_uri: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct RpcMessage {
/// The full URI (in the format /<rpcpackage>.<ServiceName>/MethodName, for
/// example /lnrpc.Lightning/GetInfo) of the RPC method the message was sent
/// to/from.
#[prost(string, tag = "1")]
pub method_full_uri: ::prost::alloc::string::String,
/// Indicates whether the message was sent over a streaming RPC method or not.
#[prost(bool, tag = "2")]
pub stream_rpc: bool,
/// The full canonical gRPC name of the message type (in the format
/// <rpcpackage>.TypeName, for example lnrpc.GetInfoRequest). In case of an
/// error being returned from lnd, this simply contains the string "error".
#[prost(string, tag = "3")]
pub type_name: ::prost::alloc::string::String,
/// The full content of the gRPC message, serialized in the binary protobuf
/// format.
#[prost(bytes = "vec", tag = "4")]
pub serialized: ::prost::alloc::vec::Vec<u8>,
/// Indicates that the response from lnd was an error, not a gRPC response. If
/// this is set to true then the type_name contains the string "error" and
/// serialized contains the error string.
#[prost(bool, tag = "5")]
pub is_error: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct RpcMiddlewareResponse {
/// The request message ID this response refers to. Must always be set when
/// giving feedback to an intercept but is ignored for the initial registration
/// message.
#[prost(uint64, tag = "1")]
pub ref_msg_id: u64,
/// The middleware can only send two types of messages to lnd: The initial
/// registration message that identifies the middleware and after that only
/// feedback messages to requests sent to the middleware.
#[prost(oneof = "rpc_middleware_response::MiddlewareMessage", tags = "2, 3")]
pub middleware_message: ::core::option::Option<
rpc_middleware_response::MiddlewareMessage,
>,
}
/// Nested message and enum types in `RPCMiddlewareResponse`.
pub mod rpc_middleware_response {
/// The middleware can only send two types of messages to lnd: The initial
/// registration message that identifies the middleware and after that only
/// feedback messages to requests sent to the middleware.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
pub enum MiddlewareMessage {
/// The registration message identifies the middleware that's being
/// registered in lnd. The registration message must be sent immediately
/// after initiating the RegisterRpcMiddleware stream, otherwise lnd will
/// time out the attempt and terminate the request. NOTE: The middleware
/// will only receive interception messages for requests that contain a
/// macaroon with the custom caveat that the middleware declares it is
/// responsible for handling in the registration message! As a security
/// measure, *no* middleware can intercept requests made with *unencumbered*
/// macaroons!
#[prost(message, tag = "2")]
Register(super::MiddlewareRegistration),
/// The middleware received an interception request and gives feedback to
/// it. The request_id indicates what message the feedback refers to.
#[prost(message, tag = "3")]
Feedback(super::InterceptFeedback),
}
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct MiddlewareRegistration {
/// The name of the middleware to register. The name should be as informative
/// as possible and is logged on registration.
#[prost(string, tag = "1")]
pub middleware_name: ::prost::alloc::string::String,
/// The name of the custom macaroon caveat that this middleware is responsible
/// for. Only requests/responses that contain a macaroon with the registered
/// custom caveat are forwarded for interception to the middleware. The
/// exception being the read-only mode: All requests/responses are forwarded to
/// a middleware that requests read-only access but such a middleware won't be
/// allowed to *alter* responses. As a security measure, *no* middleware can
/// change responses to requests made with *unencumbered* macaroons!
/// NOTE: Cannot be used at the same time as read_only_mode.
#[prost(string, tag = "2")]
pub custom_macaroon_caveat_name: ::prost::alloc::string::String,
/// Instead of defining a custom macaroon caveat name a middleware can register
/// itself for read-only access only. In that mode all requests/responses are
/// forwarded to the middleware but the middleware isn't allowed to alter any of
/// the responses.
/// NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
#[prost(bool, tag = "3")]
pub read_only_mode: bool,
}
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct InterceptFeedback {
/// The error to return to the user. If this is non-empty, the incoming gRPC
/// stream/request is aborted and the error is returned to the gRPC client. If
/// this value is empty, it means the middleware accepts the stream/request/
/// response and the processing of it can continue.
#[prost(string, tag = "1")]
pub error: ::prost::alloc::string::String,
/// A boolean indicating that the gRPC message should be replaced/overwritten.
/// This boolean is needed because in protobuf an empty message is serialized as
/// a 0-length or nil byte slice and we wouldn't be able to distinguish between
/// an empty replacement message and the "don't replace anything" case.
#[prost(bool, tag = "2")]
pub replace_response: bool,
/// If the replace_response field is set to true, this field must contain the
/// binary serialized gRPC message in the protobuf format.
#[prost(bytes = "vec", tag = "3")]
pub replacement_serialized: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OutputScriptType {
ScriptTypePubkeyHash = 0,
ScriptTypeScriptHash = 1,
ScriptTypeWitnessV0PubkeyHash = 2,
ScriptTypeWitnessV0ScriptHash = 3,
ScriptTypePubkey = 4,
ScriptTypeMultisig = 5,
ScriptTypeNulldata = 6,
ScriptTypeNonStandard = 7,
ScriptTypeWitnessUnknown = 8,
ScriptTypeWitnessV1Taproot = 9,
}
impl OutputScriptType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::ScriptTypePubkeyHash => "SCRIPT_TYPE_PUBKEY_HASH",
Self::ScriptTypeScriptHash => "SCRIPT_TYPE_SCRIPT_HASH",
Self::ScriptTypeWitnessV0PubkeyHash => "SCRIPT_TYPE_WITNESS_V0_PUBKEY_HASH",
Self::ScriptTypeWitnessV0ScriptHash => "SCRIPT_TYPE_WITNESS_V0_SCRIPT_HASH",
Self::ScriptTypePubkey => "SCRIPT_TYPE_PUBKEY",
Self::ScriptTypeMultisig => "SCRIPT_TYPE_MULTISIG",
Self::ScriptTypeNulldata => "SCRIPT_TYPE_NULLDATA",
Self::ScriptTypeNonStandard => "SCRIPT_TYPE_NON_STANDARD",
Self::ScriptTypeWitnessUnknown => "SCRIPT_TYPE_WITNESS_UNKNOWN",
Self::ScriptTypeWitnessV1Taproot => "SCRIPT_TYPE_WITNESS_V1_TAPROOT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"SCRIPT_TYPE_PUBKEY_HASH" => Some(Self::ScriptTypePubkeyHash),
"SCRIPT_TYPE_SCRIPT_HASH" => Some(Self::ScriptTypeScriptHash),
"SCRIPT_TYPE_WITNESS_V0_PUBKEY_HASH" => {
Some(Self::ScriptTypeWitnessV0PubkeyHash)
}
"SCRIPT_TYPE_WITNESS_V0_SCRIPT_HASH" => {
Some(Self::ScriptTypeWitnessV0ScriptHash)
}
"SCRIPT_TYPE_PUBKEY" => Some(Self::ScriptTypePubkey),
"SCRIPT_TYPE_MULTISIG" => Some(Self::ScriptTypeMultisig),
"SCRIPT_TYPE_NULLDATA" => Some(Self::ScriptTypeNulldata),
"SCRIPT_TYPE_NON_STANDARD" => Some(Self::ScriptTypeNonStandard),
"SCRIPT_TYPE_WITNESS_UNKNOWN" => Some(Self::ScriptTypeWitnessUnknown),
"SCRIPT_TYPE_WITNESS_V1_TAPROOT" => Some(Self::ScriptTypeWitnessV1Taproot),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum CoinSelectionStrategy {
/// Use the coin selection strategy defined in the global configuration
/// (lnd.conf).
StrategyUseGlobalConfig = 0,
/// Select the largest available coins first during coin selection.
StrategyLargest = 1,
/// Randomly select the available coins during coin selection.
StrategyRandom = 2,
}
impl CoinSelectionStrategy {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::StrategyUseGlobalConfig => "STRATEGY_USE_GLOBAL_CONFIG",
Self::StrategyLargest => "STRATEGY_LARGEST",
Self::StrategyRandom => "STRATEGY_RANDOM",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STRATEGY_USE_GLOBAL_CONFIG" => Some(Self::StrategyUseGlobalConfig),
"STRATEGY_LARGEST" => Some(Self::StrategyLargest),
"STRATEGY_RANDOM" => Some(Self::StrategyRandom),
_ => None,
}
}
}
/// `AddressType` has to be one of:
///
/// * `p2wkh`: Pay to witness key hash (`WITNESS_PUBKEY_HASH` = 0)
/// * `np2wkh`: Pay to nested witness key hash (`NESTED_PUBKEY_HASH` = 1)
/// * `p2tr`: Pay to taproot pubkey (`TAPROOT_PUBKEY` = 4)
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum AddressType {
WitnessPubkeyHash = 0,
NestedPubkeyHash = 1,
UnusedWitnessPubkeyHash = 2,
UnusedNestedPubkeyHash = 3,
TaprootPubkey = 4,
UnusedTaprootPubkey = 5,
}
impl AddressType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::WitnessPubkeyHash => "WITNESS_PUBKEY_HASH",
Self::NestedPubkeyHash => "NESTED_PUBKEY_HASH",
Self::UnusedWitnessPubkeyHash => "UNUSED_WITNESS_PUBKEY_HASH",
Self::UnusedNestedPubkeyHash => "UNUSED_NESTED_PUBKEY_HASH",
Self::TaprootPubkey => "TAPROOT_PUBKEY",
Self::UnusedTaprootPubkey => "UNUSED_TAPROOT_PUBKEY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"WITNESS_PUBKEY_HASH" => Some(Self::WitnessPubkeyHash),
"NESTED_PUBKEY_HASH" => Some(Self::NestedPubkeyHash),
"UNUSED_WITNESS_PUBKEY_HASH" => Some(Self::UnusedWitnessPubkeyHash),
"UNUSED_NESTED_PUBKEY_HASH" => Some(Self::UnusedNestedPubkeyHash),
"TAPROOT_PUBKEY" => Some(Self::TaprootPubkey),
"UNUSED_TAPROOT_PUBKEY" => Some(Self::UnusedTaprootPubkey),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum CommitmentType {
/// Returned when the commitment type isn't known or unavailable.
UnknownCommitmentType = 0,
/// A channel using the legacy commitment format having tweaked to_remote
/// keys.
Legacy = 1,
/// 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.
StaticRemoteKey = 2,
/// 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 = 3,
/// A channel that uses a commitment type that builds upon the anchors
/// commitment format, but in addition requires a CLTV clause to spend outputs
/// paying to the channel initiator. This is intended for use on leased channels
/// to guarantee that the channel initiator has no incentives to close a leased
/// channel before its maturity date.
ScriptEnforcedLease = 4,
/// A channel that uses musig2 for the funding output, and the new tapscript
/// features where relevant.
SimpleTaproot = 5,
/// Identical to the SIMPLE_TAPROOT channel type, but with extra functionality.
/// This channel type also commits to additional meta data in the tapscript
/// leaves for the scripts in a channel.
SimpleTaprootOverlay = 6,
}
impl CommitmentType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::UnknownCommitmentType => "UNKNOWN_COMMITMENT_TYPE",
Self::Legacy => "LEGACY",
Self::StaticRemoteKey => "STATIC_REMOTE_KEY",
Self::Anchors => "ANCHORS",
Self::ScriptEnforcedLease => "SCRIPT_ENFORCED_LEASE",
Self::SimpleTaproot => "SIMPLE_TAPROOT",
Self::SimpleTaprootOverlay => "SIMPLE_TAPROOT_OVERLAY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN_COMMITMENT_TYPE" => Some(Self::UnknownCommitmentType),
"LEGACY" => Some(Self::Legacy),
"STATIC_REMOTE_KEY" => Some(Self::StaticRemoteKey),
"ANCHORS" => Some(Self::Anchors),
"SCRIPT_ENFORCED_LEASE" => Some(Self::ScriptEnforcedLease),
"SIMPLE_TAPROOT" => Some(Self::SimpleTaproot),
"SIMPLE_TAPROOT_OVERLAY" => Some(Self::SimpleTaprootOverlay),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Initiator {
Unknown = 0,
Local = 1,
Remote = 2,
Both = 3,
}
impl Initiator {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unknown => "INITIATOR_UNKNOWN",
Self::Local => "INITIATOR_LOCAL",
Self::Remote => "INITIATOR_REMOTE",
Self::Both => "INITIATOR_BOTH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INITIATOR_UNKNOWN" => Some(Self::Unknown),
"INITIATOR_LOCAL" => Some(Self::Local),
"INITIATOR_REMOTE" => Some(Self::Remote),
"INITIATOR_BOTH" => Some(Self::Both),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ResolutionType {
TypeUnknown = 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.
IncomingHtlc = 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.
OutgoingHtlc = 3,
/// We force closed and need to sweep our time locked commitment output.
Commit = 4,
}
impl ResolutionType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::TypeUnknown => "TYPE_UNKNOWN",
Self::Anchor => "ANCHOR",
Self::IncomingHtlc => "INCOMING_HTLC",
Self::OutgoingHtlc => "OUTGOING_HTLC",
Self::Commit => "COMMIT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TYPE_UNKNOWN" => Some(Self::TypeUnknown),
"ANCHOR" => Some(Self::Anchor),
"INCOMING_HTLC" => Some(Self::IncomingHtlc),
"OUTGOING_HTLC" => Some(Self::OutgoingHtlc),
"COMMIT" => Some(Self::Commit),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ResolutionOutcome {
/// Outcome unknown.
OutcomeUnknown = 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.
FirstStage = 4,
/// A htlc was timed out on chain.
Timeout = 5,
}
impl ResolutionOutcome {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::OutcomeUnknown => "OUTCOME_UNKNOWN",
Self::Claimed => "CLAIMED",
Self::Unclaimed => "UNCLAIMED",
Self::Abandoned => "ABANDONED",
Self::FirstStage => "FIRST_STAGE",
Self::Timeout => "TIMEOUT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OUTCOME_UNKNOWN" => Some(Self::OutcomeUnknown),
"CLAIMED" => Some(Self::Claimed),
"UNCLAIMED" => Some(Self::Unclaimed),
"ABANDONED" => Some(Self::Abandoned),
"FIRST_STAGE" => Some(Self::FirstStage),
"TIMEOUT" => Some(Self::Timeout),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum NodeMetricType {
Unknown = 0,
BetweennessCentrality = 1,
}
impl NodeMetricType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unknown => "UNKNOWN",
Self::BetweennessCentrality => "BETWEENNESS_CENTRALITY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN" => Some(Self::Unknown),
"BETWEENNESS_CENTRALITY" => Some(Self::BetweennessCentrality),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum InvoiceHtlcState {
Accepted = 0,
Settled = 1,
Canceled = 2,
}
impl InvoiceHtlcState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Accepted => "ACCEPTED",
Self::Settled => "SETTLED",
Self::Canceled => "CANCELED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ACCEPTED" => Some(Self::Accepted),
"SETTLED" => Some(Self::Settled),
"CANCELED" => Some(Self::Canceled),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PaymentFailureReason {
/// Payment isn't failed (yet).
FailureReasonNone = 0,
/// There are more routes to try, but the payment timeout was exceeded.
FailureReasonTimeout = 1,
/// All possible routes were tried and failed permanently. Or were no
/// routes to the destination at all.
FailureReasonNoRoute = 2,
/// A non-recoverable error has occured.
FailureReasonError = 3,
/// Payment details incorrect (unknown hash, invalid amt or
/// invalid final cltv delta)
FailureReasonIncorrectPaymentDetails = 4,
/// Insufficient local balance.
FailureReasonInsufficientBalance = 5,
/// The payment was canceled.
FailureReasonCanceled = 6,
}
impl PaymentFailureReason {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::FailureReasonNone => "FAILURE_REASON_NONE",
Self::FailureReasonTimeout => "FAILURE_REASON_TIMEOUT",
Self::FailureReasonNoRoute => "FAILURE_REASON_NO_ROUTE",
Self::FailureReasonError => "FAILURE_REASON_ERROR",
Self::FailureReasonIncorrectPaymentDetails => {
"FAILURE_REASON_INCORRECT_PAYMENT_DETAILS"
}
Self::FailureReasonInsufficientBalance => {
"FAILURE_REASON_INSUFFICIENT_BALANCE"
}
Self::FailureReasonCanceled => "FAILURE_REASON_CANCELED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"FAILURE_REASON_NONE" => Some(Self::FailureReasonNone),
"FAILURE_REASON_TIMEOUT" => Some(Self::FailureReasonTimeout),
"FAILURE_REASON_NO_ROUTE" => Some(Self::FailureReasonNoRoute),
"FAILURE_REASON_ERROR" => Some(Self::FailureReasonError),
"FAILURE_REASON_INCORRECT_PAYMENT_DETAILS" => {
Some(Self::FailureReasonIncorrectPaymentDetails)
}
"FAILURE_REASON_INSUFFICIENT_BALANCE" => {
Some(Self::FailureReasonInsufficientBalance)
}
"FAILURE_REASON_CANCELED" => Some(Self::FailureReasonCanceled),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum FeatureBit {
DatalossProtectReq = 0,
DatalossProtectOpt = 1,
InitialRouingSync = 3,
UpfrontShutdownScriptReq = 4,
UpfrontShutdownScriptOpt = 5,
GossipQueriesReq = 6,
GossipQueriesOpt = 7,
TlvOnionReq = 8,
TlvOnionOpt = 9,
ExtGossipQueriesReq = 10,
ExtGossipQueriesOpt = 11,
StaticRemoteKeyReq = 12,
StaticRemoteKeyOpt = 13,
PaymentAddrReq = 14,
PaymentAddrOpt = 15,
MppReq = 16,
MppOpt = 17,
WumboChannelsReq = 18,
WumboChannelsOpt = 19,
AnchorsReq = 20,
AnchorsOpt = 21,
AnchorsZeroFeeHtlcReq = 22,
AnchorsZeroFeeHtlcOpt = 23,
RouteBlindingRequired = 24,
RouteBlindingOptional = 25,
AmpReq = 30,
AmpOpt = 31,
}
impl FeatureBit {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::DatalossProtectReq => "DATALOSS_PROTECT_REQ",
Self::DatalossProtectOpt => "DATALOSS_PROTECT_OPT",
Self::InitialRouingSync => "INITIAL_ROUING_SYNC",
Self::UpfrontShutdownScriptReq => "UPFRONT_SHUTDOWN_SCRIPT_REQ",
Self::UpfrontShutdownScriptOpt => "UPFRONT_SHUTDOWN_SCRIPT_OPT",
Self::GossipQueriesReq => "GOSSIP_QUERIES_REQ",
Self::GossipQueriesOpt => "GOSSIP_QUERIES_OPT",
Self::TlvOnionReq => "TLV_ONION_REQ",
Self::TlvOnionOpt => "TLV_ONION_OPT",
Self::ExtGossipQueriesReq => "EXT_GOSSIP_QUERIES_REQ",
Self::ExtGossipQueriesOpt => "EXT_GOSSIP_QUERIES_OPT",
Self::StaticRemoteKeyReq => "STATIC_REMOTE_KEY_REQ",
Self::StaticRemoteKeyOpt => "STATIC_REMOTE_KEY_OPT",
Self::PaymentAddrReq => "PAYMENT_ADDR_REQ",
Self::PaymentAddrOpt => "PAYMENT_ADDR_OPT",
Self::MppReq => "MPP_REQ",
Self::MppOpt => "MPP_OPT",
Self::WumboChannelsReq => "WUMBO_CHANNELS_REQ",
Self::WumboChannelsOpt => "WUMBO_CHANNELS_OPT",
Self::AnchorsReq => "ANCHORS_REQ",
Self::AnchorsOpt => "ANCHORS_OPT",
Self::AnchorsZeroFeeHtlcReq => "ANCHORS_ZERO_FEE_HTLC_REQ",
Self::AnchorsZeroFeeHtlcOpt => "ANCHORS_ZERO_FEE_HTLC_OPT",
Self::RouteBlindingRequired => "ROUTE_BLINDING_REQUIRED",
Self::RouteBlindingOptional => "ROUTE_BLINDING_OPTIONAL",
Self::AmpReq => "AMP_REQ",
Self::AmpOpt => "AMP_OPT",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DATALOSS_PROTECT_REQ" => Some(Self::DatalossProtectReq),
"DATALOSS_PROTECT_OPT" => Some(Self::DatalossProtectOpt),
"INITIAL_ROUING_SYNC" => Some(Self::InitialRouingSync),
"UPFRONT_SHUTDOWN_SCRIPT_REQ" => Some(Self::UpfrontShutdownScriptReq),
"UPFRONT_SHUTDOWN_SCRIPT_OPT" => Some(Self::UpfrontShutdownScriptOpt),
"GOSSIP_QUERIES_REQ" => Some(Self::GossipQueriesReq),
"GOSSIP_QUERIES_OPT" => Some(Self::GossipQueriesOpt),
"TLV_ONION_REQ" => Some(Self::TlvOnionReq),
"TLV_ONION_OPT" => Some(Self::TlvOnionOpt),
"EXT_GOSSIP_QUERIES_REQ" => Some(Self::ExtGossipQueriesReq),
"EXT_GOSSIP_QUERIES_OPT" => Some(Self::ExtGossipQueriesOpt),
"STATIC_REMOTE_KEY_REQ" => Some(Self::StaticRemoteKeyReq),
"STATIC_REMOTE_KEY_OPT" => Some(Self::StaticRemoteKeyOpt),
"PAYMENT_ADDR_REQ" => Some(Self::PaymentAddrReq),
"PAYMENT_ADDR_OPT" => Some(Self::PaymentAddrOpt),
"MPP_REQ" => Some(Self::MppReq),
"MPP_OPT" => Some(Self::MppOpt),
"WUMBO_CHANNELS_REQ" => Some(Self::WumboChannelsReq),
"WUMBO_CHANNELS_OPT" => Some(Self::WumboChannelsOpt),
"ANCHORS_REQ" => Some(Self::AnchorsReq),
"ANCHORS_OPT" => Some(Self::AnchorsOpt),
"ANCHORS_ZERO_FEE_HTLC_REQ" => Some(Self::AnchorsZeroFeeHtlcReq),
"ANCHORS_ZERO_FEE_HTLC_OPT" => Some(Self::AnchorsZeroFeeHtlcOpt),
"ROUTE_BLINDING_REQUIRED" => Some(Self::RouteBlindingRequired),
"ROUTE_BLINDING_OPTIONAL" => Some(Self::RouteBlindingOptional),
"AMP_REQ" => Some(Self::AmpReq),
"AMP_OPT" => Some(Self::AmpOpt),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum UpdateFailure {
Unknown = 0,
Pending = 1,
NotFound = 2,
InternalErr = 3,
InvalidParameter = 4,
}
impl UpdateFailure {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unknown => "UPDATE_FAILURE_UNKNOWN",
Self::Pending => "UPDATE_FAILURE_PENDING",
Self::NotFound => "UPDATE_FAILURE_NOT_FOUND",
Self::InternalErr => "UPDATE_FAILURE_INTERNAL_ERR",
Self::InvalidParameter => "UPDATE_FAILURE_INVALID_PARAMETER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UPDATE_FAILURE_UNKNOWN" => Some(Self::Unknown),
"UPDATE_FAILURE_PENDING" => Some(Self::Pending),
"UPDATE_FAILURE_NOT_FOUND" => Some(Self::NotFound),
"UPDATE_FAILURE_INTERNAL_ERR" => Some(Self::InternalErr),
"UPDATE_FAILURE_INVALID_PARAMETER" => Some(Self::InvalidParameter),
_ => None,
}
}
}
/// Generated client implementations.
pub mod lightning_client {
#![allow(
unused_variables,
dead_code,
missing_docs,
clippy::wildcard_imports,
clippy::let_unit_value,
)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Lightning is the main RPC server of the daemon.
#[derive(Debug, Clone)]
pub struct LightningClient<T> {
inner: tonic::client::Grpc<T>,
}
impl LightningClient<tonic::transport::Channel> {
/// Attempt to create a new client by connecting to a given endpoint.
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> LightningClient<T>
where
T: tonic::client::GrpcService<tonic::body::Body>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> LightningClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::Body>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::Body>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
LightningClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// lncli: `walletbalance`
/// WalletBalance returns total unspent outputs(confirmed and unconfirmed), all
/// confirmed unspent outputs and all unconfirmed unspent outputs under control
/// of the wallet.
pub async fn wallet_balance(
&mut self,
request: impl tonic::IntoRequest<super::WalletBalanceRequest>,
) -> std::result::Result<
tonic::Response<super::WalletBalanceResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/WalletBalance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "WalletBalance"));
self.inner.unary(req, path, codec).await
}
/// lncli: `channelbalance`
/// ChannelBalance returns a report on the total funds across all open channels,
/// categorized in local/remote, pending local/remote and unsettled local/remote
/// balances.
pub async fn channel_balance(
&mut self,
request: impl tonic::IntoRequest<super::ChannelBalanceRequest>,
) -> std::result::Result<
tonic::Response<super::ChannelBalanceResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ChannelBalance",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ChannelBalance"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listchaintxns`
/// GetTransactions returns a list describing all the known transactions
/// relevant to the wallet.
pub async fn get_transactions(
&mut self,
request: impl tonic::IntoRequest<super::GetTransactionsRequest>,
) -> std::result::Result<
tonic::Response<super::TransactionDetails>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetTransactions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetTransactions"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn estimate_fee(
&mut self,
request: impl tonic::IntoRequest<super::EstimateFeeRequest>,
) -> std::result::Result<
tonic::Response<super::EstimateFeeResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/EstimateFee",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "EstimateFee"));
self.inner.unary(req, path, codec).await
}
/// 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_vbyte are set, then the internal wallet will
/// consult its fee model to determine a fee for the default confirmation
/// target.
pub async fn send_coins(
&mut self,
request: impl tonic::IntoRequest<super::SendCoinsRequest>,
) -> std::result::Result<
tonic::Response<super::SendCoinsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendCoins",
);
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("lnrpc.Lightning", "SendCoins"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn list_unspent(
&mut self,
request: impl tonic::IntoRequest<super::ListUnspentRequest>,
) -> std::result::Result<
tonic::Response<super::ListUnspentResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListUnspent",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListUnspent"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn subscribe_transactions(
&mut self,
request: impl tonic::IntoRequest<super::GetTransactionsRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::Transaction>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeTransactions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeTransactions"));
self.inner.server_streaming(req, path, codec).await
}
/// lncli: `sendmany`
/// SendMany handles a request for a transaction that creates multiple specified
/// outputs in parallel. If neither target_conf, or sat_per_vbyte are set, then
/// the internal wallet will consult its fee model to determine a fee for the
/// default confirmation target.
pub async fn send_many(
&mut self,
request: impl tonic::IntoRequest<super::SendManyRequest>,
) -> std::result::Result<
tonic::Response<super::SendManyResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/lnrpc.Lightning/SendMany");
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("lnrpc.Lightning", "SendMany"));
self.inner.unary(req, path, codec).await
}
/// lncli: `newaddress`
/// NewAddress creates a new address under control of the local wallet.
pub async fn new_address(
&mut self,
request: impl tonic::IntoRequest<super::NewAddressRequest>,
) -> std::result::Result<
tonic::Response<super::NewAddressResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/NewAddress",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "NewAddress"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn sign_message(
&mut self,
request: impl tonic::IntoRequest<super::SignMessageRequest>,
) -> std::result::Result<
tonic::Response<super::SignMessageResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SignMessage",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SignMessage"));
self.inner.unary(req, path, codec).await
}
/// lncli: `verifymessage`
/// VerifyMessage verifies a signature over a message and recovers the signer's
/// public key. The signature is only deemed valid if the recovered public key
/// corresponds to a node key in the public Lightning network. 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.
pub async fn verify_message(
&mut self,
request: impl tonic::IntoRequest<super::VerifyMessageRequest>,
) -> std::result::Result<
tonic::Response<super::VerifyMessageResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/VerifyMessage",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "VerifyMessage"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn connect_peer(
&mut self,
request: impl tonic::IntoRequest<super::ConnectPeerRequest>,
) -> std::result::Result<
tonic::Response<super::ConnectPeerResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ConnectPeer",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ConnectPeer"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn disconnect_peer(
&mut self,
request: impl tonic::IntoRequest<super::DisconnectPeerRequest>,
) -> std::result::Result<
tonic::Response<super::DisconnectPeerResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DisconnectPeer",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DisconnectPeer"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listpeers`
/// ListPeers returns a verbose listing of all currently active peers.
pub async fn list_peers(
&mut self,
request: impl tonic::IntoRequest<super::ListPeersRequest>,
) -> std::result::Result<
tonic::Response<super::ListPeersResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListPeers",
);
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("lnrpc.Lightning", "ListPeers"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn subscribe_peer_events(
&mut self,
request: impl tonic::IntoRequest<super::PeerEventSubscription>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::PeerEvent>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribePeerEvents",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribePeerEvents"));
self.inner.server_streaming(req, path, codec).await
}
/// 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.
pub async fn get_info(
&mut self,
request: impl tonic::IntoRequest<super::GetInfoRequest>,
) -> std::result::Result<
tonic::Response<super::GetInfoResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/lnrpc.Lightning/GetInfo");
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("lnrpc.Lightning", "GetInfo"));
self.inner.unary(req, path, codec).await
}
/// lncli: 'getdebuginfo'
/// GetDebugInfo returns debug information concerning the state of the daemon
/// and its subsystems. This includes the full configuration and the latest log
/// entries from the log file.
pub async fn get_debug_info(
&mut self,
request: impl tonic::IntoRequest<super::GetDebugInfoRequest>,
) -> std::result::Result<
tonic::Response<super::GetDebugInfoResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetDebugInfo",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetDebugInfo"));
self.inner.unary(req, path, codec).await
}
/// * 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.
pub async fn get_recovery_info(
&mut self,
request: impl tonic::IntoRequest<super::GetRecoveryInfoRequest>,
) -> std::result::Result<
tonic::Response<super::GetRecoveryInfoResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetRecoveryInfo",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetRecoveryInfo"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn pending_channels(
&mut self,
request: impl tonic::IntoRequest<super::PendingChannelsRequest>,
) -> std::result::Result<
tonic::Response<super::PendingChannelsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/PendingChannels",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "PendingChannels"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listchannels`
/// ListChannels returns a description of all the open channels that this node
/// is a participant in.
pub async fn list_channels(
&mut self,
request: impl tonic::IntoRequest<super::ListChannelsRequest>,
) -> std::result::Result<
tonic::Response<super::ListChannelsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListChannels",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListChannels"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn subscribe_channel_events(
&mut self,
request: impl tonic::IntoRequest<super::ChannelEventSubscription>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ChannelEventUpdate>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeChannelEvents",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeChannelEvents"));
self.inner.server_streaming(req, path, codec).await
}
/// lncli: `closedchannels`
/// ClosedChannels returns a description of all the closed channels that
/// this node was a participant in.
pub async fn closed_channels(
&mut self,
request: impl tonic::IntoRequest<super::ClosedChannelsRequest>,
) -> std::result::Result<
tonic::Response<super::ClosedChannelsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ClosedChannels",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ClosedChannels"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn open_channel_sync(
&mut self,
request: impl tonic::IntoRequest<super::OpenChannelRequest>,
) -> std::result::Result<tonic::Response<super::ChannelPoint>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/OpenChannelSync",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "OpenChannelSync"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn open_channel(
&mut self,
request: impl tonic::IntoRequest<super::OpenChannelRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::OpenStatusUpdate>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/OpenChannel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "OpenChannel"));
self.inner.server_streaming(req, path, codec).await
}
/// lncli: `batchopenchannel`
/// BatchOpenChannel attempts to open multiple single-funded channels in a
/// single transaction in an atomic way. This means either all channel open
/// requests succeed at once or all attempts are aborted if any of them fail.
/// This is the safer variant of using PSBTs to manually fund a batch of
/// channels through the OpenChannel RPC.
pub async fn batch_open_channel(
&mut self,
request: impl tonic::IntoRequest<super::BatchOpenChannelRequest>,
) -> std::result::Result<
tonic::Response<super::BatchOpenChannelResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/BatchOpenChannel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "BatchOpenChannel"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn funding_state_step(
&mut self,
request: impl tonic::IntoRequest<super::FundingTransitionMsg>,
) -> std::result::Result<
tonic::Response<super::FundingStateStepResp>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/FundingStateStep",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "FundingStateStep"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn channel_acceptor(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::ChannelAcceptResponse,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ChannelAcceptRequest>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ChannelAcceptor",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ChannelAcceptor"));
self.inner.streaming(req, path, codec).await
}
/// 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.
pub async fn close_channel(
&mut self,
request: impl tonic::IntoRequest<super::CloseChannelRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::CloseStatusUpdate>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/CloseChannel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "CloseChannel"));
self.inner.server_streaming(req, path, codec).await
}
/// 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. This method can also be
/// used to remove externally funded channels where the funding transaction was
/// never broadcast. Only available for non-externally funded channels in dev
/// build.
pub async fn abandon_channel(
&mut self,
request: impl tonic::IntoRequest<super::AbandonChannelRequest>,
) -> std::result::Result<
tonic::Response<super::AbandonChannelResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/AbandonChannel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "AbandonChannel"));
self.inner.unary(req, path, codec).await
}
/// 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.
#[deprecated]
pub async fn send_payment(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::SendRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::SendResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendPayment",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SendPayment"));
self.inner.streaming(req, path, codec).await
}
/// Deprecated, use routerrpc.SendPaymentV2. 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.
#[deprecated]
pub async fn send_payment_sync(
&mut self,
request: impl tonic::IntoRequest<super::SendRequest>,
) -> std::result::Result<tonic::Response<super::SendResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendPaymentSync",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SendPaymentSync"));
self.inner.unary(req, path, codec).await
}
/// 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.
#[deprecated]
pub async fn send_to_route(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::SendToRouteRequest,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::SendResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendToRoute",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SendToRoute"));
self.inner.streaming(req, path, codec).await
}
/// Deprecated, use routerrpc.SendToRouteV2. SendToRouteSync is a synchronous
/// version of SendToRoute. It Will block until the payment either fails or
/// succeeds.
#[deprecated]
pub async fn send_to_route_sync(
&mut self,
request: impl tonic::IntoRequest<super::SendToRouteRequest>,
) -> std::result::Result<tonic::Response<super::SendResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendToRouteSync",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SendToRouteSync"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn add_invoice(
&mut self,
request: impl tonic::IntoRequest<super::Invoice>,
) -> std::result::Result<
tonic::Response<super::AddInvoiceResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/AddInvoice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "AddInvoice"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn list_invoices(
&mut self,
request: impl tonic::IntoRequest<super::ListInvoiceRequest>,
) -> std::result::Result<
tonic::Response<super::ListInvoiceResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListInvoices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListInvoices"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn lookup_invoice(
&mut self,
request: impl tonic::IntoRequest<super::PaymentHash>,
) -> std::result::Result<tonic::Response<super::Invoice>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/LookupInvoice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "LookupInvoice"));
self.inner.unary(req, path, codec).await
}
/// 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, then 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.
pub async fn subscribe_invoices(
&mut self,
request: impl tonic::IntoRequest<super::InvoiceSubscription>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::Invoice>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeInvoices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeInvoices"));
self.inner.server_streaming(req, path, codec).await
}
/// lncli: `deletecanceledinvoice`
/// DeleteCanceledInvoice removes a canceled invoice from the database. If the
/// invoice is not in the canceled state, an error will be returned.
pub async fn delete_canceled_invoice(
&mut self,
request: impl tonic::IntoRequest<super::DelCanceledInvoiceReq>,
) -> std::result::Result<
tonic::Response<super::DelCanceledInvoiceResp>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DeleteCanceledInvoice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DeleteCanceledInvoice"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn decode_pay_req(
&mut self,
request: impl tonic::IntoRequest<super::PayReqString>,
) -> std::result::Result<tonic::Response<super::PayReq>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DecodePayReq",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DecodePayReq"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listpayments`
/// ListPayments returns a list of all outgoing payments.
pub async fn list_payments(
&mut self,
request: impl tonic::IntoRequest<super::ListPaymentsRequest>,
) -> std::result::Result<
tonic::Response<super::ListPaymentsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListPayments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListPayments"));
self.inner.unary(req, path, codec).await
}
/// lncli: `deletepayments`
/// DeletePayment deletes an outgoing payment from DB. Note that it will not
/// attempt to delete an In-Flight payment, since that would be unsafe.
pub async fn delete_payment(
&mut self,
request: impl tonic::IntoRequest<super::DeletePaymentRequest>,
) -> std::result::Result<
tonic::Response<super::DeletePaymentResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DeletePayment",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DeletePayment"));
self.inner.unary(req, path, codec).await
}
/// lncli: `deletepayments --all`
/// DeleteAllPayments deletes all outgoing payments from DB. Note that it will
/// not attempt to delete In-Flight payments, since that would be unsafe.
pub async fn delete_all_payments(
&mut self,
request: impl tonic::IntoRequest<super::DeleteAllPaymentsRequest>,
) -> std::result::Result<
tonic::Response<super::DeleteAllPaymentsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DeleteAllPayments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DeleteAllPayments"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn describe_graph(
&mut self,
request: impl tonic::IntoRequest<super::ChannelGraphRequest>,
) -> std::result::Result<tonic::Response<super::ChannelGraph>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DescribeGraph",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DescribeGraph"));
self.inner.unary(req, path, codec).await
}
/// lncli: `getnodemetrics`
/// GetNodeMetrics returns node metrics calculated from the graph. Currently
/// the only supported metric is betweenness centrality of individual nodes.
pub async fn get_node_metrics(
&mut self,
request: impl tonic::IntoRequest<super::NodeMetricsRequest>,
) -> std::result::Result<
tonic::Response<super::NodeMetricsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetNodeMetrics",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetNodeMetrics"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn get_chan_info(
&mut self,
request: impl tonic::IntoRequest<super::ChanInfoRequest>,
) -> std::result::Result<tonic::Response<super::ChannelEdge>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetChanInfo",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetChanInfo"));
self.inner.unary(req, path, codec).await
}
/// lncli: `getnodeinfo`
/// GetNodeInfo returns the latest advertised, aggregated, and authenticated
/// channel information for the specified node identified by its public key.
pub async fn get_node_info(
&mut self,
request: impl tonic::IntoRequest<super::NodeInfoRequest>,
) -> std::result::Result<tonic::Response<super::NodeInfo>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetNodeInfo",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetNodeInfo"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn query_routes(
&mut self,
request: impl tonic::IntoRequest<super::QueryRoutesRequest>,
) -> std::result::Result<
tonic::Response<super::QueryRoutesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/QueryRoutes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "QueryRoutes"));
self.inner.unary(req, path, codec).await
}
/// lncli: `getnetworkinfo`
/// GetNetworkInfo returns some basic stats about the known channel graph from
/// the point of view of the node.
pub async fn get_network_info(
&mut self,
request: impl tonic::IntoRequest<super::NetworkInfoRequest>,
) -> std::result::Result<tonic::Response<super::NetworkInfo>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/GetNetworkInfo",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "GetNetworkInfo"));
self.inner.unary(req, path, codec).await
}
/// lncli: `stop`
/// StopDaemon will send a shutdown request to the interrupt handler, triggering
/// a graceful shutdown of the daemon.
pub async fn stop_daemon(
&mut self,
request: impl tonic::IntoRequest<super::StopRequest>,
) -> std::result::Result<tonic::Response<super::StopResponse>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/StopDaemon",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "StopDaemon"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn subscribe_channel_graph(
&mut self,
request: impl tonic::IntoRequest<super::GraphTopologySubscription>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::GraphTopologyUpdate>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeChannelGraph",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeChannelGraph"));
self.inner.server_streaming(req, path, codec).await
}
/// 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.
pub async fn debug_level(
&mut self,
request: impl tonic::IntoRequest<super::DebugLevelRequest>,
) -> std::result::Result<
tonic::Response<super::DebugLevelResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DebugLevel",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DebugLevel"));
self.inner.unary(req, path, codec).await
}
/// lncli: `feereport`
/// FeeReport allows the caller to obtain a report detailing the current fee
/// schedule enforced by the node globally for each channel.
pub async fn fee_report(
&mut self,
request: impl tonic::IntoRequest<super::FeeReportRequest>,
) -> std::result::Result<
tonic::Response<super::FeeReportResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/FeeReport",
);
let mut req = request.into_request();
req.extensions_mut().insert(GrpcMethod::new("lnrpc.Lightning", "FeeReport"));
self.inner.unary(req, path, codec).await
}
/// lncli: `updatechanpolicy`
/// UpdateChannelPolicy allows the caller to update the fee schedule and
/// channel policies for all channels globally, or a particular channel.
pub async fn update_channel_policy(
&mut self,
request: impl tonic::IntoRequest<super::PolicyUpdateRequest>,
) -> std::result::Result<
tonic::Response<super::PolicyUpdateResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/UpdateChannelPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "UpdateChannelPolicy"));
self.inner.unary(req, path, codec).await
}
/// 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, for a maximum number of events. If no maximum number
/// of events is specified, up to 100 events will be returned. If no time-range
/// is specified, then events will be returned in the order that they occured.
///
/// 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.
pub async fn forwarding_history(
&mut self,
request: impl tonic::IntoRequest<super::ForwardingHistoryRequest>,
) -> std::result::Result<
tonic::Response<super::ForwardingHistoryResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ForwardingHistory",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ForwardingHistory"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn export_channel_backup(
&mut self,
request: impl tonic::IntoRequest<super::ExportChannelBackupRequest>,
) -> std::result::Result<tonic::Response<super::ChannelBackup>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ExportChannelBackup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ExportChannelBackup"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn export_all_channel_backups(
&mut self,
request: impl tonic::IntoRequest<super::ChanBackupExportRequest>,
) -> std::result::Result<
tonic::Response<super::ChanBackupSnapshot>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ExportAllChannelBackups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ExportAllChannelBackups"));
self.inner.unary(req, path, codec).await
}
/// lncli: `verifychanbackup`
/// 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.
pub async fn verify_chan_backup(
&mut self,
request: impl tonic::IntoRequest<super::ChanBackupSnapshot>,
) -> std::result::Result<
tonic::Response<super::VerifyChanBackupResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/VerifyChanBackup",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "VerifyChanBackup"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn restore_channel_backups(
&mut self,
request: impl tonic::IntoRequest<super::RestoreChanBackupRequest>,
) -> std::result::Result<
tonic::Response<super::RestoreBackupResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/RestoreChannelBackups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "RestoreChannelBackups"));
self.inner.unary(req, path, codec).await
}
/// 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.
pub async fn subscribe_channel_backups(
&mut self,
request: impl tonic::IntoRequest<super::ChannelBackupSubscription>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::ChanBackupSnapshot>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeChannelBackups",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeChannelBackups"));
self.inner.server_streaming(req, path, codec).await
}
/// 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.
pub async fn bake_macaroon(
&mut self,
request: impl tonic::IntoRequest<super::BakeMacaroonRequest>,
) -> std::result::Result<
tonic::Response<super::BakeMacaroonResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/BakeMacaroon",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "BakeMacaroon"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listmacaroonids`
/// ListMacaroonIDs returns all root key IDs that are in use.
pub async fn list_macaroon_i_ds(
&mut self,
request: impl tonic::IntoRequest<super::ListMacaroonIDsRequest>,
) -> std::result::Result<
tonic::Response<super::ListMacaroonIDsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListMacaroonIDs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListMacaroonIDs"));
self.inner.unary(req, path, codec).await
}
/// lncli: `deletemacaroonid`
/// DeleteMacaroonID deletes the specified macaroon ID and invalidates all
/// macaroons derived from that ID.
pub async fn delete_macaroon_id(
&mut self,
request: impl tonic::IntoRequest<super::DeleteMacaroonIdRequest>,
) -> std::result::Result<
tonic::Response<super::DeleteMacaroonIdResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/DeleteMacaroonID",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "DeleteMacaroonID"));
self.inner.unary(req, path, codec).await
}
/// lncli: `listpermissions`
/// ListPermissions lists all RPC method URIs and their required macaroon
/// permissions to access them.
pub async fn list_permissions(
&mut self,
request: impl tonic::IntoRequest<super::ListPermissionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListPermissionsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListPermissions"));
self.inner.unary(req, path, codec).await
}
/// CheckMacaroonPermissions checks whether the provided macaroon contains all
/// the provided permissions. If the macaroon is valid (e.g. all caveats are
/// satisfied), and all permissions provided in the request are met, then
/// this RPC returns true.
pub async fn check_macaroon_permissions(
&mut self,
request: impl tonic::IntoRequest<super::CheckMacPermRequest>,
) -> std::result::Result<
tonic::Response<super::CheckMacPermResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/CheckMacaroonPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "CheckMacaroonPermissions"));
self.inner.unary(req, path, codec).await
}
/// RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain. A
/// gRPC middleware is software component external to lnd that aims to add
/// additional business logic to lnd by observing/intercepting/validating
/// incoming gRPC client requests and (if needed) replacing/overwriting outgoing
/// messages before they're sent to the client. When registering the middleware
/// must identify itself and indicate what custom macaroon caveats it wants to
/// be responsible for. Only requests that contain a macaroon with that specific
/// custom caveat are then sent to the middleware for inspection. The other
/// option is to register for the read-only mode in which all requests/responses
/// are forwarded for interception to the middleware but the middleware is not
/// allowed to modify any responses. As a security measure, *no* middleware can
/// modify responses for requests made with *unencumbered* macaroons!
pub async fn register_rpc_middleware(
&mut self,
request: impl tonic::IntoStreamingRequest<
Message = super::RpcMiddlewareResponse,
>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::RpcMiddlewareRequest>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/RegisterRPCMiddleware",
);
let mut req = request.into_streaming_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "RegisterRPCMiddleware"));
self.inner.streaming(req, path, codec).await
}
/// lncli: `sendcustom`
/// SendCustomMessage sends a custom peer message.
pub async fn send_custom_message(
&mut self,
request: impl tonic::IntoRequest<super::SendCustomMessageRequest>,
) -> std::result::Result<
tonic::Response<super::SendCustomMessageResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SendCustomMessage",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SendCustomMessage"));
self.inner.unary(req, path, codec).await
}
/// lncli: `subscribecustom`
/// SubscribeCustomMessages subscribes to a stream of incoming custom peer
/// messages.
///
/// To include messages with type outside of the custom range (>= 32768) lnd
/// needs to be compiled with the `dev` build tag, and the message type to
/// override should be specified in lnd's experimental protocol configuration.
pub async fn subscribe_custom_messages(
&mut self,
request: impl tonic::IntoRequest<super::SubscribeCustomMessagesRequest>,
) -> std::result::Result<
tonic::Response<tonic::codec::Streaming<super::CustomMessage>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/SubscribeCustomMessages",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "SubscribeCustomMessages"));
self.inner.server_streaming(req, path, codec).await
}
/// lncli: `listaliases`
/// ListAliases returns the set of all aliases that have ever existed with
/// their confirmed SCID (if it exists) and/or the base SCID (in the case of
/// zero conf).
pub async fn list_aliases(
&mut self,
request: impl tonic::IntoRequest<super::ListAliasesRequest>,
) -> std::result::Result<
tonic::Response<super::ListAliasesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/ListAliases",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "ListAliases"));
self.inner.unary(req, path, codec).await
}
/// LookupHtlcResolution retrieves a final htlc resolution from the database.
/// If the htlc has no final resolution yet, a NotFound grpc status code is
/// returned.
pub async fn lookup_htlc_resolution(
&mut self,
request: impl tonic::IntoRequest<super::LookupHtlcResolutionRequest>,
) -> std::result::Result<
tonic::Response<super::LookupHtlcResolutionResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::unknown(
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic_prost::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/lnrpc.Lightning/LookupHtlcResolution",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("lnrpc.Lightning", "LookupHtlcResolution"));
self.inner.unary(req, path, codec).await
}
}
}