1// Copyright (c) 2017-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_WALLET_RPC_UTIL_H
6#define BITCOIN_WALLET_RPC_UTIL_H
7
8#include <rpc/util.h>
9#include <script/script.h>
10#include <wallet/wallet.h>
11
12#include <any>
13#include <memory>
14#include <optional>
15#include <string>
16#include <string_view>
17#include <vector>
18
19class JSONRPCRequest;
20class UniValue;
21struct bilingual_str;
22
23namespace wallet {
24enum class DatabaseStatus;
25struct WalletContext;
26
27extern const std::string HELP_REQUIRING_PASSPHRASE;
28
29inline const RPCResult RESULT_LAST_PROCESSED_BLOCK { RPCResult::Type::OBJ, "lastprocessedblock", "hash and height of the block this information was generated on",{
30    {RPCResult::Type::STR_HEX, "hash", "hash of the block this information was generated on"},
31    {RPCResult::Type::NUM, "height", "height of the block this information was generated on"}}
32};
33
34/**
35 * Figures out what wallet, if any, to use for a JSONRPCRequest.
36 *
37 * @param[in] request JSONRPCRequest that wishes to access a wallet
38 * @return nullptr if no wallet should be used, or a pointer to the CWallet
39 */
40std::shared_ptr<CWallet> GetWalletForJSONRPCRequest(const JSONRPCRequest& request);
41std::optional<std::string> GetWalletNameFromJSONRPCRequest(const JSONRPCRequest& request);
42/**
43 * Ensures that a wallet name is specified across the endpoint and wallet_name.
44 * Throws `RPC_INVALID_PARAMETER` if none or different wallet names are specified.
45 */
46std::string EnsureUniqueWalletName(const JSONRPCRequest& request, std::optional<std::string_view> wallet_name);
47
48void EnsureWalletIsUnlocked(const CWallet&);
49WalletContext& EnsureWalletContext(const std::any& context);
50
51bool GetAvoidReuseFlag(const CWallet& wallet, const UniValue& param);
52std::string LabelFromValue(const UniValue& value);
53//! Fetch parent descriptors of this scriptPubKey.
54void PushParentDescriptors(const CWallet& wallet, const CScript& script_pubkey, UniValue& entry);
55
56void HandleWalletError(const std::shared_ptr<CWallet>& wallet, DatabaseStatus& status, bilingual_str& error);
57void AppendLastProcessedBlock(UniValue& entry, const CWallet& wallet) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet);
58} //  namespace wallet
59
60#endif // BITCOIN_WALLET_RPC_UTIL_H
61