src/rpcserver.h

   1 // Copyright (c) 2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2014 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #ifndef BITCOIN_RPCSERVER_H
   7 #define BITCOIN_RPCSERVER_H
   8
   9 #include "amount.h"
  10 #include "rpcprotocol.h"
  11 #include "uint256.h"
  12
  13 #include <list>
  14 #include <map>
  15 #include <stdint.h>
  16 #include <string>
  17 #include <memory>
  18
  19 #include "json/json_spirit_reader_template.h"
  20 #include "json/json_spirit_utils.h"
  21 #include "json/json_spirit_writer_template.h"
  22
  23 class AsyncRPCQueue;
  24 class CRPCCommand;
  25
  26 namespace RPCServer
  27 {
  28     void OnStarted(boost::function<void ()> slot);
  29     void OnStopped(boost::function<void ()> slot);
  30     void OnPreCommand(boost::function<void (const CRPCCommand&)> slot);
  31     void OnPostCommand(boost::function<void (const CRPCCommand&)> slot);
  32 }
  33
  34 class CBlockIndex;
  35 class CNetAddr;
  36
  37 class AcceptedConnection
  38 {
  39 public:
  40     virtual ~AcceptedConnection() {}
  41
  42     virtual std::iostream& stream() = 0;
  43     virtual std::string peer_address_to_string() const = 0;
  44     virtual void close() = 0;
  45 };
  46
  47 /** Start RPC threads */
  48 void StartRPCThreads();
  49 /**
  50  * Alternative to StartRPCThreads for the GUI, when no server is
  51  * used. The RPC thread in this case is only used to handle timeouts.
  52  * If real RPC threads have already been started this is a no-op.
  53  */
  54 void StartDummyRPCThread();
  55 /** Stop RPC threads */
  56 void StopRPCThreads();
  57 /** Query whether RPC is running */
  58 bool IsRPCRunning();
  59
  60 /** Get the async queue*/
  61 std::shared_ptr<AsyncRPCQueue> getAsyncRPCQueue();
  62
  63
  64 /**
  65  * Set the RPC warmup status.  When this is done, all RPC calls will error out
  66  * immediately with RPC_IN_WARMUP.
  67  */
  68 void SetRPCWarmupStatus(const std::string& newStatus);
  69 /* Mark warmup as done.  RPC calls will be processed from now on.  */
  70 void SetRPCWarmupFinished();
  71
  72 /* returns the current warmup state.  */
  73 bool RPCIsInWarmup(std::string *statusOut);
  74
  75 /**
  76  * Type-check arguments; throws JSONRPCError if wrong type given. Does not check that
  77  * the right number of arguments are passed, just that any passed are the correct type.
  78  * Use like:  RPCTypeCheck(params, boost::assign::list_of(str_type)(int_type)(obj_type));
  79  */
  80 void RPCTypeCheck(const json_spirit::Array& params,
  81                   const std::list<json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
  82 /**
  83  * Check for expected keys/value types in an Object.
  84  * Use like: RPCTypeCheck(object, boost::assign::map_list_of("name", str_type)("value", int_type));
  85  */
  86 void RPCTypeCheck(const json_spirit::Object& o,
  87                   const std::map<std::string, json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
  88
  89 /**
  90  * Run func nSeconds from now. Uses boost deadline timers.
  91  * Overrides previous timer <name> (if any).
  92  */
  93 void RPCRunLater(const std::string& name, boost::function<void(void)> func, int64_t nSeconds);
  94
  95 //! Convert boost::asio address to CNetAddr
  96 extern CNetAddr BoostAsioToCNetAddr(boost::asio::ip::address address);
  97
  98 typedef json_spirit::Value(*rpcfn_type)(const json_spirit::Array& params, bool fHelp);
  99
 100 class CRPCCommand
 101 {
 102 public:
 103     std::string category;
 104     std::string name;
 105     rpcfn_type actor;
 106     bool okSafeMode;
 107 };
 108
 109 /**
 110  * Bitcoin RPC command dispatcher.
 111  */
 112 class CRPCTable
 113 {
 114 private:
 115     std::map<std::string, const CRPCCommand*> mapCommands;
 116 public:
 117     CRPCTable();
 118     const CRPCCommand* operator[](std::string name) const;
 119     std::string help(std::string name) const;
 120
 121     /**
 122      * Execute a method.
 123      * @param method   Method to execute
 124      * @param params   Array of arguments (JSON objects)
 125      * @returns Result of the call.
 126      * @throws an exception (json_spirit::Value) when an error happens.
 127      */
 128     json_spirit::Value execute(const std::string &method, const json_spirit::Array &params) const;
 129 };
 130
 131 extern const CRPCTable tableRPC;
 132
 133 /**
 134  * Utilities: convert hex-encoded Values
 135  * (throws error if not hex).
 136  */
 137 extern uint256 ParseHashV(const json_spirit::Value& v, std::string strName);
 138 extern uint256 ParseHashO(const json_spirit::Object& o, std::string strKey);
 139 extern std::vector<unsigned char> ParseHexV(const json_spirit::Value& v, std::string strName);
 140 extern std::vector<unsigned char> ParseHexO(const json_spirit::Object& o, std::string strKey);
 141
 142 extern void InitRPCMining();
 143 extern void ShutdownRPCMining();
 144
 145 extern int64_t nWalletUnlockTime;
 146 extern CAmount AmountFromValue(const json_spirit::Value& value);
 147 extern json_spirit::Value ValueFromAmount(const CAmount& amount);
 148 extern double GetDifficulty(const CBlockIndex* blockindex = NULL);
 149 extern double GetNetworkDifficulty(const CBlockIndex* blockindex = NULL);
 150 extern std::string HelpRequiringPassphrase();
 151 extern std::string HelpExampleCli(std::string methodname, std::string args);
 152 extern std::string HelpExampleRpc(std::string methodname, std::string args);
 153
 154 extern void EnsureWalletIsUnlocked();
 155
 156 extern json_spirit::Value getconnectioncount(const json_spirit::Array& params, bool fHelp); // in rpcnet.cpp
 157 extern json_spirit::Value getpeerinfo(const json_spirit::Array& params, bool fHelp);
 158 extern json_spirit::Value ping(const json_spirit::Array& params, bool fHelp);
 159 extern json_spirit::Value addnode(const json_spirit::Array& params, bool fHelp);
 160 extern json_spirit::Value getaddednodeinfo(const json_spirit::Array& params, bool fHelp);
 161 extern json_spirit::Value getnettotals(const json_spirit::Array& params, bool fHelp);
 162
 163 extern json_spirit::Value dumpprivkey(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 164 extern json_spirit::Value importprivkey(const json_spirit::Array& params, bool fHelp);
 165 extern json_spirit::Value importaddress(const json_spirit::Array& params, bool fHelp);
 166 extern json_spirit::Value dumpwallet(const json_spirit::Array& params, bool fHelp);
 167 extern json_spirit::Value importwallet(const json_spirit::Array& params, bool fHelp);
 168
 169 extern json_spirit::Value getgenerate(const json_spirit::Array& params, bool fHelp); // in rpcmining.cpp
 170 extern json_spirit::Value setgenerate(const json_spirit::Array& params, bool fHelp);
 171 extern json_spirit::Value generate(const json_spirit::Array& params, bool fHelp);
 172 extern json_spirit::Value getnetworkhashps(const json_spirit::Array& params, bool fHelp);
 173 extern json_spirit::Value getmininginfo(const json_spirit::Array& params, bool fHelp);
 174 extern json_spirit::Value prioritisetransaction(const json_spirit::Array& params, bool fHelp);
 175 extern json_spirit::Value getblocktemplate(const json_spirit::Array& params, bool fHelp);
 176 extern json_spirit::Value submitblock(const json_spirit::Array& params, bool fHelp);
 177 extern json_spirit::Value estimatefee(const json_spirit::Array& params, bool fHelp);
 178 extern json_spirit::Value estimatepriority(const json_spirit::Array& params, bool fHelp);
 179
 180 extern json_spirit::Value getnewaddress(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 181 extern json_spirit::Value getaccountaddress(const json_spirit::Array& params, bool fHelp);
 182 extern json_spirit::Value getrawchangeaddress(const json_spirit::Array& params, bool fHelp);
 183 extern json_spirit::Value setaccount(const json_spirit::Array& params, bool fHelp);
 184 extern json_spirit::Value getaccount(const json_spirit::Array& params, bool fHelp);
 185 extern json_spirit::Value getaddressesbyaccount(const json_spirit::Array& params, bool fHelp);
 186 extern json_spirit::Value sendtoaddress(const json_spirit::Array& params, bool fHelp);
 187 extern json_spirit::Value signmessage(const json_spirit::Array& params, bool fHelp);
 188 extern json_spirit::Value verifymessage(const json_spirit::Array& params, bool fHelp);
 189 extern json_spirit::Value getreceivedbyaddress(const json_spirit::Array& params, bool fHelp);
 190 extern json_spirit::Value getreceivedbyaccount(const json_spirit::Array& params, bool fHelp);
 191 extern json_spirit::Value getbalance(const json_spirit::Array& params, bool fHelp);
 192 extern json_spirit::Value getunconfirmedbalance(const json_spirit::Array& params, bool fHelp);
 193 extern json_spirit::Value movecmd(const json_spirit::Array& params, bool fHelp);
 194 extern json_spirit::Value sendfrom(const json_spirit::Array& params, bool fHelp);
 195 extern json_spirit::Value sendmany(const json_spirit::Array& params, bool fHelp);
 196 extern json_spirit::Value addmultisigaddress(const json_spirit::Array& params, bool fHelp);
 197 extern json_spirit::Value createmultisig(const json_spirit::Array& params, bool fHelp);
 198 extern json_spirit::Value listreceivedbyaddress(const json_spirit::Array& params, bool fHelp);
 199 extern json_spirit::Value listreceivedbyaccount(const json_spirit::Array& params, bool fHelp);
 200 extern json_spirit::Value listtransactions(const json_spirit::Array& params, bool fHelp);
 201 extern json_spirit::Value listaddressgroupings(const json_spirit::Array& params, bool fHelp);
 202 extern json_spirit::Value listaccounts(const json_spirit::Array& params, bool fHelp);
 203 extern json_spirit::Value listsinceblock(const json_spirit::Array& params, bool fHelp);
 204 extern json_spirit::Value gettransaction(const json_spirit::Array& params, bool fHelp);
 205 extern json_spirit::Value backupwallet(const json_spirit::Array& params, bool fHelp);
 206 extern json_spirit::Value keypoolrefill(const json_spirit::Array& params, bool fHelp);
 207 extern json_spirit::Value walletpassphrase(const json_spirit::Array& params, bool fHelp);
 208 extern json_spirit::Value walletpassphrasechange(const json_spirit::Array& params, bool fHelp);
 209 extern json_spirit::Value walletlock(const json_spirit::Array& params, bool fHelp);
 210 extern json_spirit::Value encryptwallet(const json_spirit::Array& params, bool fHelp);
 211 extern json_spirit::Value validateaddress(const json_spirit::Array& params, bool fHelp);
 212 extern json_spirit::Value getinfo(const json_spirit::Array& params, bool fHelp);
 213 extern json_spirit::Value getwalletinfo(const json_spirit::Array& params, bool fHelp);
 214 extern json_spirit::Value getblockchaininfo(const json_spirit::Array& params, bool fHelp);
 215 extern json_spirit::Value getnetworkinfo(const json_spirit::Array& params, bool fHelp);
 216 extern json_spirit::Value setmocktime(const json_spirit::Array& params, bool fHelp);
 217 extern json_spirit::Value resendwallettransactions(const json_spirit::Array& params, bool fHelp);
 218 extern json_spirit::Value zc_benchmark(const json_spirit::Array& params, bool fHelp);
 219 extern json_spirit::Value zc_raw_keygen(const json_spirit::Array& params, bool fHelp);
 220 extern json_spirit::Value zc_raw_joinsplit(const json_spirit::Array& params, bool fHelp);
 221 extern json_spirit::Value zc_raw_receive(const json_spirit::Array& params, bool fHelp);
 222 extern json_spirit::Value zc_sample_joinsplit(const json_spirit::Array& params, bool fHelp);
 223
 224 extern json_spirit::Value getrawtransaction(const json_spirit::Array& params, bool fHelp); // in rcprawtransaction.cpp
 225 extern json_spirit::Value listunspent(const json_spirit::Array& params, bool fHelp);
 226 extern json_spirit::Value lockunspent(const json_spirit::Array& params, bool fHelp);
 227 extern json_spirit::Value listlockunspent(const json_spirit::Array& params, bool fHelp);
 228 extern json_spirit::Value createrawtransaction(const json_spirit::Array& params, bool fHelp);
 229 extern json_spirit::Value decoderawtransaction(const json_spirit::Array& params, bool fHelp);
 230 extern json_spirit::Value decodescript(const json_spirit::Array& params, bool fHelp);
 231 extern json_spirit::Value signrawtransaction(const json_spirit::Array& params, bool fHelp);
 232 extern json_spirit::Value sendrawtransaction(const json_spirit::Array& params, bool fHelp);
 233 extern json_spirit::Value gettxoutproof(const json_spirit::Array& params, bool fHelp);
 234 extern json_spirit::Value verifytxoutproof(const json_spirit::Array& params, bool fHelp);
 235
 236 extern json_spirit::Value getblockcount(const json_spirit::Array& params, bool fHelp); // in rpcblockchain.cpp
 237 extern json_spirit::Value getbestblockhash(const json_spirit::Array& params, bool fHelp);
 238 extern json_spirit::Value getdifficulty(const json_spirit::Array& params, bool fHelp);
 239 extern json_spirit::Value settxfee(const json_spirit::Array& params, bool fHelp);
 240 extern json_spirit::Value getmempoolinfo(const json_spirit::Array& params, bool fHelp);
 241 extern json_spirit::Value getrawmempool(const json_spirit::Array& params, bool fHelp);
 242 extern json_spirit::Value getblockhash(const json_spirit::Array& params, bool fHelp);
 243 extern json_spirit::Value getblock(const json_spirit::Array& params, bool fHelp);
 244 extern json_spirit::Value gettxoutsetinfo(const json_spirit::Array& params, bool fHelp);
 245 extern json_spirit::Value gettxout(const json_spirit::Array& params, bool fHelp);
 246 extern json_spirit::Value verifychain(const json_spirit::Array& params, bool fHelp);
 247 extern json_spirit::Value getchaintips(const json_spirit::Array& params, bool fHelp);
 248 extern json_spirit::Value invalidateblock(const json_spirit::Array& params, bool fHelp);
 249 extern json_spirit::Value reconsiderblock(const json_spirit::Array& params, bool fHelp);
 250
 251 extern json_spirit::Value getblocksubsidy(const json_spirit::Array& params, bool fHelp);
 252
 253 extern json_spirit::Value z_exportkey(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 254 extern json_spirit::Value z_importkey(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 255 extern json_spirit::Value z_getnewaddress(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 256 extern json_spirit::Value z_listaddresses(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 257 extern json_spirit::Value z_exportwallet(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 258 extern json_spirit::Value z_importwallet(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 259 extern json_spirit::Value z_listreceivedbyaddress(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 260 extern json_spirit::Value z_getbalance(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 261 extern json_spirit::Value z_gettotalbalance(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 262 extern json_spirit::Value z_sendmany(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 263 extern json_spirit::Value z_getoperationstatus(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 264 extern json_spirit::Value z_getoperationresult(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 265 extern json_spirit::Value z_listoperationids(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 266 extern json_spirit::Value z_validateaddress(const json_spirit::Array& params, bool fHelp); // in rpcmisc.cpp
 267
 268
 269 // in rest.cpp
 270 extern bool HTTPReq_REST(AcceptedConnection *conn,
 271                   const std::string& strURI,
 272                   const std::string& strRequest,
 273                   const std::map<std::string, std::string>& mapHeaders,
 274                   bool fRun);
 275
 276 #endif // BITCOIN_RPCSERVER_H