zingolib 0.0.1

Zingo backend library.
Documentation
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
//! An interface that passes strings (e.g. from a cli, into zingolib)
//! upgrade-or-replace

use std::collections::HashMap;
use std::convert::TryInto;
use std::str::FromStr;

use indoc::indoc;
use json::object;
use lazy_static::lazy_static;
use tokio::runtime::Runtime;

use zcash_address::unified::{Container, Encoding, Ufvk};
use zcash_keys::address::Address;
use zcash_keys::keys::UnifiedFullViewingKey;
use zcash_protocol::consensus::NetworkType;
use zcash_protocol::value::Zatoshis;

use crate::data::{PollReport, proposal};
use crate::lightclient::LightClient;
use crate::utils::conversion::txid_from_hex_encoded_str;
use crate::wallet::keys::unified::UnifiedKeyStore;
use pepper_sync::wallet::{OrchardNote, SaplingNote, SyncMode};

mod error;
mod utils;

lazy_static! {
    pub static ref RT: Runtime = tokio::runtime::Runtime::new().unwrap();
}

/// This command interface is used both by cli and also consumers.
pub trait Command {
    /// display command help (in cli)
    fn help(&self) -> &'static str;

    /// TODO: Add Doc Comment for this!
    fn short_help(&self) -> &'static str;

    /// in zingocli, this string is printed to console
    /// consumers occasionally make assumptions about this
    /// e. expect it to be a json object
    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String;
}

/// TODO: Add Doc Comment Here!
pub trait ShortCircuitedCommand {
    /// TODO: Add Doc Comment Here!
    fn exec_without_lc(args: Vec<String>) -> String;
}

struct GetVersionCommand {}
impl Command for GetVersionCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Return the git describe --dirty of the repo at build time.
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Get version of build code"
    }

    fn exec(&self, _args: &[&str], _lightclient: &mut LightClient) -> String {
        crate::git_description().to_string()
    }
}

struct ChangeServerCommand {}
impl Command for ChangeServerCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Change the lightwalletd server to receive blockchain data from
            Usage:
            changeserver [server_uri]

            Example:
            changeserver https://mainnet.lightwalletd.com:9067
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Change lightwalletd server"
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        match args.len() {
            0 => {
                lightclient.set_server(http::Uri::default());
                "server set".to_string()
            }
            1 => match http::Uri::from_str(args[0]) {
                Ok(uri) => {
                    lightclient.set_server(uri);
                    "server set"
                }
                Err(_) => match args[0] {
                    "" => {
                        lightclient.set_server(http::Uri::default());
                        "server set"
                    }
                    _ => "invalid server uri",
                },
            }
            .to_string(),
            _ => self.help().to_string(),
        }
    }
}

struct GetBirthdayCommand {}
impl Command for GetBirthdayCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Introspect over wallet value transfers, and report the lowest observed block height.
            Usage:
            get_birthday

            Example:
            get_birthday
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Get wallet birthday."
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move { lightclient.wallet.lock().await.birthday.to_string() })
    }
}

struct WalletKindCommand {}
impl Command for WalletKindCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Displays the kind of wallet currently loaded
            If a Ufvk, displays what pools are supported.
            Currently, spend-capable wallets will always have spend capability for all three pools
            "#}
    }

    fn short_help(&self) -> &'static str {
        "Displays the kind of wallet currently loaded"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            if lightclient.do_seed_phrase().await.is_ok() {
                object! {"kind" => "Loaded from seed phrase",
                        "transparent" => true,
                        "sapling" => true,
                        "orchard" => true,
                }
                .pretty(4)
            } else {
                match &lightclient.wallet.lock().await.unified_key_store {
                    UnifiedKeyStore::Spend(_) => object! {
                        "kind" => "Loaded from unified spending key",
                        "transparent" => true,
                        "sapling" => true,
                        "orchard" => true,
                    }
                    .pretty(4),
                    UnifiedKeyStore::View(ufvk) => object! {
                        "kind" => "Loaded from unified full viewing key",
                        "transparent" => ufvk.transparent().is_some(),
                        "sapling" => ufvk.sapling().is_some(),
                        "orchard" => ufvk.orchard().is_some(),
                    }
                    .pretty(4),
                    UnifiedKeyStore::Empty => object! {
                        "kind" => "No keys found",
                        "transparent" => false,
                        "sapling" => false,
                        "orchard" => false,
                    }
                    .pretty(4),
                }
            }
        })
    }
}

struct ParseAddressCommand {}
impl Command for ParseAddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Parse an address
            Usage:
            parse_address <address>

            Example
            parse_address tmSwk8bjXdCgBvpS8Kybk5nUyE21QFcDqre
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Parse an address"
    }

    fn exec(&self, args: &[&str], _lightclient: &mut LightClient) -> String {
        if args.len() > 1 || args.is_empty() {
            return self.help().to_string();
        }
        fn make_decoded_chain_pair(
            address: &str,
        ) -> Option<(
            zcash_client_backend::address::Address,
            crate::config::ChainType,
        )> {
            [
                crate::config::ChainType::Mainnet,
                crate::config::ChainType::Testnet,
                crate::config::ChainType::Regtest(
                    crate::config::RegtestNetwork::all_upgrades_active(),
                ),
            ]
            .iter()
            .find_map(|chain| Address::decode(chain, address).zip(Some(*chain)))
        }
        if let Some((recipient_address, chain_name)) = make_decoded_chain_pair(args[0]) {
            let chain_name_string = match chain_name {
                crate::config::ChainType::Mainnet => "main",
                crate::config::ChainType::Testnet => "test",
                crate::config::ChainType::Regtest(_) => "regtest",
            };
            match recipient_address {
                Address::Sapling(_) => object! {
                    "status" => "success",
                    "chain_name" => chain_name_string,
                    "address_kind" => "sapling",
                }
                .to_string(),
                Address::Transparent(_) => object! {
                    "status" => "success",
                    "chain_name" => chain_name_string,
                    "address_kind" => "transparent",
                }
                .to_string(),
                Address::Tex(_) => object! {
                    "status" => "success",
                    "chain_name" => chain_name_string,
                    "address_kind" => "tex",
                }
                .to_string(),
                Address::Unified(ua) => {
                    let mut receivers_available = vec![];
                    if ua.sapling().is_some() {
                        receivers_available.push("sapling")
                    }
                    if ua.transparent().is_some() {
                        receivers_available.push("transparent")
                    }
                    if ua.orchard().is_some() {
                        receivers_available.push("orchard");
                        object! {
                            "status" => "success",
                            "chain_name" => chain_name_string,
                            "address_kind" => "unified",
                            "receivers_available" => receivers_available,
                            "only_orchard_ua" => zcash_keys::address::UnifiedAddress::from_receivers(ua.orchard().cloned(), None, None).expect("To construct UA").encode(&chain_name),
                        }
                        .to_string()
                    } else {
                        object! {
                            "status" => "success",
                            "chain_name" => chain_name_string,
                            "address_kind" => "unified",
                            "receivers_available" => receivers_available,
                        }
                        .to_string()
                    }
                }
            }
        } else {
            object! {
                "status" => "Invalid address",
                "chain_name" => json::JsonValue::Null,
                "address_kind" => json::JsonValue::Null,
            }
            .to_string()
        }
    }
}

struct ParseViewKeyCommand {}
impl Command for ParseViewKeyCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Parse a View Key
            Usage:
            parse_viewkey viewing_key

            Example
            parse_viewkey uviewregtest1l6s73mncrefycjhksvcp3zd6x2rpwddewv852ms8w0j828wu77h8v07fs6ph68kyp0ujwk4qmr3w4v9js4mr3ufqyasr0sddgumzyjamcgreda44kxtv4ar084szez337ld58avd9at4r5lptltgkn6uayzd055upf8cnlkarnxp69kz0vzelfww08xxhm0q0azdsplxff0mn2yyve88jyl8ujfau66pnc37skvl9528zazztf6xgk8aeewswjg4eeahpml77cxh57spgywdsc99h99twmp8sqhmp7g78l3g90equ2l4vh9vy0va6r8p568qr7nm5l5y96qgwmw9j2j788lalpeywy0af86krh4td69xqrrye6dvfx0uff84s3pm50kqx3tg3ktx88j2ujswe25s7pqvv3w4x382x07w0dp5gguqu757wlyf80f5nu9uw7wqttxmvrjhkl22x43de960c7kt97ge0dkt52j7uckht54eq768
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Parse a view_key."
    }

    fn exec(&self, args: &[&str], _lightclient: &mut LightClient) -> String {
        match args.len() {
            1 => json::stringify_pretty(
                match Ufvk::decode(args[0]) {
                    Ok((network, ufvk)) => {
                        let mut pools_available = vec![];
                        for fvk in ufvk.items_as_parsed() {
                            match fvk {
                            zcash_address::unified::Fvk::Orchard(_) => {
                                pools_available.push("orchard")
                            }
                            zcash_address::unified::Fvk::Sapling(_) => {
                                pools_available.push("sapling")
                            }
                            zcash_address::unified::Fvk::P2pkh(_) => {
                                pools_available.push("transparent")
                            }
                            zcash_address::unified::Fvk::Unknown { .. } => pools_available
                                .push("Unknown future protocol. Perhaps you're using old software"),
                        }
                        }
                        object! {
                            "status" => "success",
                            "chain_name" => match network {
                                NetworkType::Main => "main",
                                NetworkType::Test => "test",
                                NetworkType::Regtest => "regtest",
                            },
                            "address_kind" => "ufvk",
                            "pools_available" => pools_available,
                        }
                    }
                    Err(_) => {
                        object! {
                            "status" => "Invalid viewkey",
                            "chain_name" => json::JsonValue::Null,
                            "address_kind" => json::JsonValue::Null
                        }
                    }
                },
                4,
            ),
            _ => self.help().to_string(),
        }
    }
}

struct SyncCommand {}
impl Command for SyncCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Launches a task for syncing the wallet to the latest state of the block chain.

            Sub-commands:
            `run` starts or resumes sync.
            `pause` pauses scanning until sync is resumed.
            `stop` shuts down sync before its complete.
            `status` returns a report of the wallet's current sync status.
            `poll` polls the sync task handle, returning a sync result if complete. If sync failed, returns the error
            instead. Poll is not intended to be called manually for zingo-cli.

            Usage:
            sync run
            sync pause
            sync stop
            sync status
            sync poll

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Sync the wallet to the latest state of the blockchain."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() != 1 {
            return "Error: sync command expects 1 argument. Type \"help sync\" for usage."
                .to_string();
        }

        match args[0] {
            "run" => {
                if lightclient.sync_mode() == SyncMode::Paused {
                    lightclient.resume_sync().expect("sync should be paused");
                    "Resuming sync task...".to_string()
                } else {
                    RT.block_on(async move {
                        match lightclient.sync().await {
                            Ok(_) => "Launching sync task...".to_string(),
                            Err(e) => format!("Error: {e}"),
                        }
                    })
                }
            }
            "pause" => match lightclient.pause_sync() {
                Ok(_) => "Pausing sync task...".to_string(),
                Err(e) => format!("Error: {e}"),
            },
            "stop" => match lightclient.stop_sync() {
                Ok(_) => "Stopping sync task...".to_string(),
                Err(e) => format!("Error: {e}"),
            },
            "status" => RT.block_on(async move {
                match pepper_sync::sync_status(&*lightclient.wallet.lock().await).await {
                    Ok(status) => json::JsonValue::from(status).pretty(2),
                    Err(e) => format!("Error: {e}"),
                }
            }),
            "poll" => match lightclient.poll_sync() {
                PollReport::NoHandle => "Sync task has not been launched.".to_string(),
                PollReport::NotReady => "Sync task is not complete.".to_string(),
                PollReport::Ready(result) => match result {
                    Ok(sync_result) => sync_result.to_string(),
                    Err(e) => format!("Error: {e}"),
                },
            },
            _ => "Error: invalid sub-command. Type \"help sync\" for usage.".to_string(),
        }
    }
}

struct SendProgressCommand {}
impl Command for SendProgressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Get the progress of any send transactions that are currently computing
            Usage:
            sendprogress
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Get the progress of any send transactions that are currently computing"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(
            async move { json::JsonValue::from(lightclient.send_progress().await).pretty(2) },
        )
    }
}

struct RescanCommand {}
impl Command for RescanCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Rescan the wallet, clearing all wallet data obtained from the blockchain and launching sync from the wallet
            birthday.

            Usage:
            rescan
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Rescan the wallet, clearing all wallet data obtained from the blockchain and launching sync from the wallet
        birthday."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if !args.is_empty() {
            return "Error: rescan command expects no arguments. Type \"rescan help\" for usage."
                .to_string();
        }

        RT.block_on(async move {
            match lightclient.rescan().await {
                Ok(_) => "Launching rescan...".to_string(),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct ClearCommand {}
impl Command for ClearCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Clear the wallet state, rolling back the wallet to an empty state.
            Usage:
            clear

            This command will clear all notes, utxos and transactions from the wallet, setting up the wallet to be synced from scratch.
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Clear the wallet state, rolling back the wallet to an empty state."
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            lightclient.wallet.lock().await.clear_all();

            let result = object! { "result" => "success" };
            result.pretty(2)
        })
    }
}

/// TODO: Add Doc Comment Here!
pub struct HelpCommand {}
impl Command for HelpCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            List all available commands
            Usage:
            help [command_name]

            If no "command_name" is specified, a list of all available commands is returned
            Example:
            help send

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Lists all available commands"
    }

    fn exec(&self, args: &[&str], _: &mut LightClient) -> String {
        let mut responses = vec![];

        // Print a list of all commands
        match args.len() {
            0 => {
                responses.push("Available commands:".to_string());
                get_commands().iter().for_each(|(cmd, obj)| {
                    responses.push(format!("{} - {}", cmd, obj.short_help()));
                });

                responses.sort();
                responses.join("\n")
            }
            1 => match get_commands().get(args[0]) {
                Some(cmd) => cmd.help().to_string(),
                None => format!("Command {} not found", args[0]),
            },
            _ => self.help().to_string(),
        }
    }
}

impl ShortCircuitedCommand for HelpCommand {
    fn exec_without_lc(args: Vec<String>) -> String {
        let mut responses = vec![];

        // Print a list of all commands
        match args.len() {
            0 => {
                responses.push("Available commands:".to_string());
                get_commands().iter().for_each(|(cmd, obj)| {
                    responses.push(format!("{} - {}", cmd, obj.short_help()));
                });

                responses.sort();
                responses.join("\n")
            }
            1 => match get_commands().get(args[0].as_str()) {
                Some(cmd) => cmd.help().to_string(),
                None => format!("Command {} not found", args[0]),
            },
            _ => panic!("Unexpected number of parameters."),
        }
    }
}

struct InfoCommand {}
impl Command for InfoCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Get info about the lightwalletd we're connected to
            Usage:
            info

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Get the lightwalletd server's info"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move { lightclient.do_info().await })
    }
}

struct CurrentPriceCommand {}
impl Command for CurrentPriceCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Updates and returns current price of ZEC.
            Currently only supports USD.

            To fetch prices via tor, it must be enabled with the `--tor` flag on startup.
            Tor is used to protect the user's IP address but may be unlawful in some countries. Use at your own discretion.

            Usage:
            current_price

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Updates and returns current price of ZEC."
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            match lightclient
                .wallet
                .lock()
                .await
                .update_current_price(lightclient.tor_client())
                .await
            {
                Ok(price) => format!("current price: {price}"),
                Err(e) => format!("error: {e}"),
            }
        })
    }
}

/// assumed by consumers to be JSON
struct BalanceCommand {}
impl Command for BalanceCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Return the current ZEC balance in the wallet as a JSON object.

            Transparent and Shielded balances, along with the addresses they belong to are displayed
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Return the current ZEC balance in the wallet"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            serde_json::to_string_pretty(&lightclient.do_balance().await).expect("infallible")
        })
    }
}

struct PrintBalanceCommand {}
impl Command for PrintBalanceCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Show the current ZEC balance in the wallet
            Usage:
            balance

            Transparent and Shielded balances, along with the addresses they belong to are displayed
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show the current ZEC balance in the wallet"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move { lightclient.do_balance().await.to_string() })
    }
}

struct SpendableBalanceCommand {}
impl Command for SpendableBalanceCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Display the wallet's spendable balance.
            Calculated as the confirmed shielded balance minus the fee required to send all funds to
            the given address.
            An address must be specified as fees, and therefore spendable balance, depends on the receiver
            type.
            zennies_for_zingo must also be specified as "true"|"false".  If set to "true" 1_000_000 ZAT will
            earmarked to the zingolabs developer fund with each transaction.

            Usage:
            spendablebalance <address>
            OR
            spendablebalance { "address": "<address>", "zennies_for_zingo": <true|false> }

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Display the wallet's spendable balance."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        let (address, zennies_for_zingo) = match utils::parse_spendable_balance_args(args) {
            Ok(address_and_zennies) => address_and_zennies,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help spendablebalance' for correct usage and examples.",
                    e
                );
            }
        };
        RT.block_on(async move {
            match lightclient
                .get_spendable_shielded_balance(address, zennies_for_zingo)
                .await
            {
                Ok(bal) => {
                    object! {
                        "balance" => bal.into_u64(),
                    }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct AddressCommand {}
impl Command for AddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            List current addresses in the wallet, shielded excludes t-addresses.
            Usage:
            addresses [shielded|orchard]

        "#}
    }

    fn short_help(&self) -> &'static str {
        "List all addresses in the wallet"
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        use crate::lightclient::describe::UAReceivers;
        match args.len() {
            0 => RT.block_on(
                async move { lightclient.do_addresses(UAReceivers::All).await.pretty(2) },
            ),
            1 => match args[0] {
                "shielded" => RT.block_on(async move {
                    lightclient
                        .do_addresses(UAReceivers::Shielded)
                        .await
                        .pretty(2)
                }),
                "orchard" => RT.block_on(async move {
                    lightclient
                        .do_addresses(UAReceivers::Orchard)
                        .await
                        .pretty(2)
                }),
                _ => self.help().to_string(),
            },
            _ => self.help().to_string(),
        }
    }
}

struct ExportUfvkCommand {}
impl Command for ExportUfvkCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Export Unified full viewing key for the wallet.
            Note: If you want to backup spend capability, use the 'seed' command instead.
            Usage:
            exportufvk

            Example:
            exportufvk
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Export full viewing key for wallet addresses"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            let wallet = lightclient.wallet.lock().await;
            let ufvk: UnifiedFullViewingKey = match (&wallet.unified_key_store).try_into() {
                Ok(ufvk) => ufvk,
                Err(e) => return e.to_string(),
            };
            object! {
                "ufvk" => ufvk.encode(&wallet.network),
                "birthday" => u32::from(wallet.birthday)
            }
            .pretty(2)
        })
    }
}

struct SendCommand {}
impl Command for SendCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Propose a transfer of ZEC to the given address(es).
            The fee required to send this transaction will be added to the proposal and displayed to the user.
            The 'confirm' command must be called to complete and broadcast the proposed transaction(s).

            Usage:
                send <address> <amount in zatoshis> "<optional memo>"
                OR
                send '[{"address":"<address>", "amount":<amount in zatoshis>, "memo":"<optional memo>"}, ...]'
            Example:
                send ztestsapling1x65nq4dgp0qfywgxcwk9n0fvm4fysmapgr2q00p85ju252h6l7mmxu2jg9cqqhtvzd69jwhgv8d 200000 "Hello from the command line"
                confirm

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Propose a transfer of ZEC to the given address(es) and display a proposal for confirmation."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        let receivers = match utils::parse_send_args(args) {
            Ok(receivers) => receivers,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help send' for correct usage and examples.",
                    e
                );
            }
        };
        let request = match crate::data::receivers::transaction_request_from_receivers(receivers) {
            Ok(request) => request,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help send' for correct usage and examples.",
                    e
                );
            }
        };
        RT.block_on(async move {
            match lightclient.propose_send(request).await {
                Ok(proposal) => {
                    let fee = match crate::data::proposal::total_fee(&proposal) {
                        Ok(fee) => fee,
                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
                    };
                    object! { "fee" => fee.into_u64() }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct SendAllCommand {}
impl Command for SendAllCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Propose to transfer all ZEC from shielded pools to a given address.
            The fee required to send this transaction will be added to the proposal and displayed to the user.
            The 'confirm' command must be called to complete and broadcast the proposed transaction(s).
            If invoked with a JSON arg "zennies_for_zingo" must be specified, if set to 'true' 1_000_000 ZAT
            will be sent to the zingolabs developer address with each transaction.

            Warning:
                Does not send transparent funds. These funds must be shielded first. Type `help shield` for more information.
            Usage:
                sendall <address> "<optional memo>"
                OR
                sendall '{ "address": "<address>", "memo": "<optional memo>", "zennies_for_zingo": <true|false> }'
            Example:
                sendall ztestsapling1x65nq4dgp0qfywgxcwk9n0fvm4fysmapgr2q00p85ju252h6l7mmxu2jg9cqqhtvzd69jwhgv8d "Sending all funds"
                confirm

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Propose to transfer all ZEC from shielded pools to a given address and display a proposal for confirmation."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        let (address, zennies_for_zingo, memo) = match utils::parse_send_all_args(args) {
            Ok(parse_results) => parse_results,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help sendall' for correct usage and examples.",
                    e
                );
            }
        };
        RT.block_on(async move {
            match lightclient
                .propose_send_all(address, zennies_for_zingo, memo)
                .await
            {
                Ok(proposal) => {
                    let amount = match proposal::total_payment_amount(&proposal) {
                        Ok(amount) => amount,
                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
                    };
                    let fee = match proposal::total_fee(&proposal) {
                        Ok(fee) => fee,
                        Err(e) => return object! { "error" => e.to_string() }.pretty(2),
                    };
                    object! {
                        "amount" => amount.into_u64(),
                        "fee" => fee.into_u64(),
                    }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct QuickSendCommand {}
impl Command for QuickSendCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Send ZEC to the given address(es). Combines `send` and `confirm` into a single command.
            The fee required to send this transaction is additionally deducted from your balance.
            Warning:
                Transaction(s) will be sent without the user being aware of the fee amount.
            Usage:
                quicksend <address> <amount in zatoshis> "<optional memo>"
                OR
                quicksend '[{"address":"<address>", "amount":<amount in zatoshis>, "memo":"<optional memo>"}, ...]'
            Example:
                quicksend ztestsapling1x65nq4dgp0qfywgxcwk9n0fvm4fysmapgr2q00p85ju252h6l7mmxu2jg9cqqhtvzd69jwhgv8d 200000 "Hello from the command line"

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Send ZEC to the given address(es). Combines `send` and `confirm` into a single command."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        let receivers = match utils::parse_send_args(args) {
            Ok(receivers) => receivers,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help quicksend' for correct usage and examples.",
                    e
                );
            }
        };
        let request = match crate::data::receivers::transaction_request_from_receivers(receivers) {
            Ok(request) => request,
            Err(e) => {
                return format!(
                    "Error: {}\nTry 'help quicksend' for correct usage and examples.",
                    e
                );
            }
        };
        RT.block_on(async move {
            match lightclient.quick_send(request).await {
                Ok(txids) => {
                    object! { "txids" => txids.iter().map(|txid| txid.to_string()).collect::<Vec<_>>() }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct ShieldCommand {}
impl Command for ShieldCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Propose a shield of transparent funds to the orchard pool.
            The fee required to send this transaction will be added to the proposal and displayed to the user.
            The 'confirm' command must be called to complete and broadcast the proposed shield.

            Usage:
                shield
            Example:
                shield
                confirm

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Propose a shield of transparent funds to the orchard pool and display a proposal for confirmation.."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if !args.is_empty() {
            return format!(
                "Error: {}\nTry 'help shield' for correct usage and examples.",
                error::CommandError::InvalidArguments
            );
        }

        RT.block_on(async move {
            match lightclient.propose_shield().await {
                Ok(proposal) => {
                    if proposal.steps().len() != 1 {
                        return object! { "error" => "shielding transactions should not have multiple proposal steps" }.pretty(2);
                    }
                    let step = proposal.steps().first();
                    let Some(value_to_shield) = step
                        .balance()
                        .proposed_change()
                        .iter()
                        .try_fold(Zatoshis::ZERO, |acc, c| acc + c.value()) else {
                            return object! { "error" => "shield amount outside valid range of zatoshis" }
                                .pretty(2);
                    };
                    let fee = step.balance().fee_required();
                    object! {
                        "value_to_shield" => value_to_shield.into_u64(),
                        "fee" => fee.into_u64(),
                    }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct QuickShieldCommand {}
impl Command for QuickShieldCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Shield transparent funds to the orchard pool. Combines `shield` and `confirm` into a single command.
            The fee required to send this transaction is additionally deducted from your balance.
            Warning:
                Transaction(s) will be sent without the user being aware of the fee amount.
            Usage:
                quickshield

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Shield transparent funds to the orchard pool. Combines `shield` and `confirm` into a single command."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if !args.is_empty() {
            return format!(
                "Error: {}\nTry 'help shield' for correct usage and examples.",
                error::CommandError::InvalidArguments
            );
        }

        RT.block_on(async move {
            match lightclient
                .quick_shield()
                .await {
                Ok(txids) => {
                    object! { "txids" => txids.iter().map(|txid| txid.to_string()).collect::<Vec<_>>() }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct ConfirmCommand {}
impl Command for ConfirmCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Confirms the latest proposal, completing and broadcasting the transaction(s).
            Fails if a proposal has not already been created with the 'send', 'send_all' or 'shield' commands.
            Type 'help send', 'help sendall' or 'help shield' for more information on creating proposals.

            Usage:
                confirm
            Example:
                send ztestsapling1x65nq4dgp0qfywgxcwk9n0fvm4fysmapgr2q00p85ju252h6l7mmxu2jg9cqqhtvzd69jwhgv8d 200000 "Hello from the command line"
                confirm

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Confirms the latest proposal, completing and broadcasting the transaction(s)."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if !args.is_empty() {
            return format!(
                "Error: {}\nTry 'help confirm' for correct usage and examples.",
                error::CommandError::InvalidArguments
            );
        }

        RT.block_on(async move {
            match lightclient
                .send_stored_proposal()
                .await {
                Ok(txids) => {
                    object! { "txids" => txids.iter().map(|txid| txid.to_string()).collect::<Vec<_>>() }
                }
                Err(e) => {
                    object! { "error" => e.to_string() }
                }
            }
            .pretty(2)
        })
    }
}

struct ResendCommand {}
impl Command for ResendCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Re-transmits a calculated transaction from the wallet with the given txid.
            This is a manual operation so the user has the option to alternatively use the "remove_transaction" command
            to remove the calculated transaction in the case of send failure.

            usage:
            resend <txid>

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Re-transmits a calculated transaction from the wallet with the given txid."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() != 1 {
            return "Error: resend command expects 1 argument. Type \"help resend\" for usage."
                .to_string();
        }

        let txid = match txid_from_hex_encoded_str(args[0]) {
            Ok(txid) => txid,
            Err(e) => return format!("Error: {e}"),
        };

        RT.block_on(async move {
            match lightclient.resend(txid).await {
                Ok(_) => "Successfully resent transaction.".to_string(),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

// TODO: add a decline command which deletes latest proposal?

struct DeleteCommand {}
impl Command for DeleteCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Delete the wallet from disk
            Usage:
            delete

            The wallet is deleted from disk. If you want to use another wallet first you need to remove the existing wallet file

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Delete wallet file from disk"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            match lightclient.do_delete().await {
                Ok(_) => {
                    let r = object! { "result" => "success",
                    "wallet_path" => lightclient.config.get_wallet_path().to_str().expect("should be valid UTF-8") };
                    r.pretty(2)
                }
                Err(e) => {
                    let r = object! {
                        "result" => "error",
                        "error" => e
                    };
                    r.pretty(2)
                }
            }
        })
    }
}

struct SeedCommand {}
impl Command for SeedCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Show the wallet's seed phrase
            Usage:
            seed

            Your wallet is entirely recoverable from the seed phrase. Please save it carefully and don't share it with anyone

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Display the seed phrase"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            match lightclient.do_seed_phrase().await {
                Ok(m) => serde_json::to_string_pretty(&m).expect("infallible"),
                Err(e) => object! { "error" => e }.pretty(2),
            }
        })
    }
}

struct ValueTransfersCommand {}
impl Command for ValueTransfersCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            List all value transfers for this wallet.
            A value transfer is a group of all notes to a specific receiver in a transaction.

            Usage:
            valuetransfers [bool]
        "#}
    }

    fn short_help(&self) -> &'static str {
        "List all value transfers for this wallet."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() > 1 {
            return "Error: invalid arguments\nTry 'help valuetransfers' for correct usage and examples"
                .to_string();
        }

        let newer_first = args
            .first()
            .map(|s| s.parse())
            .unwrap_or(Ok(false))
            .unwrap_or(false);

        RT.block_on(async move {
            match lightclient.sorted_value_transfers(newer_first).await {
                Ok(value_transfers) => value_transfers.to_string(),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct MessagesFilterCommand {}
impl Command for MessagesFilterCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            List memo-containing value transfers sent to/from wallet. If an address is provided,
            only messages to/from that address will be provided. If a string is provided,
            messages containing that string are displayed. Otherwise, all memos are displayed.
            Currently, for received messages, this relies on the reply-to address contained in the memo.
            A value transfer is a group of all notes to a specific receiver in a transaction.

            Usage:
            messages [address]/[string]
        "#}
    }

    fn short_help(&self) -> &'static str {
        "List memos for this wallet."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() > 1 {
            return "Error: invalid arguments\nTry 'help messages' for correct usage and examples"
                .to_string();
        }

        RT.block_on(async move {
            match lightclient.messages_containing(args.first().copied()).await {
                Ok(value_transfers) => json::JsonValue::from(value_transfers).pretty(2),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct TransactionsCommand {}
impl Command for TransactionsCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Provides a list of transaction summaries related to this wallet in order of blockheight.

            Usage:
            transactions
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Provides a list of transaction summaries related to this wallet in order of blockheight."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if !args.is_empty() {
            return "Error: invalid arguments\nTry 'help transactions' for correct usage and examples"
                .to_string();
        }
        RT.block_on(async move {
            match lightclient.transaction_summaries().await {
                Ok(transactions) => transactions.to_string(),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct MemoBytesToAddressCommand {}
impl Command for MemoBytesToAddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Get an object where keys are addresses and values are total bytes of memo sent to that address.
            usage:
            memobytes_to_address
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show by address memo_bytes transfers for this seed."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() > 1 {
            return format!("didn't understand arguments\n{}", self.help());
        }

        RT.block_on(async move {
            match lightclient.do_total_memobytes_to_address().await {
                Ok(total_memo_bytes) => json::JsonValue::from(total_memo_bytes).pretty(2),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct ValueToAddressCommand {}
impl Command for ValueToAddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Get an object where keys are addresses and values are total value sent to that address.
            usage:
            value_to_address
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show by address value transfers for this seed."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() > 1 {
            return format!("didn't understand arguments\n{}", self.help());
        }

        RT.block_on(async move {
            match lightclient.do_total_value_to_address().await {
                Ok(total_values) => json::JsonValue::from(total_values).pretty(2),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct SendsToAddressCommand {}
impl Command for SendsToAddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Get an object where keys are addresses and values are total value sent to that address.
            usage:
            sends_to_address
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show by address number of sends for this seed."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() > 1 {
            return format!("didn't understand arguments\n{}", self.help());
        }

        RT.block_on(async move {
            match lightclient.do_total_spends_to_address().await {
                Ok(total_spends) => json::JsonValue::from(total_spends).pretty(2),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

// TODO: zingo2
// struct SetOptionCommand {}
// impl Command for SetOptionCommand {
//     fn help(&self) -> &'static str {
//         indoc! {r#"
//             Set a wallet option
//             Usage:
//             setoption <optionname>=<optionvalue>
//             List of available options:
//             download_memos : none | wallet | all

//         "#}
//     }

//     fn short_help(&self) -> &'static str {
//         "Set a wallet option"
//     }

//     fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
//         if args.len() != 1 {
//             return format!("Error: Need exactly 1 argument\n\n{}", self.help());
//         }

//         let option = args[0];
//         let values: Vec<&str> = option.split('=').collect();

//         if values.len() != 2 {
//             return "Error: Please set option value like: <optionname>=<optionvalue>".to_string();
//         }

//         let option_name = values[0];
//         let option_value = values[1];

//         RT.block_on(async move {
//             match option_name {
//                 "download_memos" => match option_value {
//                     "none" => {
//                         lightclient
//                             .wallet
//                             .set_download_memo(MemoDownloadOption::NoMemos)
//                             .await
//                     }
//                     "wallet" => {
//                         lightclient
//                             .wallet
//                             .set_download_memo(MemoDownloadOption::WalletMemos)
//                             .await
//                     }
//                     "all" => {
//                         lightclient
//                             .wallet
//                             .set_download_memo(MemoDownloadOption::AllMemos)
//                             .await
//                     }
//                     _ => {
//                         return format!(
//                             "Error: Couldn't understand {} value {}",
//                             option_name, option_value
//                         )
//                     }
//                 },
//                 "transaction_filter_threshold" => match option_value.parse() {
//                     Ok(number) => {
//                         lightclient
//                             .wallet
//                             .wallet_options
//                             .write()
//                             .await
//                             .transaction_size_filter = Some(number)
//                     }
//                     Err(e) => return format!("Error {e}, couldn't parse {option_value} as number"),
//                 },
//                 _ => return format!("Error: Couldn't understand {}", option_name),
//             }

//             let r = object! {
//                 "success" => true
//             };

//             r.pretty(2)
//         })
//     }
// }

// TODO: zingo2
// struct GetOptionCommand {}
// impl Command for GetOptionCommand {
//     fn help(&self) -> &'static str {
//         indoc! {r#"
//             Get a wallet option
//             Argument is either "download_memos" and "transaction_filter_threshold"

//             Usage:
//             getoption <optionname>

//         "#}
//     }

//     fn short_help(&self) -> &'static str {
//         "Get a wallet option"
//     }

//     fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
//         if args.len() != 1 {
//             return format!("Error: Need exactly 1 argument\n\n{}", self.help());
//         }

//         let option_name = args[0];

//         RT.block_on(async move {
//             let value = match option_name {
//                 "download_memos" => match lightclient
//                     .wallet
//                     .wallet_options
//                     .read()
//                     .await
//                     .download_memos
//                 {
//                     MemoDownloadOption::NoMemos => "none".to_string(),
//                     MemoDownloadOption::WalletMemos => "wallet".to_string(),
//                     MemoDownloadOption::AllMemos => "all".to_string(),
//                 },
//                 "transaction_filter_threshold" => lightclient
//                     .wallet
//                     .wallet_options
//                     .read()
//                     .await
//                     .transaction_size_filter
//                     .map(|filter| filter.to_string())
//                     .unwrap_or("No filter".to_string()),
//                 _ => return format!("Error: Couldn't understand {}", option_name),
//             };

//             let r = object! {
//                 option_name => value
//             };

//             r.pretty(2)
//         })
//     }
// }

struct HeightCommand {}
impl Command for HeightCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Returns the blockchain height at the time the wallet last requested the latest block height from the server.

            Usage:
            height

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Returns the blockchain height at the time the wallet last requested the latest block height from the server."
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        RT.block_on(async move {
            object! { "height" => json::JsonValue::from(lightclient.wallet.lock().await.sync_state.wallet_height().map(u32::from).unwrap_or(0))}.pretty(2)
        })
    }
}

struct NewAddressCommand {}
impl Command for NewAddressCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Create a new address in this wallet
            Usage:
            new [z | t | o]

            Example:
            To create a new z address:
            new z
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Create a new address in this wallet"
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() != 1 {
            return format!("No address type specified\n{}", self.help());
        }

        RT.block_on(async move {
            match lightclient.do_new_address(args[0]).await {
                Ok(j) => j,
                Err(e) => object! { "error" => e },
            }
            .pretty(2)
        })
    }
}

struct NotesCommand {}
impl Command for NotesCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Show all notes (shielded outputs) in this wallet
            Usage:
            notes [all]
            If you supply the "all" parameter, all spent notes are also included
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show all notes (shielded outputs) in this wallet"
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        // Parse the args.
        if args.len() > 1 {
            return self.short_help().to_string();
        }

        // Make sure we can parse the amount
        let all_notes = if args.len() == 1 {
            match args[0] {
                "all" => true,
                a => {
                    return format!(
                        "Invalid argument \"{}\". Specify 'all' to include spent notes",
                        a
                    );
                }
            }
        } else {
            false
        };

        RT.block_on(async move {
            let wallet = lightclient.wallet.lock().await;

            json::object! {
                "orchard_notes" => json::JsonValue::from(wallet.note_summaries::<OrchardNote>(all_notes)),
                "sapling_notes" => json::JsonValue::from(wallet.note_summaries::<SaplingNote>(all_notes)),
            }
            .pretty(2)
        })
    }
}

struct CoinsCommand {}
impl Command for CoinsCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Show all coins (transparent outputs) in this wallet
            Usage:
            notes [all]
            If you supply the "all" parameter, all spent coins are also included
        "#}
    }

    fn short_help(&self) -> &'static str {
        "Show all coins (transparent outputs) in this wallet"
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        // Parse the args.
        if args.len() > 1 {
            return self.short_help().to_string();
        }

        // Make sure we can parse the amount
        let all_coins = if args.len() == 1 {
            match args[0] {
                "all" => true,
                a => {
                    return format!(
                        "Invalid argument \"{}\". Specify 'all' to include spent coins",
                        a
                    );
                }
            }
        } else {
            false
        };

        RT.block_on(async move {
            json::object! {
                "transparent_coins" => json::JsonValue::from(lightclient.wallet.lock().await.coin_summaries(all_coins)),
            }
            .pretty(2)
        })
    }
}

struct RemoveTransactionCommand {}
impl Command for RemoveTransactionCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Removes an unconfirmed transaction from the wallet with the given txid.
            This is useful when a send fails and the pending spent outputs should be reset to unspent instead of using
            the "resend" command to attempt to re-transmit.
            This is a manual operation so important information such as memos are retained in the case of send failure
            until the user decides to remove them or resend.

            usage:
            remove_transaction <txid>

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Removes an unconfirmed transaction from the wallet with the given txid."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() != 1 {
            return "Error: remove command expects 1 argument. Type \"help remove\" for usage."
                .to_string();
        }

        let txid = match txid_from_hex_encoded_str(args[0]) {
            Ok(txid) => txid,
            Err(e) => return format!("Error: {e}"),
        };

        RT.block_on(async move {
            match lightclient
                .wallet
                .lock()
                .await
                .remove_unconfirmed_transaction(txid)
            {
                Ok(_) => "Successfully removed transaction.".to_string(),
                Err(e) => format!("Error: {e}"),
            }
        })
    }
}

struct SaveCommand {}
impl Command for SaveCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Launches a save task which saves the wallet to persistance when the wallet state changes.
            Not intended to be called manually.

            usage:
            save run
            save check
            save shutdown

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Launches a save task. Not intended to be called manually."
    }

    fn exec(&self, args: &[&str], lightclient: &mut LightClient) -> String {
        if args.len() != 1 {
            return "Error: save command expects 1 argument. Type \"help save\" for usage."
                .to_string();
        }

        match args[0] {
            "run" => {
                RT.block_on(async move { lightclient.save_task().await });
                "Launching save task...".to_string()
            }
            "check" => match RT.block_on(async move { lightclient.check_save_error().await }) {
                Ok(_) => "".to_string(),
                Err(e) => {
                    format!("Error: save failed. {}\nRestarting save task...", e)
                }
            },
            "shutdown" => {
                match RT.block_on(async move { lightclient.shutdown_save_task().await }) {
                    Ok(_) => "Save task shutdown successfully.".to_string(),
                    Err(e) => {
                        format!("Error: save failed. {}", e)
                    }
                }
            }
            _ => "Error: invalid sub-command. Type \"help save\" for usage.".to_string(),
        }
    }
}

struct QuitCommand {}
impl Command for QuitCommand {
    fn help(&self) -> &'static str {
        indoc! {r#"
            Quit the light client
            Usage:
            quit

        "#}
    }

    fn short_help(&self) -> &'static str {
        "Quit the lightwallet, saving state to disk"
    }

    fn exec(&self, _args: &[&str], lightclient: &mut LightClient) -> String {
        let save_shutdown = do_user_command("save", &["shutdown"], lightclient);

        // before shutting down, shut down all child processes..
        // ...but only if the network being used is regtest.
        let o = RT.block_on(async move { lightclient.do_info().await });
        if o.contains("\"chain_name\": \"regtest\",") {
            use std::process::Command;

            // find zingo-cli's PID
            let cli_pid: u32 = std::process::id();

            // now find all child processes of this PID
            let raw_child_processes = Command::new("ps")
                .args(["--no-headers", "--ppid", &cli_pid.to_string()])
                .output()
                .expect("error running ps");

            let owned_child_processes: String = String::from_utf8(raw_child_processes.stdout)
                .expect("error unwrapping stdout of ps");
            let child_processes = owned_child_processes.split('\n').collect::<Vec<&str>>();

            // &str representation of PIDs
            let mut spawned_pids: Vec<&str> = Vec::new();

            for child in child_processes {
                if !child.is_empty() {
                    let ch: Vec<&str> = child.split_whitespace().collect();
                    spawned_pids.push(ch[0]);
                }
            }

            for pid in spawned_pids {
                Command::new("kill")
                    .arg(pid)
                    .output()
                    .expect("error while killing regtest-spawned processes!");
            }
        }
        format!("{}\nZingo CLI quit successfully.", save_shutdown)
    }
}

/// TODO: Add Doc Comment Here!
pub fn get_commands() -> HashMap<&'static str, Box<dyn Command>> {
    let mut entries: Vec<(&'static str, Box<dyn Command>)> = vec![
        ("version", Box::new(GetVersionCommand {})),
        ("sync", Box::new(SyncCommand {})),
        ("parse_address", Box::new(ParseAddressCommand {})),
        ("parse_viewkey", Box::new(ParseViewKeyCommand {})),
        ("changeserver", Box::new(ChangeServerCommand {})),
        ("rescan", Box::new(RescanCommand {})),
        ("clear", Box::new(ClearCommand {})),
        ("help", Box::new(HelpCommand {})),
        ("balance", Box::new(BalanceCommand {})),
        ("print_balance", Box::new(PrintBalanceCommand {})),
        ("addresses", Box::new(AddressCommand {})),
        ("height", Box::new(HeightCommand {})),
        ("sendprogress", Box::new(SendProgressCommand {})),
        ("valuetransfers", Box::new(ValueTransfersCommand {})),
        ("transactions", Box::new(TransactionsCommand {})),
        ("value_to_address", Box::new(ValueToAddressCommand {})),
        ("sends_to_address", Box::new(SendsToAddressCommand {})),
        ("messages", Box::new(MessagesFilterCommand {})),
        (
            "memobytes_to_address",
            Box::new(MemoBytesToAddressCommand {}),
        ),
        ("exportufvk", Box::new(ExportUfvkCommand {})),
        ("info", Box::new(InfoCommand {})),
        ("current_price", Box::new(CurrentPriceCommand {})),
        ("send", Box::new(SendCommand {})),
        ("resend", Box::new(ResendCommand {})),
        ("shield", Box::new(ShieldCommand {})),
        ("save", Box::new(SaveCommand {})),
        ("quit", Box::new(QuitCommand {})),
        ("notes", Box::new(NotesCommand {})),
        ("coins", Box::new(CoinsCommand {})),
        ("new", Box::new(NewAddressCommand {})),
        ("seed", Box::new(SeedCommand {})),
        ("get_birthday", Box::new(GetBirthdayCommand {})),
        ("wallet_kind", Box::new(WalletKindCommand {})),
        ("delete", Box::new(DeleteCommand {})),
        ("remove_transaction", Box::new(RemoveTransactionCommand {})),
    ];
    {
        entries.push(("spendablebalance", Box::new(SpendableBalanceCommand {})));
        entries.push(("sendall", Box::new(SendAllCommand {})));
        entries.push(("quicksend", Box::new(QuickSendCommand {})));
        entries.push(("quickshield", Box::new(QuickShieldCommand {})));
        entries.push(("confirm", Box::new(ConfirmCommand {})));
    }
    entries.into_iter().collect()
}

/// TODO: Add Doc Comment Here!
pub fn do_user_command(cmd: &str, args: &[&str], lightclient: &mut LightClient) -> String {
    match get_commands().get(cmd.to_ascii_lowercase().as_str()) {
        Some(cmd) => cmd.exec(args, lightclient),
        None => format!(
            "Unknown command : {}. Type 'help' for a list of commands",
            cmd
        ),
    }
}