-
Notifications
You must be signed in to change notification settings - Fork 2k
/
rpcwallet.cpp
6086 lines (5323 loc) · 276 KB
/
rpcwallet.cpp
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
// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin Core developers
// Copyright (c) 2016-2023 The Zcash developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or https://www.opensource.org/licenses/mit-license.php .
#include "amount.h"
#include "consensus/upgrades.h"
#include "consensus/params.h"
#include "consensus/validation.h"
#include "core_io.h"
#include "deprecation.h"
#include "experimental_features.h"
#include "init.h"
#include "key_io.h"
#include "main.h"
#include "net.h"
#include "netbase.h"
#include "proof_verifier.h"
#include "rpc/server.h"
#include "timedata.h"
#include "tinyformat.h"
#include "transaction_builder.h"
#include "util/system.h"
#include "util/match.h"
#include "util/moneystr.h"
#include "util/strencodings.h"
#include "util/string.h"
#include "wallet.h"
#include "walletdb.h"
#include "primitives/transaction.h"
#include "zcbenchmarks.h"
#include "script/interpreter.h"
#include "zcash/Zcash.h"
#include "zcash/Address.hpp"
#include "zcash/address/zip32.h"
#include "util/test.h"
#include "util/time.h"
#include "asyncrpcoperation.h"
#include "asyncrpcqueue.h"
#include "wallet/asyncrpcoperation_common.h"
#include "wallet/asyncrpcoperation_mergetoaddress.h"
#include "wallet/asyncrpcoperation_saplingmigration.h"
#include "wallet/asyncrpcoperation_sendmany.h"
#include "wallet/asyncrpcoperation_shieldcoinbase.h"
#include "wallet/wallet_tx_builder.h"
#include <stdint.h>
#include <boost/assign/list_of.hpp>
#include <boost/algorithm/string/trim.hpp>
#include <univalue.h>
#include <algorithm>
#include <numeric>
#include <optional>
#include <variant>
#include <rust/ed25519.h>
using namespace std;
using namespace libzcash;
const std::string ADDR_TYPE_SPROUT = "sprout";
const std::string ADDR_TYPE_SAPLING = "sapling";
const std::string ADDR_TYPE_ORCHARD = "orchard";
extern UniValue TxJoinSplitToJSON(const CTransaction& tx);
int64_t nWalletUnlockTime;
static CCriticalSection cs_nWalletUnlockTime;
// Private method:
UniValue z_getoperationstatus_IMPL(const UniValue&, bool);
std::string HelpRequiringPassphrase()
{
return pwalletMain && pwalletMain->IsCrypted()
? "\nRequires wallet passphrase to be set with walletpassphrase call."
: "";
}
bool EnsureWalletIsAvailable(bool avoidException)
{
if (!pwalletMain)
{
if (!avoidException)
throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Method not found (disabled)");
else
return false;
}
return true;
}
void EnsureWalletIsBackedUp(const CChainParams& params)
{
if (GetBoolArg("-walletrequirebackup", params.RequireWalletBackup()) && !pwalletMain->MnemonicVerified())
throw JSONRPCError(
RPC_WALLET_BACKUP_REQUIRED,
"Error: Please acknowledge that you have backed up the wallet's emergency recovery phrase "
"by using zcashd-wallet-tool first."
);
}
void EnsureWalletIsUnlocked()
{
if (pwalletMain->IsLocked())
throw JSONRPCError(RPC_WALLET_UNLOCK_NEEDED, "Error: Please enter the wallet passphrase with walletpassphrase first.");
}
void ThrowIfInitialBlockDownload()
{
if (IsInitialBlockDownload(Params().GetConsensus())) {
throw JSONRPCError(RPC_CLIENT_IN_INITIAL_DOWNLOAD, "Error: Sending transactions is not supported during initial block download.");
}
}
void WalletTxToJSON(const CWalletTx& wtx, UniValue& entry, const std::optional<int>& asOfHeight)
{
int confirms = wtx.GetDepthInMainChain(asOfHeight);
std::string status = "waiting";
entry.pushKV("confirmations", confirms);
if (wtx.IsCoinBase())
entry.pushKV("generated", true);
if (confirms > 0)
{
entry.pushKV("blockhash", wtx.hashBlock.GetHex());
entry.pushKV("blockindex", wtx.nIndex);
entry.pushKV("blocktime", mapBlockIndex[wtx.hashBlock]->GetBlockTime());
entry.pushKV("expiryheight", (int64_t)wtx.nExpiryHeight);
status = "mined";
}
else
{
const int height = chainActive.Height();
if (!IsExpiredTx(wtx, height) && IsExpiringSoonTx(wtx, height + 1))
status = "expiringsoon";
else if (IsExpiredTx(wtx, height))
status = "expired";
}
entry.pushKV("status", status);
uint256 hash = wtx.GetHash();
entry.pushKV("txid", hash.GetHex());
UniValue conflicts(UniValue::VARR);
for (const uint256& conflict : wtx.GetConflicts())
conflicts.push_back(conflict.GetHex());
entry.pushKV("walletconflicts", conflicts);
entry.pushKV("time", wtx.GetTxTime());
entry.pushKV("timereceived", (int64_t)wtx.nTimeReceived);
for (const std::pair<string, string>& item : wtx.mapValue)
entry.pushKV(item.first, item.second);
if (fEnableWalletTxVJoinSplit) {
entry.pushKV("vjoinsplit", TxJoinSplitToJSON(wtx));
}
}
UniValue getnewaddress(const UniValue& params, bool fHelp)
{
if (!EnsureWalletIsAvailable(fHelp))
return NullUniValue;
if (!fEnableGetNewAddress)
throw runtime_error(
"getnewaddress is DEPRECATED and will be removed in a future release\n"
"\nUse z_getnewaccount and z_getaddressforaccount instead, or restart \n"
"with `-allowdeprecated=getnewaddress` if you require backward compatibility.\n"
"See https://zcash.github.io/zcash/user/deprecation.html for more information.");
if (fHelp || params.size() > 1)
throw runtime_error(
"getnewaddress ( \"\" )\n"
"\nDEPRECATED. Use z_getnewaccount and z_getaddressforaccount instead.\n"
"\nReturns a new transparent Zcash address.\n"
"Payments received by this API are visible on-chain and do not otherwise\n"
"provide privacy protections; they should only be used in circumstances \n"
"where it is necessary to interoperate with legacy Bitcoin infrastructure.\n"
"\nArguments:\n"
"1. (dummy) (string, optional) DEPRECATED. If provided, it MUST be set to the empty string \"\". Passing any other string will result in an error.\n"
"\nResult:\n"
"\"zcashaddress\" (string) The new transparent Zcash address\n"
"\nExamples:\n"
+ HelpExampleCli("getnewaddress", "")
+ HelpExampleRpc("getnewaddress", "")
);
const UniValue& dummy_value = params[0];
if (!dummy_value.isNull() && dummy_value.get_str() != "") {
throw JSONRPCError(RPC_INVALID_PARAMETER, "dummy first argument must be excluded or set to \"\".");
}
LOCK2(cs_main, pwalletMain->cs_wallet);
const CChainParams& chainparams = Params();
EnsureWalletIsBackedUp(chainparams);
EnsureWalletIsUnlocked();
// Generate a new key that is added to wallet
CPubKey newKey = pwalletMain->GenerateNewKey(true);
CKeyID keyID = newKey.GetID();
std::string dummy_account;
pwalletMain->SetAddressBook(keyID, dummy_account, "receive");
KeyIO keyIO(chainparams);
return keyIO.EncodeDestination(keyID);
}
UniValue z_converttex(const UniValue& params, bool fHelp)
{
if (fHelp || params.size() < 1 || params.size() > 1)
throw runtime_error(
"z_converttex ( \"transparentaddress\" )\n"
"\nConverts a transparent Zcash address to a TEX address.\n"
"\nArguments:\n"
"1. \"transparentaddress\" (string, required) \n"
"\nResult:\n"
"\"texaddress\" (string) The converted ZIP 320 (TEX) address\n"
"\nExamples:\n"
+ HelpExampleCli("z_converttex", "\"t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\"")
);
KeyIO keyIO(Params());
auto decoded = keyIO.DecodePaymentAddress(params[0].get_str());
if (!decoded.has_value()) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid address");
}
if (!std::holds_alternative<CKeyID>(decoded.value())) {
throw JSONRPCError(RPC_INVALID_PARAMETER, "Address is not a transparent p2pkh address");
}
auto p2pkhKey = std::get<CKeyID>(decoded.value());
return keyIO.EncodeTexAddress(p2pkhKey);
}
UniValue getrawchangeaddress(const UniValue& params, bool fHelp)
{
if (!EnsureWalletIsAvailable(fHelp))
return NullUniValue;
if (!fEnableGetRawChangeAddress)
throw runtime_error(
"getrawchangeaddress is DEPRECATED and will be removed in a future release\n"
"\nChange addresses are a wallet-internal feature. Use a unified address for\n"
"a dedicated change account instead, or restart with `-allowdeprecated=getrawchangeaddress` \n"
"if you require backward compatibility.\n"
"See https://zcash.github.io/zcash/user/deprecation.html for more information.");
if (fHelp || params.size() > 1)
throw runtime_error(
"getrawchangeaddress\n"
"\nDEPRECATED. Change addresses are a wallet-internal feature. Use a unified"
"\naddress for a dedicated change account instead.\n"
"\nReturns a new transparent Zcash address for receiving change.\n"
"This is for use with raw transactions, NOT normal use. Additionally,\n"
"the resulting address does not correspond to the \"change\" HD derivation\n"
"path.\n"
"\nResult:\n"
"\"address\" (string) The transparent address\n"
"\nExamples:\n"
+ HelpExampleCli("getrawchangeaddress", "")
+ HelpExampleRpc("getrawchangeaddress", "")
);
LOCK2(cs_main, pwalletMain->cs_wallet);
const CChainParams& chainparams = Params();
EnsureWalletIsBackedUp(chainparams);
if (!pwalletMain->IsLocked())
pwalletMain->TopUpKeyPool();
CReserveKey reservekey(pwalletMain);
CPubKey vchPubKey;
if (!reservekey.GetReservedKey(vchPubKey))
throw JSONRPCError(RPC_WALLET_KEYPOOL_RAN_OUT, "Error: Keypool ran out, please call keypoolrefill first");
reservekey.KeepKey();
CKeyID keyID = vchPubKey.GetID();
KeyIO keyIO(chainparams);
return keyIO.EncodeDestination(keyID);
}
static void SendMoney(const CTxDestination &address, CAmount nValue, bool fSubtractFeeFromAmount, CWalletTx& wtxNew)
{
CAmount curBalance = pwalletMain->GetBalance(std::nullopt);
// Check amount
if (nValue <= 0)
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid amount");
if (nValue > curBalance)
throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, "Insufficient funds");
// Parse Zcash address
CScript scriptPubKey = GetScriptForDestination(address);
// Create and send the transaction
CReserveKey reservekey(pwalletMain);
CAmount nFeeRequired = -1;
std::string strError;
vector<CRecipient> vecSend;
CRecipient recipient = {scriptPubKey, nValue, fSubtractFeeFromAmount};
vecSend.push_back(recipient);
bool fCreated;
{
int nChangePosRet = -1; // never used
fCreated = pwalletMain->CreateTransaction(vecSend, wtxNew, reservekey, nFeeRequired, nChangePosRet, strError);
}
if (!fCreated) {
if (!fSubtractFeeFromAmount && nFeeRequired >= 0 && nValue + nFeeRequired > curBalance) {
strError = strprintf("Error: Insufficient funds to pay the fee. This transaction needs to spend %s "
"plus a fee of at least %s, but only %s is available",
DisplayMoney(nValue),
DisplayMoney(nFeeRequired),
DisplayMoney(curBalance));
throw JSONRPCError(RPC_WALLET_INSUFFICIENT_FUNDS, strError);
} else {
throw JSONRPCError(RPC_WALLET_ERROR, strError);
}
}
CValidationState state;
if (!pwalletMain->CommitTransaction(wtxNew, reservekey, state)) {
strError = strprintf("Error: The transaction was rejected! Reason given: %s", state.GetRejectReason());
throw JSONRPCError(RPC_WALLET_ERROR, strError);
}
}
// We accept any `PrivacyPolicy` constructor name, but there is also a special
// “LegacyCompat” policy that maps to a different `PrivacyPolicy` depending on
// other aspects of the transaction. Here we use `std::nullopt` for the
// “LegacyCompat” case and resolve that when we have more context.
//
// We need to know the privacy policy before we construct the ZTXOSelector, but
// we can't determine what “LegacyCompat” maps to without knowing whether any
// UAs are involved. We break this cycle by parsing the privacy policy argument
// first, and then resolving “LegacyCompat” after parsing the rest of the
// arguments. This works because all interpretations for “LegacyCompat” have the
// same effect on ZTXOSelector construction (in that they don't include
// `AllowLinkingAccountAddresses`).
std::optional<TransactionStrategy>
ReifyPrivacyPolicy(const std::optional<PrivacyPolicy>& defaultPolicy,
const std::optional<std::string>& specifiedPolicy)
{
std::optional<TransactionStrategy> strategy = std::nullopt;
if (specifiedPolicy.has_value()) {
auto strategyName = specifiedPolicy.value();
if (strategyName == "LegacyCompat") {
strategy = std::nullopt;
} else {
strategy = TransactionStrategy::FromString(strategyName);
if (!strategy.has_value()) {
throw JSONRPCError(
RPC_INVALID_PARAMETER,
strprintf("Unknown privacy policy name '%s'", strategyName));
}
}
} else if (defaultPolicy.has_value()) {
strategy = TransactionStrategy(defaultPolicy.value());
}
return strategy;
}
bool
InvolvesUnifiedAddress(
const std::optional<PaymentAddress>& sender,
const std::set<PaymentAddress>& recipients)
{
bool hasUASender =
sender.has_value() && std::holds_alternative<UnifiedAddress>(sender.value());
bool hasUARecipient =
std::find_if(recipients.begin(), recipients.end(),
[](const PaymentAddress& addr) {
return std::holds_alternative<UnifiedAddress>(addr);
})
!= recipients.end();
return hasUASender || hasUARecipient;
}
// Determines which `TransactionStrategy` should be used for the “LegacyCompat”
// policy given the set of addresses involved.
PrivacyPolicy
InterpretLegacyCompat(const std::optional<PaymentAddress>& sender,
const std::set<PaymentAddress>& recipients)
{
return !fEnableLegacyPrivacyStrategy || InvolvesUnifiedAddress(sender, recipients)
? PrivacyPolicy::FullPrivacy
: PrivacyPolicy::AllowFullyTransparent;
}
// Provides the final `TransactionStrategy` to be used for a transaction.
TransactionStrategy
ResolveTransactionStrategy(
const std::optional<TransactionStrategy>& maybeStrategy,
PrivacyPolicy defaultPolicy)
{
return maybeStrategy.value_or(TransactionStrategy(defaultPolicy));
}
UniValue sendtoaddress(const UniValue& params, bool fHelp)
{
if (!EnsureWalletIsAvailable(fHelp))
return NullUniValue;
if (fHelp || params.size() < 2 || params.size() > 5)
throw runtime_error(
"sendtoaddress \"zcashaddress\" amount ( \"comment\" \"comment-to\" subtractfeefromamount )\n"
"\nSend an amount to a given transparent address. The amount is interpreted as a real number\n"
"and is rounded to the nearest 0.00000001. This API will only select funds from the transparent\n"
"pool, and all the details of the transaction, including sender, recipient, and amount will be\n"
"permanently visible on the public chain. THIS API PROVIDES NO PRIVACY, and should only be\n"
"used when interoperability with legacy Bitcoin infrastructure is required.\n"
+ HelpRequiringPassphrase() +
"\nArguments:\n"
"1. \"zcashaddress\" (string, required) The transparent Zcash address to send to.\n"
"2. \"amount\" (numeric, required) The amount in " + CURRENCY_UNIT + " to send. eg 0.1\n"
"3. \"comment\" (string, optional) A comment used to store what the transaction is for. \n"
" This is not part of the transaction, just kept in your wallet.\n"
"4. \"comment-to\" (string, optional) A comment to store the name of the person or organization \n"
" to which you're sending the transaction. This is not part of the \n"
" transaction, just kept in your wallet.\n"
"5. subtractfeefromamount (boolean, optional, default=false) The fee will be deducted from the amount being sent.\n"
" The recipient will receive less Zcash than you enter in the amount field.\n"
"\nResult:\n"
"\"transactionid\" (string) The transaction id.\n"
"\nExamples:\n"
+ HelpExampleCli("sendtoaddress", "\"t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1")
+ HelpExampleCli("sendtoaddress", "\"t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"donation\" \"seans outpost\"")
+ HelpExampleCli("sendtoaddress", "\"t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" true")
+ HelpExampleRpc("sendtoaddress", "\"t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\", 0.1, \"donation\", \"seans outpost\"")
);
LOCK2(cs_main, pwalletMain->cs_wallet);
KeyIO keyIO(Params());
auto destStr = params[0].get_str();
CTxDestination dest = keyIO.DecodeDestination(destStr);
if (!IsValidDestination(dest)) {
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, std::string("Invalid " PACKAGE_NAME " transparent address: ") + destStr);
}
// Amount
CAmount nAmount = AmountFromValue(params[1]);
if (nAmount <= 0)
throw JSONRPCError(RPC_TYPE_ERROR, "Invalid amount for send");
// Wallet comments
CWalletTx wtx;
if (params.size() > 2 && !params[2].isNull() && !params[2].get_str().empty())
wtx.mapValue["comment"] = params[2].get_str();
if (params.size() > 3 && !params[3].isNull() && !params[3].get_str().empty())
wtx.mapValue["to"] = params[3].get_str();
bool fSubtractFeeFromAmount = false;
if (params.size() > 4)
fSubtractFeeFromAmount = params[4].get_bool();
EnsureWalletIsUnlocked();
SendMoney(dest, nAmount, fSubtractFeeFromAmount, wtx);
return wtx.GetHash().GetHex();
}
static std::optional<ReceiverType> ReceiverTypeFromString(const std::string& p)
{
if (p == "p2pkh") {
return ReceiverType::P2PKH;
} else if (p == "p2sh") {
return ReceiverType::P2SH;
} else if (p == "sapling") {
return ReceiverType::Sapling;
} else if (p == "orchard") {
return ReceiverType::Orchard;
} else {
return std::nullopt;
}
}
static std::string ReceiverTypeToString(ReceiverType t)
{
switch(t) {
case ReceiverType::P2PKH: return "p2pkh";
case ReceiverType::P2SH: return "p2sh";
case ReceiverType::Sapling: return "sapling";
case ReceiverType::Orchard: return "orchard";
}
}
/// On failure, returns a non-empty set of the strings that don’t represent valid receiver types.
static tl::expected<std::set<ReceiverType>, std::set<std::string>>
ReceiverTypesFromJSON(const UniValue& json)
{
assert(json.isArray());
std::set<ReceiverType> receiverTypes;
std::set<std::string> invalidReceivers;
for (size_t i = 0; i < json.size(); i++) {
const std::string& p = json[i].get_str();
auto t = ReceiverTypeFromString(p);
if (t.has_value()) {
receiverTypes.insert(t.value());
} else {
invalidReceivers.insert(p);
}
}
if (invalidReceivers.empty()) {
return {receiverTypes};
} else {
return tl::make_unexpected(invalidReceivers);
}
}
static UniValue ReceiverTypesToJSON(const std::set<ReceiverType>& receiverTypes)
{
UniValue receiverTypesEntry(UniValue::VARR);
for (auto t : receiverTypes) {
receiverTypesEntry.push_back(ReceiverTypeToString(t));
}
return receiverTypesEntry;
}
UniValue listaddresses(const UniValue& params, bool fHelp)
{
if (!EnsureWalletIsAvailable(fHelp))
return NullUniValue;
if (fHelp)
throw runtime_error(
"listaddresses\n"
"\nLists the addresses managed by this wallet by source, including \n"
"those generated from randomness by this wallet, Sapling addresses \n"
"generated from the legacy HD seed, imported watchonly transparent \n"
"addresses, shielded addresses tracked using imported viewing keys, \n"
"and addresses derived from the wallet's mnemonic seed for releases \n"
"version 4.7.0 and above. \n"
"\nREMINDER: It is recommended that you back up your wallet.dat file \n"
"regularly. If your wallet was created using zcashd version 4.7.0 \n"
"or later and you have not imported externally produced keys, it only \n"
"necessary to have backed up the wallet's emergency recovery phrase.\n"
"\nResult:\n"
"[\n"
" {\n"
" \"source\": \"imported|imported_watchonly|legacy_random|legacy_seed|mnemonic_seed\"\n"
" \"transparent\": {\n"
" \"addresses\": [\"t14oHp2v54vfmdgQ3v3SNuQga8JKHTNi2a1\", ...],\n"
" \"changeAddresses\": [\"t14oHp2v54vfmdgQ3v3SNuQga8JKHTNi2a1\", ...]\n"
" },\n"
" \"sprout\": {\n"
" \"addresses\": [\"ztbx5DLDxa5ZLFTchHhoPNkKs57QzSyib6UqXpEdy76T1aUdFxJt1w9318Z8DJ73XzbnWHKEZP9Yjg712N5kMmP4QzS9iC9\", ...]\n"
" },\n"
" \"sapling\": [ -- each element in this list represents a set of diversified addresses derived from a single IVK. \n"
" {\n"
" \"zip32KeyPath\": \"m/32'/133'/0'\", -- optional field, not present for imported/watchonly sources,\n"
" \"addresses\": [\n"
" \"zs1z7rejlpsa98s2rrrfkwmaxu53e4ue0ulcrw0h4x5g8jl04tak0d3mm47vdtahatqrlkngh9slya\",\n"
" ...\n"
" ]\n"
" },\n"
" ...\n"
" ],\n"
" \"unified\": [ -- each element in this list represents a set of diversified Unified Addresses derived from a single UFVK.\n"
" {\n"
" \"account\": 0,\n"
" \"seedfp\": \"hexstring\",\n"
" \"addresses\": [\n"
" {\n"
" \"diversifier_index\": 0,\n"
" \"receiver_types\": [\n"
" \"sapling\",\n"
" ...\n"
" ],\n"
" \"address\": \"...\"\n"
" },\n"
" ...\n"
" ]\n"
" },\n"
" ...\n"
" ],\n"
" ...\n"
" },\n"
" ...\n"
"]"
"\nIn the case that a source does not have addresses for a value pool, the key\n"
"associated with that pool will be absent.\n"
"\nExamples:\n"
+ HelpExampleCli("listaddresses", "")
+ HelpExampleRpc("listaddresses", "")
);
LOCK2(cs_main, pwalletMain->cs_wallet);
KeyIO keyIO(Params());
UniValue ret(UniValue::VARR);
// Split transparent addresses into several categories:
// - Generated randomly.
// - Imported
// - Imported watchonly.
// - Derived from mnemonic seed.
std::set<CTxDestination> t_generated_dests;
std::set<CTxDestination> t_generated_change_dests;
std::set<CTxDestination> t_mnemonic_dests;
std::set<CTxDestination> t_mnemonic_change_dests;
std::set<CTxDestination> t_imported_dests;
std::set<CTxDestination> t_watchonly_dests;
auto GetSourceForDestination = match {
[&](const CKeyID& addr) -> std::optional<PaymentAddressSource> {
return GetSourceForPaymentAddress(pwalletMain)(addr);
},
[&](const CScriptID& addr) -> std::optional<PaymentAddressSource> {
return GetSourceForPaymentAddress(pwalletMain)(addr);
},
[&](const CNoDestination& addr) -> std::optional<PaymentAddressSource> {
return std::nullopt;
},
};
// Get the CTxDestination values for all the entries in the transparent address book.
// This will include any address that has been generated by this wallet.
for (const std::pair<CTxDestination, CAddressBookData>& item : pwalletMain->mapAddressBook) {
std::optional<PaymentAddressSource> source = std::visit(GetSourceForDestination, item.first);
if (source.has_value()) {
switch (source.value()) {
case PaymentAddressSource::Random:
t_generated_dests.insert(item.first);
break;
case PaymentAddressSource::Imported:
t_imported_dests.insert(item.first);
break;
case PaymentAddressSource::ImportedWatchOnly:
t_watchonly_dests.insert(item.first);
break;
case PaymentAddressSource::MnemonicHDSeed:
t_mnemonic_dests.insert(item.first);
break;
default:
// Not going to be in the address book.
assert(false);
}
}
}
// Ensure we have every address that holds a balance. While this is likely to be redundant
// with respect to the entries in the address book for addresses generated by this wallet,
// there is not a guarantee that an externally generated address (such as one associated with
// a future unified incoming viewing key) will have been added to the address book.
for (const std::pair<CTxDestination, CAmount>& item : pwalletMain->GetAddressBalances(std::nullopt)) {
if (t_generated_dests.count(item.first) == 0 &&
t_mnemonic_dests.count(item.first) == 0 &&
t_imported_dests.count(item.first) == 0 &&
t_watchonly_dests.count(item.first) == 0)
{
std::optional<PaymentAddressSource> source = std::visit(GetSourceForDestination, item.first);
if (source.has_value()) {
switch (source.value()) {
case PaymentAddressSource::Random:
t_generated_change_dests.insert(item.first);
break;
case PaymentAddressSource::MnemonicHDSeed:
t_mnemonic_change_dests.insert(item.first);
break;
default:
// assume that if we didn't add the address to the addrbook
// that it's a change address. Ideally we'd have a better way
// of checking this by exploring the transaction graph;
break;
}
}
}
}
/// sprout addresses
std::set<libzcash::SproutPaymentAddress> sproutAddresses;
pwalletMain->GetSproutPaymentAddresses(sproutAddresses);
/// sapling addresses
std::set<libzcash::SaplingPaymentAddress> saplingAddresses;
pwalletMain->GetSaplingPaymentAddresses(saplingAddresses);
// legacy_random source
{
// Add legacy randomly generated address records to the result.
// This includes transparent addresses generated by the wallet via
// the keypool and Sprout addresses for which we have the
// spending key.
UniValue entry(UniValue::VOBJ);
entry.pushKV("source", "legacy_random");
bool hasData = false;
UniValue random_t(UniValue::VOBJ);
if (!t_generated_dests.empty()) {
UniValue random_t_addrs(UniValue::VARR);
for (const CTxDestination& dest : t_generated_dests) {
random_t_addrs.push_back(keyIO.EncodeDestination(dest));
}
random_t.pushKV("addresses", random_t_addrs);
hasData = true;
}
if (!t_generated_change_dests.empty()) {
UniValue random_t_change_addrs(UniValue::VARR);
for (const CTxDestination& dest : t_generated_change_dests) {
random_t_change_addrs.push_back(keyIO.EncodeDestination(dest));
}
random_t.pushKV("changeAddresses", random_t_change_addrs);
hasData = true;
}
if (!t_generated_dests.empty() || !t_generated_change_dests.empty()) {
entry.pushKV("transparent", random_t);
}
if (!sproutAddresses.empty()) {
UniValue random_sprout_addrs(UniValue::VARR);
for (const SproutPaymentAddress& addr : sproutAddresses) {
if (pwalletMain->HaveSproutSpendingKey(addr)) {
random_sprout_addrs.push_back(keyIO.EncodePaymentAddress(addr));
}
}
UniValue random_sprout(UniValue::VOBJ);
random_sprout.pushKV("addresses", random_sprout_addrs);
entry.pushKV("sprout", random_sprout);
hasData = true;
}
if (hasData) {
ret.push_back(entry);
}
}
// Inner function that groups Sapling addresses by IVK for use in all sources
// that can contain Sapling addresses. Sapling components of unified addresses,
// i.e. those that are associated with account IDs that are not the legacy account,
// will not be included in the entry.
auto add_sapling = [&](
const std::set<SaplingPaymentAddress>& addrs,
const PaymentAddressSource source,
UniValue& entry
) {
bool hasData = false;
std::map<SaplingIncomingViewingKey, std::vector<SaplingPaymentAddress>> ivkAddrs;
for (const SaplingPaymentAddress& addr : addrs) {
if (GetSourceForPaymentAddress(pwalletMain)(addr) == source) {
SaplingIncomingViewingKey ivkRet;
if (pwalletMain->GetSaplingIncomingViewingKey(addr, ivkRet)) {
// Do not include any address that is associated with a unified key.
if (!pwalletMain->GetUFVKMetadataForReceiver(addr).has_value()) {
ivkAddrs[ivkRet].push_back(addr);
}
}
}
}
{
UniValue ivk_groups(UniValue::VARR);
for (const auto& [ivk, addrs] : ivkAddrs) {
UniValue sapling_addrs(UniValue::VARR);
for (const SaplingPaymentAddress& addr : addrs) {
sapling_addrs.push_back(keyIO.EncodePaymentAddress(addr));
}
UniValue sapling_obj(UniValue::VOBJ);
if (source == PaymentAddressSource::LegacyHDSeed || source == PaymentAddressSource::MnemonicHDSeed) {
std::string hdKeyPath = pwalletMain->mapSaplingZKeyMetadata[ivk].hdKeypath;
if (hdKeyPath != "") {
sapling_obj.pushKV("zip32KeyPath", hdKeyPath);
}
}
sapling_obj.pushKV("addresses", sapling_addrs);
ivk_groups.push_back(sapling_obj);
}
if (!ivk_groups.empty()) {
entry.pushKV("sapling", ivk_groups);
hasData = true;
}
}
return hasData;
};
/// imported source
{
UniValue entry(UniValue::VOBJ);
entry.pushKV("source", "imported");
bool hasData = false;
if (!t_imported_dests.empty()) {
UniValue t_imported_addrs(UniValue::VARR);
for (const CTxDestination& dest: t_imported_dests) {
t_imported_addrs.push_back(keyIO.EncodeDestination(dest));
}
UniValue imported_t(UniValue::VOBJ);
imported_t.pushKV("addresses", t_imported_addrs);
entry.pushKV("transparent", imported_t);
hasData = true;
}
{
UniValue imported_sprout_addrs(UniValue::VARR);
for (const SproutPaymentAddress& addr : sproutAddresses) {
if (GetSourceForPaymentAddress(pwalletMain)(addr) == PaymentAddressSource::Imported) {
imported_sprout_addrs.push_back(keyIO.EncodePaymentAddress(addr));
}
}
if (!imported_sprout_addrs.empty()) {
UniValue imported_sprout(UniValue::VOBJ);
imported_sprout.pushKV("addresses", imported_sprout_addrs);
entry.pushKV("sprout", imported_sprout);
hasData = true;
}
}
hasData |= add_sapling(saplingAddresses, PaymentAddressSource::Imported, entry);
if (hasData) {
ret.push_back(entry);
}
}
/// imported_watchonly source
{
UniValue entry(UniValue::VOBJ);
entry.pushKV("source", "imported_watchonly");
bool hasData = false;
if (!t_watchonly_dests.empty()) {
UniValue watchonly_t_addrs(UniValue::VARR);
for (const CTxDestination& dest: t_watchonly_dests) {
watchonly_t_addrs.push_back(keyIO.EncodeDestination(dest));
}
UniValue watchonly_t(UniValue::VOBJ);
watchonly_t.pushKV("addresses", watchonly_t_addrs);
entry.pushKV("transparent", watchonly_t);
hasData = true;
}
{
UniValue watchonly_sprout_addrs(UniValue::VARR);
for (const SproutPaymentAddress& addr : sproutAddresses) {
if (GetSourceForPaymentAddress(pwalletMain)(addr) == PaymentAddressSource::ImportedWatchOnly) {
watchonly_sprout_addrs.push_back(keyIO.EncodePaymentAddress(addr));
}
}
if (!watchonly_sprout_addrs.empty()) {
UniValue watchonly_sprout(UniValue::VOBJ);
watchonly_sprout.pushKV("addresses", watchonly_sprout_addrs);
entry.pushKV("sprout", watchonly_sprout);
hasData = true;
}
}
hasData |= add_sapling(saplingAddresses, PaymentAddressSource::ImportedWatchOnly, entry);
if (hasData) {
ret.push_back(entry);
}
}
/// legacy_hdseed source
{
UniValue entry(UniValue::VOBJ);
entry.pushKV("source", "legacy_hdseed");
bool hasData = add_sapling(saplingAddresses, PaymentAddressSource::LegacyHDSeed, entry);
if (hasData) {
ret.push_back(entry);
}
}
// mnemonic seed source
{
UniValue entry(UniValue::VOBJ);
entry.pushKV("source", "mnemonic_seed");
bool hasData = false;
UniValue mnemonic_transparent(UniValue::VOBJ);
if (!t_mnemonic_dests.empty()) {
UniValue mnemonic_taddrs(UniValue::VARR);
for (const CTxDestination& dest : t_mnemonic_dests) {
mnemonic_taddrs.push_back(keyIO.EncodeDestination(dest));
}
mnemonic_transparent.pushKV("addresses", mnemonic_taddrs);
hasData = true;
}
if (!t_mnemonic_change_dests.empty()) {
UniValue mnemonic_change_taddrs(UniValue::VARR);
for (const CTxDestination& dest : t_mnemonic_change_dests) {
mnemonic_change_taddrs.push_back(keyIO.EncodeDestination(dest));
}
mnemonic_transparent.pushKV("changeAddresses", mnemonic_change_taddrs);
hasData = true;
}
if (!t_mnemonic_dests.empty() || !t_mnemonic_change_dests.empty()) {
entry.pushKV("transparent", mnemonic_transparent);
}
// sapling
hasData |= add_sapling(saplingAddresses, PaymentAddressSource::MnemonicHDSeed, entry);
// unified
// here, we want to use the information in mapUfvkAddressMetadata to report all the unified addresses
UniValue unified_groups(UniValue::VARR);
auto hdChain = pwalletMain->GetMnemonicHDChain();
for (const auto& [ufvkid, addrmeta] : pwalletMain->mapUfvkAddressMetadata) {
auto account = pwalletMain->GetUnifiedAccountId(ufvkid);
if (account.has_value() && hdChain.has_value()) {
// double-check that the ufvkid we get from address metadata is actually
// associated with the mnemonic HD chain
auto ufvkCheck = pwalletMain->mapUnifiedAccountKeys.find(
std::make_pair(hdChain.value().GetSeedFingerprint(), account.value())
);
if (ufvkCheck != pwalletMain->mapUnifiedAccountKeys.end() && ufvkCheck->second == ufvkid) {
UniValue unified_group(UniValue::VOBJ);
unified_group.pushKV("account", uint64_t(account.value()));
unified_group.pushKV("seedfp", hdChain.value().GetSeedFingerprint().GetHex());
UniValue unified_addrs(UniValue::VARR);
auto ufvk = pwalletMain->GetUnifiedFullViewingKey(ufvkid).value();
for (const auto& [j, receiverTypes] : addrmeta.GetKnownReceiverSetsByDiversifierIndex()) {
// We know we can use std::get here safely because we previously
// generated a valid address for this diversifier & set of
// receiver types.
UniValue addrEntry(UniValue::VOBJ);
auto addr = std::get<std::pair<libzcash::UnifiedAddress, diversifier_index_t>>(
ufvk.Address(j, receiverTypes)
);
{
UniValue jVal;
jVal.setNumStr(ArbitraryIntStr(std::vector(j.begin(), j.end())));
addrEntry.pushKV("diversifier_index", jVal);
}
addrEntry.pushKV("receiver_types", ReceiverTypesToJSON(receiverTypes));
addrEntry.pushKV("address", keyIO.EncodePaymentAddress(addr.first));
unified_addrs.push_back(addrEntry);
}
unified_group.pushKV("addresses", unified_addrs);
unified_groups.push_back(unified_group);
}
}
}
if (!unified_groups.empty()) {
entry.pushKV("unified", unified_groups);
hasData = true;
}
if (hasData) {
ret.push_back(entry);
};
}
return ret;
}
UniValue listaddressgroupings(const UniValue& params, bool fHelp)
{
if (!EnsureWalletIsAvailable(fHelp))
return NullUniValue;
if (fHelp || params.size() > 1)
throw runtime_error(
"listaddressgroupings ( asOfHeight )\n"