Remove g_rpc_chain global
Replace with RPC request reference to new WalletContext struct similar to the
existing NodeContext struct and reference.
This PR is a followup to 25ad2c623a
https://github.com/bitcoin/bitcoin/pull/18740 removing the g_rpc_node global.
Some later PRs will follow this up and move more wallet globals to the
WalletContext struct.
Co-authored-by: João Barbosa <joao.paulo.barbosa@gmail.com>
This commit is contained in:
parent
e783197bf0
commit
4a7253ab6c
7 changed files with 81 additions and 20 deletions
|
@ -241,6 +241,7 @@ BITCOIN_CORE_H = \
|
||||||
versionbitsinfo.h \
|
versionbitsinfo.h \
|
||||||
walletinitinterface.h \
|
walletinitinterface.h \
|
||||||
wallet/coincontrol.h \
|
wallet/coincontrol.h \
|
||||||
|
wallet/context.h \
|
||||||
wallet/crypter.h \
|
wallet/crypter.h \
|
||||||
wallet/db.h \
|
wallet/db.h \
|
||||||
wallet/feebumper.h \
|
wallet/feebumper.h \
|
||||||
|
@ -350,6 +351,7 @@ libbitcoin_wallet_a_CXXFLAGS = $(AM_CXXFLAGS) $(PIE_FLAGS)
|
||||||
libbitcoin_wallet_a_SOURCES = \
|
libbitcoin_wallet_a_SOURCES = \
|
||||||
interfaces/wallet.cpp \
|
interfaces/wallet.cpp \
|
||||||
wallet/coincontrol.cpp \
|
wallet/coincontrol.cpp \
|
||||||
|
wallet/context.cpp \
|
||||||
wallet/crypter.cpp \
|
wallet/crypter.cpp \
|
||||||
wallet/db.cpp \
|
wallet/db.cpp \
|
||||||
wallet/feebumper.cpp \
|
wallet/feebumper.cpp \
|
||||||
|
|
|
@ -16,7 +16,9 @@
|
||||||
#include <ui_interface.h>
|
#include <ui_interface.h>
|
||||||
#include <uint256.h>
|
#include <uint256.h>
|
||||||
#include <util/check.h>
|
#include <util/check.h>
|
||||||
|
#include <util/ref.h>
|
||||||
#include <util/system.h>
|
#include <util/system.h>
|
||||||
|
#include <wallet/context.h>
|
||||||
#include <wallet/feebumper.h>
|
#include <wallet/feebumper.h>
|
||||||
#include <wallet/fees.h>
|
#include <wallet/fees.h>
|
||||||
#include <wallet/ismine.h>
|
#include <wallet/ismine.h>
|
||||||
|
@ -482,18 +484,21 @@ class WalletClientImpl : public ChainClient
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
WalletClientImpl(Chain& chain, std::vector<std::string> wallet_filenames)
|
WalletClientImpl(Chain& chain, std::vector<std::string> wallet_filenames)
|
||||||
: m_chain(chain), m_wallet_filenames(std::move(wallet_filenames))
|
: m_wallet_filenames(std::move(wallet_filenames))
|
||||||
{
|
{
|
||||||
|
m_context.chain = &chain;
|
||||||
}
|
}
|
||||||
void registerRpcs() override
|
void registerRpcs() override
|
||||||
{
|
{
|
||||||
g_rpc_chain = &m_chain;
|
|
||||||
for (const CRPCCommand& command : GetWalletRPCCommands()) {
|
for (const CRPCCommand& command : GetWalletRPCCommands()) {
|
||||||
m_rpc_handlers.emplace_back(m_chain.handleRpc(command));
|
m_rpc_commands.emplace_back(command.category, command.name, [this, &command](const JSONRPCRequest& request, UniValue& result, bool last_handler) {
|
||||||
|
return command.actor({request, m_context}, result, last_handler);
|
||||||
|
}, command.argNames, command.unique_id);
|
||||||
|
m_rpc_handlers.emplace_back(m_context.chain->handleRpc(m_rpc_commands.back()));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
bool verify() override { return VerifyWallets(m_chain, m_wallet_filenames); }
|
bool verify() override { return VerifyWallets(*m_context.chain, m_wallet_filenames); }
|
||||||
bool load() override { return LoadWallets(m_chain, m_wallet_filenames); }
|
bool load() override { return LoadWallets(*m_context.chain, m_wallet_filenames); }
|
||||||
void start(CScheduler& scheduler) override { return StartWallets(scheduler); }
|
void start(CScheduler& scheduler) override { return StartWallets(scheduler); }
|
||||||
void flush() override { return FlushWallets(); }
|
void flush() override { return FlushWallets(); }
|
||||||
void stop() override { return StopWallets(); }
|
void stop() override { return StopWallets(); }
|
||||||
|
@ -508,9 +513,10 @@ public:
|
||||||
}
|
}
|
||||||
~WalletClientImpl() override { UnloadWallets(); }
|
~WalletClientImpl() override { UnloadWallets(); }
|
||||||
|
|
||||||
Chain& m_chain;
|
WalletContext m_context;
|
||||||
std::vector<std::string> m_wallet_filenames;
|
std::vector<std::string> m_wallet_filenames;
|
||||||
std::vector<std::unique_ptr<Handler>> m_rpc_handlers;
|
std::vector<std::unique_ptr<Handler>> m_rpc_handlers;
|
||||||
|
std::list<CRPCCommand> m_rpc_commands;
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace
|
} // namespace
|
||||||
|
|
|
@ -41,6 +41,16 @@ public:
|
||||||
const util::Ref& context;
|
const util::Ref& context;
|
||||||
|
|
||||||
JSONRPCRequest(const util::Ref& context) : id(NullUniValue), params(NullUniValue), fHelp(false), context(context) {}
|
JSONRPCRequest(const util::Ref& context) : id(NullUniValue), params(NullUniValue), fHelp(false), context(context) {}
|
||||||
|
|
||||||
|
//! Initializes request information from another request object and the
|
||||||
|
//! given context. The implementation should be updated if any members are
|
||||||
|
//! added or removed above.
|
||||||
|
JSONRPCRequest(const JSONRPCRequest& other, const util::Ref& context)
|
||||||
|
: id(other.id), strMethod(other.strMethod), params(other.params), fHelp(other.fHelp), URI(other.URI),
|
||||||
|
authUser(other.authUser), peerAddr(other.peerAddr), context(context)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
void parse(const UniValue& valRequest);
|
void parse(const UniValue& valRequest);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
8
src/wallet/context.cpp
Normal file
8
src/wallet/context.cpp
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
// Copyright (c) 2020 The Bitcoin Core developers
|
||||||
|
// Distributed under the MIT software license, see the accompanying
|
||||||
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||||
|
|
||||||
|
#include <wallet/context.h>
|
||||||
|
|
||||||
|
WalletContext::WalletContext() {}
|
||||||
|
WalletContext::~WalletContext() {}
|
32
src/wallet/context.h
Normal file
32
src/wallet/context.h
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
// Copyright (c) 2020 The Bitcoin Core developers
|
||||||
|
// Distributed under the MIT software license, see the accompanying
|
||||||
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||||
|
|
||||||
|
#ifndef BITCOIN_WALLET_CONTEXT_H
|
||||||
|
#define BITCOIN_WALLET_CONTEXT_H
|
||||||
|
|
||||||
|
namespace interfaces {
|
||||||
|
class Chain;
|
||||||
|
} // namespace interfaces
|
||||||
|
|
||||||
|
//! WalletContext struct containing references to state shared between CWallet
|
||||||
|
//! instances, like the reference to the chain interface, and the list of opened
|
||||||
|
//! wallets.
|
||||||
|
//!
|
||||||
|
//! Future shared state can be added here as an alternative to adding global
|
||||||
|
//! variables.
|
||||||
|
//!
|
||||||
|
//! The struct isn't intended to have any member functions. It should just be a
|
||||||
|
//! collection of state pointers that doesn't pull in dependencies or implement
|
||||||
|
//! behavior.
|
||||||
|
struct WalletContext {
|
||||||
|
interfaces::Chain* chain{nullptr};
|
||||||
|
|
||||||
|
//! Declare default constructor and destructor that are not inline, so code
|
||||||
|
//! instantiating the WalletContext struct doesn't need to #include class
|
||||||
|
//! definitions for smart pointer and container members.
|
||||||
|
WalletContext();
|
||||||
|
~WalletContext();
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // BITCOIN_WALLET_CONTEXT_H
|
|
@ -21,12 +21,14 @@
|
||||||
#include <util/fees.h>
|
#include <util/fees.h>
|
||||||
#include <util/message.h> // For MessageSign()
|
#include <util/message.h> // For MessageSign()
|
||||||
#include <util/moneystr.h>
|
#include <util/moneystr.h>
|
||||||
|
#include <util/ref.h>
|
||||||
#include <util/string.h>
|
#include <util/string.h>
|
||||||
#include <util/system.h>
|
#include <util/system.h>
|
||||||
#include <util/translation.h>
|
#include <util/translation.h>
|
||||||
#include <util/url.h>
|
#include <util/url.h>
|
||||||
#include <util/vector.h>
|
#include <util/vector.h>
|
||||||
#include <wallet/coincontrol.h>
|
#include <wallet/coincontrol.h>
|
||||||
|
#include <wallet/context.h>
|
||||||
#include <wallet/feebumper.h>
|
#include <wallet/feebumper.h>
|
||||||
#include <wallet/rpcwallet.h>
|
#include <wallet/rpcwallet.h>
|
||||||
#include <wallet/wallet.h>
|
#include <wallet/wallet.h>
|
||||||
|
@ -121,6 +123,14 @@ void EnsureWalletIsUnlocked(const CWallet* pwallet)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
WalletContext& EnsureWalletContext(const util::Ref& context)
|
||||||
|
{
|
||||||
|
if (!context.Has<WalletContext>()) {
|
||||||
|
throw JSONRPCError(RPC_INTERNAL_ERROR, "Wallet context not found");
|
||||||
|
}
|
||||||
|
return context.Get<WalletContext>();
|
||||||
|
}
|
||||||
|
|
||||||
// also_create should only be set to true only when the RPC is expected to add things to a blank wallet and make it no longer blank
|
// also_create should only be set to true only when the RPC is expected to add things to a blank wallet and make it no longer blank
|
||||||
LegacyScriptPubKeyMan& EnsureLegacyScriptPubKeyMan(CWallet& wallet, bool also_create)
|
LegacyScriptPubKeyMan& EnsureLegacyScriptPubKeyMan(CWallet& wallet, bool also_create)
|
||||||
{
|
{
|
||||||
|
@ -2584,6 +2594,7 @@ static UniValue loadwallet(const JSONRPCRequest& request)
|
||||||
},
|
},
|
||||||
}.Check(request);
|
}.Check(request);
|
||||||
|
|
||||||
|
WalletContext& context = EnsureWalletContext(request.context);
|
||||||
WalletLocation location(request.params[0].get_str());
|
WalletLocation location(request.params[0].get_str());
|
||||||
|
|
||||||
if (!location.Exists()) {
|
if (!location.Exists()) {
|
||||||
|
@ -2598,7 +2609,7 @@ static UniValue loadwallet(const JSONRPCRequest& request)
|
||||||
|
|
||||||
bilingual_str error;
|
bilingual_str error;
|
||||||
std::vector<bilingual_str> warnings;
|
std::vector<bilingual_str> warnings;
|
||||||
std::shared_ptr<CWallet> const wallet = LoadWallet(*g_rpc_chain, location, error, warnings);
|
std::shared_ptr<CWallet> const wallet = LoadWallet(*context.chain, location, error, warnings);
|
||||||
if (!wallet) throw JSONRPCError(RPC_WALLET_ERROR, error.original);
|
if (!wallet) throw JSONRPCError(RPC_WALLET_ERROR, error.original);
|
||||||
|
|
||||||
UniValue obj(UniValue::VOBJ);
|
UniValue obj(UniValue::VOBJ);
|
||||||
|
@ -2702,6 +2713,7 @@ static UniValue createwallet(const JSONRPCRequest& request)
|
||||||
},
|
},
|
||||||
}.Check(request);
|
}.Check(request);
|
||||||
|
|
||||||
|
WalletContext& context = EnsureWalletContext(request.context);
|
||||||
uint64_t flags = 0;
|
uint64_t flags = 0;
|
||||||
if (!request.params[1].isNull() && request.params[1].get_bool()) {
|
if (!request.params[1].isNull() && request.params[1].get_bool()) {
|
||||||
flags |= WALLET_FLAG_DISABLE_PRIVATE_KEYS;
|
flags |= WALLET_FLAG_DISABLE_PRIVATE_KEYS;
|
||||||
|
@ -2731,7 +2743,7 @@ static UniValue createwallet(const JSONRPCRequest& request)
|
||||||
|
|
||||||
bilingual_str error;
|
bilingual_str error;
|
||||||
std::shared_ptr<CWallet> wallet;
|
std::shared_ptr<CWallet> wallet;
|
||||||
WalletCreationStatus status = CreateWallet(*g_rpc_chain, passphrase, flags, request.params[0].get_str(), error, warnings, wallet);
|
WalletCreationStatus status = CreateWallet(*context.chain, passphrase, flags, request.params[0].get_str(), error, warnings, wallet);
|
||||||
switch (status) {
|
switch (status) {
|
||||||
case WalletCreationStatus::CREATION_FAILED:
|
case WalletCreationStatus::CREATION_FAILED:
|
||||||
throw JSONRPCError(RPC_WALLET_ERROR, error.original);
|
throw JSONRPCError(RPC_WALLET_ERROR, error.original);
|
||||||
|
@ -4331,5 +4343,3 @@ static const CRPCCommand commands[] =
|
||||||
// clang-format on
|
// clang-format on
|
||||||
return MakeSpan(commands);
|
return MakeSpan(commands);
|
||||||
}
|
}
|
||||||
|
|
||||||
interfaces::Chain* g_rpc_chain = nullptr;
|
|
||||||
|
|
|
@ -16,18 +16,10 @@ class CWallet;
|
||||||
class JSONRPCRequest;
|
class JSONRPCRequest;
|
||||||
class LegacyScriptPubKeyMan;
|
class LegacyScriptPubKeyMan;
|
||||||
class UniValue;
|
class UniValue;
|
||||||
struct PartiallySignedTransaction;
|
|
||||||
class CTransaction;
|
class CTransaction;
|
||||||
|
struct PartiallySignedTransaction;
|
||||||
|
struct WalletContext;
|
||||||
|
|
||||||
namespace interfaces {
|
|
||||||
class Chain;
|
|
||||||
}
|
|
||||||
|
|
||||||
//! Pointer to chain interface that needs to be declared as a global to be
|
|
||||||
//! accessible loadwallet and createwallet methods. Due to limitations of the
|
|
||||||
//! RPC framework, there's currently no direct way to pass in state to RPC
|
|
||||||
//! methods without globals.
|
|
||||||
extern interfaces::Chain* g_rpc_chain;
|
|
||||||
Span<const CRPCCommand> GetWalletRPCCommands();
|
Span<const CRPCCommand> GetWalletRPCCommands();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -40,6 +32,7 @@ std::shared_ptr<CWallet> GetWalletForJSONRPCRequest(const JSONRPCRequest& reques
|
||||||
|
|
||||||
void EnsureWalletIsUnlocked(const CWallet*);
|
void EnsureWalletIsUnlocked(const CWallet*);
|
||||||
bool EnsureWalletIsAvailable(const CWallet*, bool avoidException);
|
bool EnsureWalletIsAvailable(const CWallet*, bool avoidException);
|
||||||
|
WalletContext& EnsureWalletContext(const util::Ref& context);
|
||||||
LegacyScriptPubKeyMan& EnsureLegacyScriptPubKeyMan(CWallet& wallet, bool also_create = false);
|
LegacyScriptPubKeyMan& EnsureLegacyScriptPubKeyMan(CWallet& wallet, bool also_create = false);
|
||||||
|
|
||||||
UniValue getaddressinfo(const JSONRPCRequest& request);
|
UniValue getaddressinfo(const JSONRPCRequest& request);
|
||||||
|
|
Loading…
Reference in a new issue