src/rpcserver.h

   1 // Copyright (c) 2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2014 The Bitcoin developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #ifndef _BITCOINRPC_SERVER_H_
   7 #define _BITCOINRPC_SERVER_H_ 1
   8
   9 #include "uint256.h"
  10 #include "rpcprotocol.h"
  11
  12 #include <list>
  13 #include <map>
  14 #include <stdint.h>
  15 #include <string>
  16
  17 #include "json/json_spirit_reader_template.h"
  18 #include "json/json_spirit_utils.h"
  19 #include "json/json_spirit_writer_template.h"
  20
  21 class CBlockIndex;
  22
  23 /* Start RPC threads */
  24 void StartRPCThreads();
  25 /* Alternative to StartRPCThreads for the GUI, when no server is
  26  * used. The RPC thread in this case is only used to handle timeouts.
  27  * If real RPC threads have already been started this is a no-op.
  28  */
  29 void StartDummyRPCThread();
  30 /* Stop RPC threads */
  31 void StopRPCThreads();
  32
  33 /*
  34   Type-check arguments; throws JSONRPCError if wrong type given. Does not check that
  35   the right number of arguments are passed, just that any passed are the correct type.
  36   Use like:  RPCTypeCheck(params, boost::assign::list_of(str_type)(int_type)(obj_type));
  37 */
  38 void RPCTypeCheck(const json_spirit::Array& params,
  39                   const std::list<json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
  40 /*
  41   Check for expected keys/value types in an Object.
  42   Use like: RPCTypeCheck(object, boost::assign::map_list_of("name", str_type)("value", int_type));
  43 */
  44 void RPCTypeCheck(const json_spirit::Object& o,
  45                   const std::map<std::string, json_spirit::Value_type>& typesExpected, bool fAllowNull=false);
  46
  47 /*
  48   Run func nSeconds from now. Uses boost deadline timers.
  49   Overrides previous timer <name> (if any).
  50  */
  51 void RPCRunLater(const std::string& name, boost::function<void(void)> func, int64_t nSeconds);
  52
  53 typedef json_spirit::Value(*rpcfn_type)(const json_spirit::Array& params, bool fHelp);
  54
  55 class CRPCCommand
  56 {
  57 public:
  58     std::string name;
  59     rpcfn_type actor;
  60     bool okSafeMode;
  61     bool threadSafe;
  62     bool reqWallet;
  63 };
  64
  65 /**
  66  * Bitcoin RPC command dispatcher.
  67  */
  68 class CRPCTable
  69 {
  70 private:
  71     std::map<std::string, const CRPCCommand*> mapCommands;
  72 public:
  73     CRPCTable();
  74     const CRPCCommand* operator[](std::string name) const;
  75     std::string help(std::string name) const;
  76
  77     /**
  78      * Execute a method.
  79      * @param method   Method to execute
  80      * @param params   Array of arguments (JSON objects)
  81      * @returns Result of the call.
  82      * @throws an exception (json_spirit::Value) when an error happens.
  83      */
  84     json_spirit::Value execute(const std::string &method, const json_spirit::Array &params) const;
  85 };
  86
  87 extern const CRPCTable tableRPC;
  88
  89 //
  90 // Utilities: convert hex-encoded Values
  91 // (throws error if not hex).
  92 //
  93 extern uint256 ParseHashV(const json_spirit::Value& v, std::string strName);
  94 extern uint256 ParseHashO(const json_spirit::Object& o, std::string strKey);
  95 extern std::vector<unsigned char> ParseHexV(const json_spirit::Value& v, std::string strName);
  96 extern std::vector<unsigned char> ParseHexO(const json_spirit::Object& o, std::string strKey);
  97
  98 extern void InitRPCMining();
  99 extern void ShutdownRPCMining();
 100
 101 extern int64_t nWalletUnlockTime;
 102 extern int64_t AmountFromValue(const json_spirit::Value& value);
 103 extern json_spirit::Value ValueFromAmount(int64_t amount);
 104 extern double GetDifficulty(const CBlockIndex* blockindex = NULL);
 105 extern std::string HexBits(unsigned int nBits);
 106 extern std::string HelpRequiringPassphrase();
 107 extern std::string HelpExampleCli(std::string methodname, std::string args);
 108 extern std::string HelpExampleRpc(std::string methodname, std::string args);
 109
 110 extern void EnsureWalletIsUnlocked();
 111
 112 extern json_spirit::Value getconnectioncount(const json_spirit::Array& params, bool fHelp); // in rpcnet.cpp
 113 extern json_spirit::Value getpeerinfo(const json_spirit::Array& params, bool fHelp);
 114 extern json_spirit::Value ping(const json_spirit::Array& params, bool fHelp);
 115 extern json_spirit::Value addnode(const json_spirit::Array& params, bool fHelp);
 116 extern json_spirit::Value getaddednodeinfo(const json_spirit::Array& params, bool fHelp);
 117 extern json_spirit::Value getnettotals(const json_spirit::Array& params, bool fHelp);
 118
 119 extern json_spirit::Value dumpprivkey(const json_spirit::Array& params, bool fHelp); // in rpcdump.cpp
 120 extern json_spirit::Value importprivkey(const json_spirit::Array& params, bool fHelp);
 121 extern json_spirit::Value dumpwallet(const json_spirit::Array& params, bool fHelp);
 122 extern json_spirit::Value importwallet(const json_spirit::Array& params, bool fHelp);
 123
 124 extern json_spirit::Value getgenerate(const json_spirit::Array& params, bool fHelp); // in rpcmining.cpp
 125 extern json_spirit::Value setgenerate(const json_spirit::Array& params, bool fHelp);
 126 extern json_spirit::Value getnetworkhashps(const json_spirit::Array& params, bool fHelp);
 127 extern json_spirit::Value gethashespersec(const json_spirit::Array& params, bool fHelp);
 128 extern json_spirit::Value getmininginfo(const json_spirit::Array& params, bool fHelp);
 129 extern json_spirit::Value getwork(const json_spirit::Array& params, bool fHelp);
 130 extern json_spirit::Value getblocktemplate(const json_spirit::Array& params, bool fHelp);
 131 extern json_spirit::Value submitblock(const json_spirit::Array& params, bool fHelp);
 132
 133 extern json_spirit::Value getnewaddress(const json_spirit::Array& params, bool fHelp); // in rpcwallet.cpp
 134 extern json_spirit::Value getaccountaddress(const json_spirit::Array& params, bool fHelp);
 135 extern json_spirit::Value getrawchangeaddress(const json_spirit::Array& params, bool fHelp);
 136 extern json_spirit::Value setaccount(const json_spirit::Array& params, bool fHelp);
 137 extern json_spirit::Value getaccount(const json_spirit::Array& params, bool fHelp);
 138 extern json_spirit::Value getaddressesbyaccount(const json_spirit::Array& params, bool fHelp);
 139 extern json_spirit::Value sendtoaddress(const json_spirit::Array& params, bool fHelp);
 140 extern json_spirit::Value signmessage(const json_spirit::Array& params, bool fHelp);
 141 extern json_spirit::Value verifymessage(const json_spirit::Array& params, bool fHelp);
 142 extern json_spirit::Value getreceivedbyaddress(const json_spirit::Array& params, bool fHelp);
 143 extern json_spirit::Value getreceivedbyaccount(const json_spirit::Array& params, bool fHelp);
 144 extern json_spirit::Value getbalance(const json_spirit::Array& params, bool fHelp);
 145 extern json_spirit::Value getunconfirmedbalance(const json_spirit::Array& params, bool fHelp);
 146 extern json_spirit::Value movecmd(const json_spirit::Array& params, bool fHelp);
 147 extern json_spirit::Value sendfrom(const json_spirit::Array& params, bool fHelp);
 148 extern json_spirit::Value sendmany(const json_spirit::Array& params, bool fHelp);
 149 extern json_spirit::Value addmultisigaddress(const json_spirit::Array& params, bool fHelp);
 150 extern json_spirit::Value createmultisig(const json_spirit::Array& params, bool fHelp);
 151 extern json_spirit::Value listreceivedbyaddress(const json_spirit::Array& params, bool fHelp);
 152 extern json_spirit::Value listreceivedbyaccount(const json_spirit::Array& params, bool fHelp);
 153 extern json_spirit::Value listtransactions(const json_spirit::Array& params, bool fHelp);
 154 extern json_spirit::Value listaddressgroupings(const json_spirit::Array& params, bool fHelp);
 155 extern json_spirit::Value listaccounts(const json_spirit::Array& params, bool fHelp);
 156 extern json_spirit::Value listsinceblock(const json_spirit::Array& params, bool fHelp);
 157 extern json_spirit::Value gettransaction(const json_spirit::Array& params, bool fHelp);
 158 extern json_spirit::Value backupwallet(const json_spirit::Array& params, bool fHelp);
 159 extern json_spirit::Value keypoolrefill(const json_spirit::Array& params, bool fHelp);
 160 extern json_spirit::Value walletpassphrase(const json_spirit::Array& params, bool fHelp);
 161 extern json_spirit::Value walletpassphrasechange(const json_spirit::Array& params, bool fHelp);
 162 extern json_spirit::Value walletlock(const json_spirit::Array& params, bool fHelp);
 163 extern json_spirit::Value encryptwallet(const json_spirit::Array& params, bool fHelp);
 164 extern json_spirit::Value validateaddress(const json_spirit::Array& params, bool fHelp);
 165 extern json_spirit::Value getinfo(const json_spirit::Array& params, bool fHelp);
 166 extern json_spirit::Value getwalletinfo(const json_spirit::Array& params, bool fHelp);
 167
 168 extern json_spirit::Value getrawtransaction(const json_spirit::Array& params, bool fHelp); // in rcprawtransaction.cpp
 169 extern json_spirit::Value listunspent(const json_spirit::Array& params, bool fHelp);
 170 extern json_spirit::Value lockunspent(const json_spirit::Array& params, bool fHelp);
 171 extern json_spirit::Value listlockunspent(const json_spirit::Array& params, bool fHelp);
 172 extern json_spirit::Value createrawtransaction(const json_spirit::Array& params, bool fHelp);
 173 extern json_spirit::Value decoderawtransaction(const json_spirit::Array& params, bool fHelp);
 174 extern json_spirit::Value decodescript(const json_spirit::Array& params, bool fHelp);
 175 extern json_spirit::Value signrawtransaction(const json_spirit::Array& params, bool fHelp);
 176 extern json_spirit::Value sendrawtransaction(const json_spirit::Array& params, bool fHelp);
 177
 178 extern json_spirit::Value getblockcount(const json_spirit::Array& params, bool fHelp); // in rpcblockchain.cpp
 179 extern json_spirit::Value getbestblockhash(const json_spirit::Array& params, bool fHelp);
 180 extern json_spirit::Value getdifficulty(const json_spirit::Array& params, bool fHelp);
 181 extern json_spirit::Value settxfee(const json_spirit::Array& params, bool fHelp);
 182 extern json_spirit::Value getrawmempool(const json_spirit::Array& params, bool fHelp);
 183 extern json_spirit::Value getblockhash(const json_spirit::Array& params, bool fHelp);
 184 extern json_spirit::Value getblock(const json_spirit::Array& params, bool fHelp);
 185 extern json_spirit::Value gettxoutsetinfo(const json_spirit::Array& params, bool fHelp);
 186 extern json_spirit::Value gettxout(const json_spirit::Array& params, bool fHelp);
 187 extern json_spirit::Value verifychain(const json_spirit::Array& params, bool fHelp);
 188
 189 #endif