501                    {RPCResult::Type::NUM, "next_index", /*optional=*/true, "The next index to generate addresses from; defined only for ranged descriptors"},
502                }},
503            }}
504        }},
505        RPCExamples{
506            HelpExampleCli("listdescriptors", "") + HelpExampleRpc("listdescriptors", "")
507            + HelpExampleCli("listdescriptors", "true") + HelpExampleRpc("listdescriptors", "true")
508        },
509        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
510{
511    const std::shared_ptr<const CWallet> wallet = GetWalletForJSONRPCRequest(request);
512    if (!wallet) return UniValue::VNULL;
513
514    const bool priv = !request.params[0].isNull() && request.params[0].get_bool();
515    if (wallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && priv) {
516        throw JSONRPCError(RPC_WALLET_ERROR, "Can't get private descriptor string for watch-only wallets");
517    }
518    if (priv) {
519        EnsureWalletIsUnlocked(*wallet);
520    }
521
522    LOCK(wallet->cs_wallet);
523    util::Expected<std::vector<WalletDescInfo>, std::string> exported = ExportDescriptors(*wallet, priv);
524    if (!exported) {
525        throw JSONRPCError(RPC_WALLET_ERROR, exported.error());
526    }
527    std::vector<WalletDescInfo> wallet_descriptors = *exported;
528
529    std::sort(wallet_descriptors.begin(), wallet_descriptors.end(), [](const auto& a, const auto& b) {
530        return a.descriptor < b.descriptor;
531    });
532
533    UniValue descriptors(UniValue::VARR);
534    for (const WalletDescInfo& info : wallet_descriptors) {
535        UniValue spk(UniValue::VOBJ);
536        spk.pushKV("desc", info.descriptor);
537        spk.pushKV("timestamp", info.creation_time);
538        spk.pushKV("active", info.active);
539        if (info.internal.has_value()) {
540            spk.pushKV("internal", info.internal.value());
541        }
542        if (info.range.has_value()) {
543            UniValue range(UniValue::VARR);
544            range.push_back(info.range->first);
545            range.push_back(info.range->second - 1);
546            spk.pushKV("range", std::move(range));
547            spk.pushKV("next", info.next_index);
548            spk.pushKV("next_index", info.next_index);
549        }
550        descriptors.push_back(std::move(spk));
551    }
552
553    UniValue response(UniValue::VOBJ);
554    response.pushKV("wallet_name", wallet->GetName());
555    response.pushKV("descriptors", std::move(descriptors));
556
557    return response;
558},
559    };
560}
561
562RPCMethod backupwallet()
563{
564    return RPCMethod{
565        "backupwallet",
566        "Safely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.\n",
567                {
568                    {"destination", RPCArg::Type::STR, RPCArg::Optional::NO, "The destination directory or file"},
569                },
570                RPCResult{RPCResult::Type::NONE, "", ""},
571                RPCExamples{
572                    HelpExampleCli("backupwallet", "\"backup.dat\"")
573            + HelpExampleRpc("backupwallet", "\"backup.dat\"")
574                },
575        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
576{
577    const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
578    if (!pwallet) return UniValue::VNULL;
579
580    // Make sure the results are valid at least up to the most recent block
581    // the user could have gotten from another RPC command prior to now
582    pwallet->BlockUntilSyncedToCurrentChain();
583
584    LOCK(pwallet->cs_wallet);
585
586    std::string strDest = request.params[0].get_str();
587    if (!pwallet->BackupWallet(strDest)) {
588        throw JSONRPCError(RPC_WALLET_ERROR, "Error: Wallet backup failed!");
589    }
590
591    return UniValue::VNULL;
592},
593    };
594}
595
596
597RPCMethod restorewallet()
598{
599    return RPCMethod{
600        "restorewallet",
601        "Restores and loads a wallet from backup.\n"
602        "\nThe rescan is significantly faster if block filters are available"
603        "\n(using startup option \"-blockfilterindex=1\").\n",
604        {
605            {"wallet_name", RPCArg::Type::STR, RPCArg::Optional::NO, "The name that will be applied to the restored wallet"},
606            {"backup_file", RPCArg::Type::STR, RPCArg::Optional::NO, "The backup file that will be used to restore the wallet."},
607            {"load_on_startup", RPCArg::Type::BOOL, RPCArg::Optional::OMITTED, "Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged."},
608        },
609        RPCResult{
610            RPCResult::Type::OBJ, "", "",
611            {
612                {RPCResult::Type::STR, "name", "The wallet name if restored successfully."},
613                {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to restoring and loading the wallet.",
614                {
615                    {RPCResult::Type::STR, "", ""},
616                }},
617            }
618        },
619        RPCExamples{
620            HelpExampleCli("restorewallet", "\"testwallet\" \"home\\backups\\backup-file.bak\"")
621            + HelpExampleRpc("restorewallet", R"("testwallet", "home\\backups\\backup-file.bak")")
622            + HelpExampleCliNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak"}, {"load_on_startup", true}})
623            + HelpExampleRpcNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak"}, {"load_on_startup", true}})
624        },
625        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
626{
627
628    WalletContext& context = EnsureWalletContext(request.context);
629
630    auto backup_file = fs::u8path(request.params[1].get_str());
631
632    std::string wallet_name = request.params[0].get_str();
633
634    std::optional<bool> load_on_start = request.params[2].isNull() ? std::nullopt : std::optional<bool>(request.params[2].get_bool());
635
636    DatabaseStatus status;
637    bilingual_str error;
638    std::vector<bilingual_str> warnings;
639
640    const std::shared_ptr<CWallet> wallet = RestoreWallet(context, backup_file, wallet_name, load_on_start, status, error, warnings);
641
642    HandleWalletError(wallet, status, error);
643
644    UniValue obj(UniValue::VOBJ);
645    obj.pushKV("name", wallet->GetName());
646    PushWarnings(warnings, obj);
647
648    return obj;
649
650},
651    };
652}
653} // namespace wallet
654