// Distributed under the MIT/X11 software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#include "rpcserver.h"
#include "chainparams.h"
-#include "db.h"
#include "init.h"
+#include "net.h"
+#include "main.h"
#include "miner.h"
-#include "bitcoinrpc.h"
+#ifdef ENABLE_WALLET
+#include "db.h"
+#include "wallet.h"
+#endif
+#include <stdint.h>
+
+#include <boost/assign/list_of.hpp>
+#include "json/json_spirit_utils.h"
+#include "json/json_spirit_value.h"
using namespace json_spirit;
using namespace std;
-// Key used by getwork/getblocktemplate miners.
+#ifdef ENABLE_WALLET
+// Key used by getwork miners.
// Allocated in InitRPCMining, free'd in ShutdownRPCMining
static CReserveKey* pMiningKey = NULL;
delete pMiningKey; pMiningKey = NULL;
}
+#else
+void InitRPCMining()
+{
+}
+void ShutdownRPCMining()
+{
+}
+#endif
// Return average network hashes per second based on the last 'lookup' blocks,
// or from the last difficulty change if 'lookup' is nonpositive.
// If 'height' is nonnegative, compute the estimate at the time when a given block was found.
Value GetNetworkHashPS(int lookup, int height) {
- CBlockIndex *pb = chainActive[height];
+ CBlockIndex *pb = chainActive.Tip();
+
+ if (height >= 0 && height < chainActive.Height())
+ pb = chainActive[height];
if (pb == NULL || !pb->nHeight)
return 0;
lookup = pb->nHeight;
CBlockIndex *pb0 = pb;
- int64 minTime = pb0->GetBlockTime();
- int64 maxTime = minTime;
+ int64_t minTime = pb0->GetBlockTime();
+ int64_t maxTime = minTime;
for (int i = 0; i < lookup; i++) {
pb0 = pb0->pprev;
- int64 time = pb0->GetBlockTime();
+ int64_t time = pb0->GetBlockTime();
minTime = std::min(time, minTime);
maxTime = std::max(time, maxTime);
}
return 0;
uint256 workDiff = pb->nChainWork - pb0->nChainWork;
- int64 timeDiff = maxTime - minTime;
+ int64_t timeDiff = maxTime - minTime;
- return (boost::int64_t)(workDiff.getdouble() / timeDiff);
+ return (int64_t)(workDiff.getdouble() / timeDiff);
}
Value getnetworkhashps(const Array& params, bool fHelp)
{
if (fHelp || params.size() > 2)
throw runtime_error(
- "getnetworkhashps [blocks] [height]\n"
- "Returns the estimated network hashes per second based on the last 120 blocks.\n"
+ "getnetworkhashps ( blocks height )\n"
+ "\nReturns the estimated network hashes per second based on the last n blocks.\n"
"Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change.\n"
- "Pass in [height] to estimate the network speed at the time when a certain block was found.");
+ "Pass in [height] to estimate the network speed at the time when a certain block was found.\n"
+ "\nArguments:\n"
+ "1. blocks (numeric, optional, default=120) The number of blocks, or -1 for blocks since last difficulty change.\n"
+ "2. height (numeric, optional, default=-1) To estimate at the time of the given height.\n"
+ "\nResult:\n"
+ "x (numeric) Hashes per second estimated\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getnetworkhashps", "")
+ + HelpExampleRpc("getnetworkhashps", "")
+ );
return GetNetworkHashPS(params.size() > 0 ? params[0].get_int() : 120, params.size() > 1 ? params[1].get_int() : -1);
}
-
+#ifdef ENABLE_WALLET
Value getgenerate(const Array& params, bool fHelp)
{
if (fHelp || params.size() != 0)
throw runtime_error(
"getgenerate\n"
- "Returns true or false.");
+ "\nReturn if the server is set to generate coins or not. The default is false.\n"
+ "It is set with the command line argument -gen (or bitcoin.conf setting gen)\n"
+ "It can also be set with the setgenerate call.\n"
+ "\nResult\n"
+ "true|false (boolean) If the server is set to generate coins or not\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getgenerate", "")
+ + HelpExampleRpc("getgenerate", "")
+ );
if (!pMiningKey)
return false;
{
if (fHelp || params.size() < 1 || params.size() > 2)
throw runtime_error(
- "setgenerate <generate> [genproclimit]\n"
- "<generate> is true or false to turn generation on or off.\n"
- "Generation is limited to [genproclimit] processors, -1 is unlimited.");
+ "setgenerate generate ( genproclimit )\n"
+ "\nSet 'generate' true or false to turn generation on or off.\n"
+ "Generation is limited to 'genproclimit' processors, -1 is unlimited.\n"
+ "See the getgenerate call for the current setting.\n"
+ "\nArguments:\n"
+ "1. generate (boolean, required) Set to true to turn on generation, off to turn off.\n"
+ "2. genproclimit (numeric, optional) Set the processor limit for when generation is on. Can be -1 for unlimited.\n"
+ " Note: in -regtest mode, genproclimit controls how many blocks are generated immediately.\n"
+ "\nExamples:\n"
+ "\nSet the generation on with a limit of one processor\n"
+ + HelpExampleCli("setgenerate", "true 1") +
+ "\nCheck the setting\n"
+ + HelpExampleCli("getgenerate", "") +
+ "\nTurn off generation\n"
+ + HelpExampleCli("setgenerate", "false") +
+ "\nUsing json rpc\n"
+ + HelpExampleRpc("setgenerate", "true, 1")
+ );
+
+ if (pwalletMain == NULL)
+ throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Method not found (disabled)");
bool fGenerate = true;
if (params.size() > 0)
fGenerate = params[0].get_bool();
+ int nGenProcLimit = -1;
if (params.size() > 1)
{
- int nGenProcLimit = params[1].get_int();
- mapArgs["-genproclimit"] = itostr(nGenProcLimit);
+ nGenProcLimit = params[1].get_int();
if (nGenProcLimit == 0)
fGenerate = false;
}
- mapArgs["-gen"] = (fGenerate ? "1" : "0");
- assert(pwalletMain != NULL);
- GenerateBitcoins(fGenerate, pwalletMain);
+ // -regtest mode: don't return until nGenProcLimit blocks are generated
+ if (fGenerate && Params().NetworkID() == CChainParams::REGTEST)
+ {
+ int nHeightStart = 0;
+ int nHeightEnd = 0;
+ int nHeight = 0;
+ int nGenerate = (nGenProcLimit > 0 ? nGenProcLimit : 1);
+ { // Don't keep cs_main locked
+ LOCK(cs_main);
+ nHeightStart = chainActive.Height();
+ nHeight = nHeightStart;
+ nHeightEnd = nHeightStart+nGenerate;
+ }
+ int nHeightLast = -1;
+ while (nHeight < nHeightEnd)
+ {
+ if (nHeightLast != nHeight)
+ {
+ nHeightLast = nHeight;
+ GenerateBitcoins(fGenerate, pwalletMain, 1);
+ }
+ MilliSleep(1);
+ { // Don't keep cs_main locked
+ LOCK(cs_main);
+ nHeight = chainActive.Height();
+ }
+ }
+ }
+ else // Not -regtest: start generate thread, return immediately
+ {
+ mapArgs["-gen"] = (fGenerate ? "1" : "0");
+ mapArgs ["-genproclimit"] = itostr(nGenProcLimit);
+ GenerateBitcoins(fGenerate, pwalletMain, nGenProcLimit);
+ }
+
return Value::null;
}
-
Value gethashespersec(const Array& params, bool fHelp)
{
if (fHelp || params.size() != 0)
throw runtime_error(
"gethashespersec\n"
- "Returns a recent hashes per second performance measurement while generating.");
+ "\nReturns a recent hashes per second performance measurement while generating.\n"
+ "See the getgenerate and setgenerate calls to turn generation on and off.\n"
+ "\nResult:\n"
+ "n (numeric) The recent hashes per second when generation is on (will return 0 if generation is off)\n"
+ "\nExamples:\n"
+ + HelpExampleCli("gethashespersec", "")
+ + HelpExampleRpc("gethashespersec", "")
+ );
if (GetTimeMillis() - nHPSTimerStart > 8000)
- return (boost::int64_t)0;
- return (boost::int64_t)dHashesPerSec;
+ return (int64_t)0;
+ return (int64_t)dHashesPerSec;
}
+#endif
Value getmininginfo(const Array& params, bool fHelp)
if (fHelp || params.size() != 0)
throw runtime_error(
"getmininginfo\n"
- "Returns an object containing mining-related information.");
+ "\nReturns a json object containing mining-related information."
+ "\nResult:\n"
+ "{\n"
+ " \"blocks\": nnn, (numeric) The current block\n"
+ " \"currentblocksize\": nnn, (numeric) The last block size\n"
+ " \"currentblocktx\": nnn, (numeric) The last block transaction\n"
+ " \"difficulty\": xxx.xxxxx (numeric) The current difficulty\n"
+ " \"errors\": \"...\" (string) Current errors\n"
+ " \"generate\": true|false (boolean) If the generation is on or off (see getgenerate or setgenerate calls)\n"
+ " \"genproclimit\": n (numeric) The processor limit for generation. -1 if no generation. (see getgenerate or setgenerate calls)\n"
+ " \"hashespersec\": n (numeric) The hashes per second of the generation, or 0 if no generation.\n"
+ " \"pooledtx\": n (numeric) The size of the mem pool\n"
+ " \"testnet\": true|false (boolean) If using testnet or not\n"
+ "}\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getmininginfo", "")
+ + HelpExampleRpc("getmininginfo", "")
+ );
Object obj;
obj.push_back(Pair("blocks", (int)chainActive.Height()));
obj.push_back(Pair("currentblocktx", (uint64_t)nLastBlockTx));
obj.push_back(Pair("difficulty", (double)GetDifficulty()));
obj.push_back(Pair("errors", GetWarnings("statusbar")));
- obj.push_back(Pair("generate", getgenerate(params, false)));
obj.push_back(Pair("genproclimit", (int)GetArg("-genproclimit", -1)));
- obj.push_back(Pair("hashespersec", gethashespersec(params, false)));
obj.push_back(Pair("networkhashps", getnetworkhashps(params, false)));
obj.push_back(Pair("pooledtx", (uint64_t)mempool.size()));
obj.push_back(Pair("testnet", TestNet()));
+#ifdef ENABLE_WALLET
+ obj.push_back(Pair("generate", getgenerate(params, false)));
+ obj.push_back(Pair("hashespersec", gethashespersec(params, false)));
+#endif
return obj;
}
+#ifdef ENABLE_WALLET
Value getwork(const Array& params, bool fHelp)
{
if (fHelp || params.size() > 1)
throw runtime_error(
- "getwork [data]\n"
- "If [data] is not specified, returns formatted hash data to work on:\n"
- " \"midstate\" : precomputed hash state after hashing the first half of the data (DEPRECATED)\n" // deprecated
- " \"data\" : block data\n"
- " \"hash1\" : formatted hash buffer for second hash (DEPRECATED)\n" // deprecated
- " \"target\" : little endian hash target\n"
- "If [data] is specified, tries to solve the block and returns true if it was successful.");
+ "getwork ( \"data\" )\n"
+ "\nIf 'data' is not specified, it returns the formatted hash data to work on.\n"
+ "If 'data' is specified, tries to solve the block and returns true if it was successful.\n"
+ "\nArguments:\n"
+ "1. \"data\" (string, optional) The hex encoded data to solve\n"
+ "\nResult (when 'data' is not specified):\n"
+ "{\n"
+ " \"midstate\" : \"xxxx\", (string) The precomputed hash state after hashing the first half of the data (DEPRECATED)\n" // deprecated
+ " \"data\" : \"xxxxx\", (string) The block data\n"
+ " \"hash1\" : \"xxxxx\", (string) The formatted hash buffer for second hash (DEPRECATED)\n" // deprecated
+ " \"target\" : \"xxxx\" (string) The little endian hash target\n"
+ "}\n"
+ "\nResult (when 'data' is specified):\n"
+ "true|false (boolean) If solving the block specified in the 'data' was successfull\n"
+ "\nExamples:\n"
+ + HelpExampleCli("getwork", "")
+ + HelpExampleRpc("getwork", "")
+ );
if (vNodes.empty())
throw JSONRPCError(RPC_CLIENT_NOT_CONNECTED, "Bitcoin is not connected!");
// Update block
static unsigned int nTransactionsUpdatedLast;
static CBlockIndex* pindexPrev;
- static int64 nStart;
+ static int64_t nStart;
static CBlockTemplate* pblocktemplate;
if (pindexPrev != chainActive.Tip() ||
(mempool.GetTransactionsUpdated() != nTransactionsUpdatedLast && GetTime() - nStart > 60))
char phash1[64];
FormatHashBuffers(pblock, pmidstate, pdata, phash1);
- uint256 hashTarget = CBigNum().SetCompact(pblock->nBits).getuint256();
+ uint256 hashTarget = uint256().SetCompact(pblock->nBits);
Object result;
result.push_back(Pair("midstate", HexStr(BEGIN(pmidstate), END(pmidstate)))); // deprecated
return CheckWork(pblock, *pwalletMain, *pMiningKey);
}
}
-
+#endif
Value getblocktemplate(const Array& params, bool fHelp)
{
if (fHelp || params.size() > 1)
throw runtime_error(
- "getblocktemplate [params]\n"
- "Returns data needed to construct a block to work on:\n"
- " \"version\" : block version\n"
- " \"previousblockhash\" : hash of current highest block\n"
- " \"transactions\" : contents of non-coinbase transactions that should be included in the next block\n"
- " \"coinbaseaux\" : data that should be included in coinbase\n"
- " \"coinbasevalue\" : maximum allowable input to coinbase transaction, including the generation award and transaction fees\n"
- " \"target\" : hash target\n"
- " \"mintime\" : minimum timestamp appropriate for next block\n"
- " \"curtime\" : current timestamp\n"
- " \"mutable\" : list of ways the block template may be changed\n"
- " \"noncerange\" : range of valid nonces\n"
- " \"sigoplimit\" : limit of sigops in blocks\n"
- " \"sizelimit\" : limit of block size\n"
- " \"bits\" : compressed target of next block\n"
- " \"height\" : height of the next block\n"
- "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.");
+ "getblocktemplate ( \"jsonrequestobject\" )\n"
+ "\nIf the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'.\n"
+ "It returns data needed to construct a block to work on.\n"
+ "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.\n"
+
+ "\nArguments:\n"
+ "1. \"jsonrequestobject\" (string, optional) A json object in the following spec\n"
+ " {\n"
+ " \"mode\":\"template\" (string, optional) This must be set to \"template\" or omitted\n"
+ " \"capabilities\":[ (array, optional) A list of strings\n"
+ " \"support\" (string) client side supported feature, 'longpoll', 'coinbasetxn', 'coinbasevalue', 'proposal', 'serverlist', 'workid'\n"
+ " ,...\n"
+ " ]\n"
+ " }\n"
+ "\n"
+
+ "\nResult:\n"
+ "{\n"
+ " \"version\" : n, (numeric) The block version\n"
+ " \"previousblockhash\" : \"xxxx\", (string) The hash of current highest block\n"
+ " \"transactions\" : [ (array) contents of non-coinbase transactions that should be included in the next block\n"
+ " {\n"
+ " \"data\" : \"xxxx\", (string) transaction data encoded in hexadecimal (byte-for-byte)\n"
+ " \"hash\" : \"xxxx\", (string) hash/id encoded in little-endian hexadecimal\n"
+ " \"depends\" : [ (array) array of numbers \n"
+ " n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is\n"
+ " ,...\n"
+ " ],\n"
+ " \"fee\": n, (numeric) difference in value between transaction inputs and outputs (in Satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one\n"
+ " \"sigops\" : n, (numeric) total number of SigOps, as counted for purposes of block limits; if key is not present, sigop count is unknown and clients MUST NOT assume there aren't any\n"
+ " \"required\" : true|false (boolean) if provided and true, this transaction must be in the final block\n"
+ " }\n"
+ " ,...\n"
+ " ],\n"
+ " \"coinbaseaux\" : { (json object) data that should be included in the coinbase's scriptSig content\n"
+ " \"flags\" : \"flags\" (string) \n"
+ " },\n"
+ " \"coinbasevalue\" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in Satoshis)\n"
+ " \"coinbasetxn\" : { ... }, (json object) information for coinbase transaction\n"
+ " \"target\" : \"xxxx\", (string) The hash target\n"
+ " \"mintime\" : xxx, (numeric) The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT)\n"
+ " \"mutable\" : [ (array of string) list of ways the block template may be changed \n"
+ " \"value\" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'\n"
+ " ,...\n"
+ " ],\n"
+ " \"noncerange\" : \"00000000ffffffff\", (string) A range of valid nonces\n"
+ " \"sigoplimit\" : n, (numeric) limit of sigops in blocks\n"
+ " \"sizelimit\" : n, (numeric) limit of block size\n"
+ " \"curtime\" : ttt, (numeric) current timestamp in seconds since epoch (Jan 1 1970 GMT)\n"
+ " \"bits\" : \"xxx\", (string) compressed target of next block\n"
+ " \"height\" : n (numeric) The height of the next block\n"
+ "}\n"
+
+ "\nExamples:\n"
+ + HelpExampleCli("getblocktemplate", "")
+ + HelpExampleRpc("getblocktemplate", "")
+ );
std::string strMode = "template";
if (params.size() > 0)
// Update block
static unsigned int nTransactionsUpdatedLast;
static CBlockIndex* pindexPrev;
- static int64 nStart;
+ static int64_t nStart;
static CBlockTemplate* pblocktemplate;
if (pindexPrev != chainActive.Tip() ||
(mempool.GetTransactionsUpdated() != nTransactionsUpdatedLast && GetTime() - nStart > 5))
Object aux;
aux.push_back(Pair("flags", HexStr(COINBASE_FLAGS.begin(), COINBASE_FLAGS.end())));
- uint256 hashTarget = CBigNum().SetCompact(pblock->nBits).getuint256();
+ uint256 hashTarget = uint256().SetCompact(pblock->nBits);
static Array aMutable;
if (aMutable.empty())
{
if (fHelp || params.size() < 1 || params.size() > 2)
throw runtime_error(
- "submitblock <hex data> [optional-params-obj]\n"
- "[optional-params-obj] parameter is currently ignored.\n"
- "Attempts to submit new block to network.\n"
- "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.");
+ "submitblock \"hexdata\" ( \"jsonparametersobject\" )\n"
+ "\nAttempts to submit new block to network.\n"
+ "The 'jsonparametersobject' parameter is currently ignored.\n"
+ "See https://en.bitcoin.it/wiki/BIP_0022 for full specification.\n"
+
+ "\nArguments\n"
+ "1. \"hexdata\" (string, required) the hex-encoded block data to submit\n"
+ "2. \"jsonparametersobject\" (string, optional) object of optional parameters\n"
+ " {\n"
+ " \"workid\" : \"id\" (string, optional) if the server provided a workid, it MUST be included with submissions\n"
+ " }\n"
+ "\nResult:\n"
+ "\nExamples:\n"
+ + HelpExampleCli("submitblock", "\"mydata\"")
+ + HelpExampleRpc("submitblock", "\"mydata\"")
+ );
vector<unsigned char> blockData(ParseHex(params[0].get_str()));
CDataStream ssBlock(blockData, SER_NETWORK, PROTOCOL_VERSION);
return Value::null;
}
+
+Value estimatefee(const Array& params, bool fHelp)
+{
+ if (fHelp || params.size() != 1)
+ throw runtime_error(
+ "estimatefee nblocks\n"
+ "\nEstimates the approximate fee per kilobyte\n"
+ "needed for a transaction to get confirmed\n"
+ "within nblocks blocks.\n"
+ "\nArguments:\n"
+ "1. nblocks (numeric)\n"
+ "\nResult:\n"
+ "n : (numeric) estimated fee-per-kilobyte\n"
+ "\n"
+ "-1.0 is returned if not enough transactions and\n"
+ "blocks have been observed to make an estimate.\n"
+ "\nExample:\n"
+ + HelpExampleCli("estimatefee", "6")
+ );
+
+ RPCTypeCheck(params, boost::assign::list_of(int_type));
+
+ int nBlocks = params[0].get_int();
+ if (nBlocks < 1)
+ nBlocks = 1;
+
+ CFeeRate feeRate = mempool.estimateFee(nBlocks);
+ if (feeRate == CFeeRate(0))
+ return -1.0;
+
+ return ValueFromAmount(feeRate.GetFeePerK());
+}
+
+Value estimatepriority(const Array& params, bool fHelp)
+{
+ if (fHelp || params.size() != 1)
+ throw runtime_error(
+ "estimatepriority nblocks\n"
+ "\nEstimates the approximate priority\n"
+ "a zero-fee transaction needs to get confirmed\n"
+ "within nblocks blocks.\n"
+ "\nArguments:\n"
+ "1. nblocks (numeric)\n"
+ "\nResult:\n"
+ "n : (numeric) estimated priority\n"
+ "\n"
+ "-1.0 is returned if not enough transactions and\n"
+ "blocks have been observed to make an estimate.\n"
+ "\nExample:\n"
+ + HelpExampleCli("estimatepriority", "6")
+ );
+
+ RPCTypeCheck(params, boost::assign::list_of(int_type));
+
+ int nBlocks = params[0].get_int();
+ if (nBlocks < 1)
+ nBlocks = 1;
+
+ return mempool.estimatePriority(nBlocks);
+}