2012-08-21 08:21:33 +02:00
// Copyright (c) 2010 Satoshi Nakamoto
2014-12-17 02:47:57 +01:00
// Copyright (c) 2009-2014 The Bitcoin Core developers
2014-11-20 03:19:29 +01:00
// Distributed under the MIT software license, see the accompanying
2012-08-21 08:21:33 +02:00
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
2014-10-23 02:05:11 +02:00
# include "amount.h"
2015-07-05 14:17:46 +02:00
# include "chain.h"
2013-05-07 15:16:25 +02:00
# include "chainparams.h"
2015-01-24 15:29:29 +01:00
# include "consensus/consensus.h"
2015-01-24 15:57:12 +01:00
# include "consensus/validation.h"
2014-09-14 12:43:56 +02:00
# include "core_io.h"
2012-08-21 08:21:33 +02:00
# include "init.h"
2013-04-13 07:13:08 +02:00
# include "main.h"
2013-07-31 15:43:35 +02:00
# include "miner.h"
2015-01-24 15:29:29 +01:00
# include "net.h"
2014-03-10 16:46:53 +01:00
# include "pow.h"
2014-09-14 12:43:56 +02:00
# include "rpcserver.h"
2015-07-05 14:17:46 +02:00
# include "txmempool.h"
Split up util.cpp/h
Split up util.cpp/h into:
- string utilities (hex, base32, base64): no internal dependencies, no dependency on boost (apart from foreach)
- money utilities (parsesmoney, formatmoney)
- time utilities (gettime*, sleep, format date):
- and the rest (logging, argument parsing, config file parsing)
The latter is basically the environment and OS handling,
and is stripped of all utility functions, so we may want to
rename it to something else than util.cpp/h for clarity (Matt suggested
osinterface).
Breaks dependency of sha256.cpp on all the things pulled in by util.
2014-08-21 16:11:09 +02:00
# include "util.h"
2015-07-05 14:17:46 +02:00
# include "utilstrencodings.h"
2015-03-24 22:14:44 +01:00
# include "validationinterface.h"
2014-05-10 14:54:20 +02:00
2013-04-13 07:13:08 +02:00
# include <stdint.h>
2014-03-17 13:19:54 +01:00
# include <boost/assign/list_of.hpp>
2015-07-01 08:32:30 +02:00
# include <boost/shared_ptr.hpp>
2014-05-10 14:54:20 +02:00
2015-09-04 16:11:34 +02:00
# include <univalue.h>
2012-08-21 08:21:33 +02:00
using namespace std ;
2014-11-20 03:19:29 +01:00
/**
* 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 .
*/
2015-05-13 21:29:19 +02:00
UniValue GetNetworkHashPS ( int lookup , int height ) {
2013-12-29 12:14:06 +01:00
CBlockIndex * pb = chainActive . Tip ( ) ;
if ( height > = 0 & & height < chainActive . Height ( ) )
pb = chainActive [ height ] ;
2013-05-17 12:57:05 +02:00
if ( pb = = NULL | | ! pb - > nHeight )
return 0 ;
// If lookup is -1, then use blocks since last difficulty change.
if ( lookup < = 0 )
2015-04-10 18:35:09 +02:00
lookup = pb - > nHeight % Params ( ) . GetConsensus ( ) . DifficultyAdjustmentInterval ( ) + 1 ;
2013-05-17 12:57:05 +02:00
// If lookup is larger than chain, then set it to chain length.
if ( lookup > pb - > nHeight )
lookup = pb - > nHeight ;
CBlockIndex * pb0 = pb ;
2013-04-13 07:13:08 +02:00
int64_t minTime = pb0 - > GetBlockTime ( ) ;
int64_t maxTime = minTime ;
2013-05-17 12:57:05 +02:00
for ( int i = 0 ; i < lookup ; i + + ) {
pb0 = pb0 - > pprev ;
2013-04-13 07:13:08 +02:00
int64_t time = pb0 - > GetBlockTime ( ) ;
2013-05-17 12:57:05 +02:00
minTime = std : : min ( time , minTime ) ;
maxTime = std : : max ( time , maxTime ) ;
}
// In case there's a situation where minTime == maxTime, we don't want a divide by zero exception.
if ( minTime = = maxTime )
return 0 ;
2014-12-16 15:43:03 +01:00
arith_uint256 workDiff = pb - > nChainWork - pb0 - > nChainWork ;
2013-04-13 07:13:08 +02:00
int64_t timeDiff = maxTime - minTime ;
2013-05-17 12:57:05 +02:00
2014-05-05 20:08:13 +02:00
return ( int64_t ) ( workDiff . getdouble ( ) / timeDiff ) ;
2013-05-17 12:57:05 +02:00
}
2015-05-18 14:02:18 +02:00
UniValue getnetworkhashps ( const UniValue & params , bool fHelp )
2013-05-17 12:57:05 +02:00
{
if ( fHelp | | params . size ( ) > 2 )
throw runtime_error (
2013-10-29 12:29:44 +01:00
" getnetworkhashps ( blocks height ) \n "
" \n Returns the estimated network hashes per second based on the last n blocks. \n "
2013-05-17 12:57:05 +02:00
" Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change. \n "
2013-10-29 12:29:44 +01:00
" Pass in [height] to estimate the network speed at the time when a certain block was found. \n "
" \n Arguments: \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 "
" \n Result: \n "
" x (numeric) Hashes per second estimated \n "
" \n Examples: \n "
+ HelpExampleCli ( " getnetworkhashps " , " " )
+ HelpExampleRpc ( " getnetworkhashps " , " " )
) ;
2013-05-17 12:57:05 +02:00
2014-10-19 10:46:17 +02:00
LOCK ( cs_main ) ;
2013-05-17 12:57:05 +02:00
return GetNetworkHashPS ( params . size ( ) > 0 ? params [ 0 ] . get_int ( ) : 120 , params . size ( ) > 1 ? params [ 1 ] . get_int ( ) : - 1 ) ;
}
2015-05-18 14:02:18 +02:00
UniValue getgenerate ( const UniValue & params , bool fHelp )
2012-08-21 08:21:33 +02:00
{
if ( fHelp | | params . size ( ) ! = 0 )
throw runtime_error (
" getgenerate \n "
2013-10-29 12:29:44 +01:00
" \n Return 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 "
" \n Result \n "
" true|false (boolean) If the server is set to generate coins or not \n "
" \n Examples: \n "
+ HelpExampleCli ( " getgenerate " , " " )
+ HelpExampleRpc ( " getgenerate " , " " )
) ;
2012-08-21 08:21:33 +02:00
2014-10-19 10:46:17 +02:00
LOCK ( cs_main ) ;
2013-04-28 17:37:50 +02:00
return GetBoolArg ( " -gen " , false ) ;
2012-08-21 08:21:33 +02:00
}
2015-05-18 14:02:18 +02:00
UniValue generate ( const UniValue & params , bool fHelp )
2015-04-01 05:28:28 +02:00
{
if ( fHelp | | params . size ( ) < 1 | | params . size ( ) > 1 )
throw runtime_error (
" generate numblocks \n "
" \n Mine blocks immediately (before the RPC call returns) \n "
2015-04-10 07:33:06 +02:00
" \n Note: this function can only be used on the regtest network \n "
2015-09-04 11:05:17 +02:00
" \n Arguments: \n "
2015-09-03 19:29:10 +02:00
" 1. numblocks (numeric, required) How many blocks are generated immediately. \n "
2015-04-01 05:28:28 +02:00
" \n Result \n "
" [ blockhashes ] (array) hashes of blocks generated \n "
" \n Examples: \n "
" \n Generate 11 blocks \n "
+ HelpExampleCli ( " generate " , " 11 " )
) ;
2015-04-10 07:33:06 +02:00
if ( ! Params ( ) . MineBlocksOnDemand ( ) )
throw JSONRPCError ( RPC_METHOD_NOT_FOUND , " This method can only be used on regtest " ) ;
2015-04-01 05:28:28 +02:00
int nHeightStart = 0 ;
int nHeightEnd = 0 ;
int nHeight = 0 ;
int nGenerate = params [ 0 ] . get_int ( ) ;
2015-04-10 12:49:01 +02:00
2015-07-01 08:32:30 +02:00
boost : : shared_ptr < CReserveScript > coinbaseScript ;
2015-04-10 12:49:01 +02:00
GetMainSignals ( ) . ScriptForMining ( coinbaseScript ) ;
2015-08-18 09:07:33 +02:00
// If the keypool is exhausted, no script is returned at all. Catch this.
if ( ! coinbaseScript )
throw JSONRPCError ( RPC_WALLET_KEYPOOL_RAN_OUT , " Error: Keypool ran out, please call keypoolrefill first " ) ;
2015-04-10 12:49:01 +02:00
//throw an error if no script was provided
2015-08-18 09:07:33 +02:00
if ( coinbaseScript - > reserveScript . empty ( ) )
2015-04-10 12:49:01 +02:00
throw JSONRPCError ( RPC_INTERNAL_ERROR , " No coinbase script available (mining requires a wallet) " ) ;
2015-04-01 05:28:28 +02:00
{ // Don't keep cs_main locked
LOCK ( cs_main ) ;
nHeightStart = chainActive . Height ( ) ;
nHeight = nHeightStart ;
nHeightEnd = nHeightStart + nGenerate ;
}
2015-04-10 07:33:06 +02:00
unsigned int nExtraNonce = 0 ;
2015-05-10 14:48:35 +02:00
UniValue blockHashes ( UniValue : : VARR ) ;
2015-04-10 07:33:06 +02:00
while ( nHeight < nHeightEnd )
{
2015-07-01 08:32:30 +02:00
auto_ptr < CBlockTemplate > pblocktemplate ( CreateNewBlock ( coinbaseScript - > reserveScript ) ) ;
2015-04-10 07:33:06 +02:00
if ( ! pblocktemplate . get ( ) )
2015-04-10 12:49:01 +02:00
throw JSONRPCError ( RPC_INTERNAL_ERROR , " Couldn't create new block " ) ;
2015-04-10 07:33:06 +02:00
CBlock * pblock = & pblocktemplate - > block ;
{
LOCK ( cs_main ) ;
IncrementExtraNonce ( pblock , chainActive . Tip ( ) , nExtraNonce ) ;
}
while ( ! CheckProofOfWork ( pblock - > GetHash ( ) , pblock - > nBits , Params ( ) . GetConsensus ( ) ) ) {
// Yes, there is a chance every nonce could fail to satisfy the -regtest
// target -- 1 in 2^(2^32). That ain't gonna happen.
+ + pblock - > nNonce ;
}
CValidationState state ;
2015-04-20 00:17:11 +02:00
if ( ! ProcessNewBlock ( state , Params ( ) , NULL , pblock , true , NULL ) )
2015-04-10 07:33:06 +02:00
throw JSONRPCError ( RPC_INTERNAL_ERROR , " ProcessNewBlock, block not accepted " ) ;
2015-04-01 05:28:28 +02:00
+ + nHeight ;
2015-04-10 07:33:06 +02:00
blockHashes . push_back ( pblock - > GetHash ( ) . GetHex ( ) ) ;
2015-07-01 08:32:30 +02:00
//mark script as important because it was used at least for one coinbase output
coinbaseScript - > KeepScript ( ) ;
2015-04-01 05:28:28 +02:00
}
return blockHashes ;
}
2012-08-21 08:21:33 +02:00
2015-05-18 14:02:18 +02:00
UniValue setgenerate ( const UniValue & params , bool fHelp )
2012-08-21 08:21:33 +02:00
{
if ( fHelp | | params . size ( ) < 1 | | params . size ( ) > 2 )
throw runtime_error (
2013-10-29 12:29:44 +01:00
" setgenerate generate ( genproclimit ) \n "
" \n Set '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 "
" \n Arguments: \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 "
" \n Examples: \n "
" \n Set the generation on with a limit of one processor \n "
+ HelpExampleCli ( " setgenerate " , " true 1 " ) +
" \n Check the setting \n "
+ HelpExampleCli ( " getgenerate " , " " ) +
" \n Turn off generation \n "
+ HelpExampleCli ( " setgenerate " , " false " ) +
" \n Using json rpc \n "
+ HelpExampleRpc ( " setgenerate " , " true, 1 " )
) ;
2012-08-21 08:21:33 +02:00
2015-04-21 10:14:06 +02:00
if ( Params ( ) . MineBlocksOnDemand ( ) )
throw JSONRPCError ( RPC_METHOD_NOT_FOUND , " Use the generate method instead of setgenerate on this network " ) ;
2013-11-21 05:07:55 +01:00
2012-08-21 08:21:33 +02:00
bool fGenerate = true ;
if ( params . size ( ) > 0 )
fGenerate = params [ 0 ] . get_bool ( ) ;
2015-06-28 01:48:38 +02:00
int nGenProcLimit = GetArg ( " -genproclimit " , DEFAULT_GENERATE_THREADS ) ;
2012-08-21 08:21:33 +02:00
if ( params . size ( ) > 1 )
{
2013-11-21 05:07:55 +01:00
nGenProcLimit = params [ 1 ] . get_int ( ) ;
2012-08-21 08:21:33 +02:00
if ( nGenProcLimit = = 0 )
fGenerate = false ;
}
2015-04-01 05:28:28 +02:00
mapArgs [ " -gen " ] = ( fGenerate ? " 1 " : " 0 " ) ;
mapArgs [ " -genproclimit " ] = itostr ( nGenProcLimit ) ;
2015-04-10 12:49:01 +02:00
GenerateBitcoins ( fGenerate , nGenProcLimit , Params ( ) ) ;
2013-11-21 05:07:55 +01:00
2014-08-20 21:15:16 +02:00
return NullUniValue ;
2012-08-21 08:21:33 +02:00
}
2015-05-18 14:02:18 +02:00
UniValue getmininginfo ( const UniValue & params , bool fHelp )
2012-08-21 08:21:33 +02:00
{
if ( fHelp | | params . size ( ) ! = 0 )
throw runtime_error (
" getmininginfo \n "
2013-10-29 12:29:44 +01:00
" \n Returns a json object containing mining-related information. "
" \n Result: \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 "
" \" pooledtx \" : n (numeric) The size of the mem pool \n "
" \" testnet \" : true|false (boolean) If using testnet or not \n "
2014-06-12 14:52:12 +02:00
" \" chain \" : \" xxxx \" , (string) current network name as defined in BIP70 (main, test, regtest) \n "
2013-10-29 12:29:44 +01:00
" } \n "
" \n Examples: \n "
+ HelpExampleCli ( " getmininginfo " , " " )
+ HelpExampleRpc ( " getmininginfo " , " " )
) ;
2012-08-21 08:21:33 +02:00
2014-10-19 10:46:17 +02:00
LOCK ( cs_main ) ;
2015-05-10 14:48:35 +02:00
UniValue obj ( UniValue : : VOBJ ) ;
2013-10-10 23:07:44 +02:00
obj . push_back ( Pair ( " blocks " , ( int ) chainActive . Height ( ) ) ) ;
2013-04-28 17:37:50 +02:00
obj . push_back ( Pair ( " currentblocksize " , ( uint64_t ) nLastBlockSize ) ) ;
obj . push_back ( Pair ( " currentblocktx " , ( uint64_t ) nLastBlockTx ) ) ;
obj . push_back ( Pair ( " difficulty " , ( double ) GetDifficulty ( ) ) ) ;
obj . push_back ( Pair ( " errors " , GetWarnings ( " statusbar " ) ) ) ;
2015-06-28 01:48:38 +02:00
obj . push_back ( Pair ( " genproclimit " , ( int ) GetArg ( " -genproclimit " , DEFAULT_GENERATE_THREADS ) ) ) ;
2013-05-17 12:57:05 +02:00
obj . push_back ( Pair ( " networkhashps " , getnetworkhashps ( params , false ) ) ) ;
2013-04-28 17:37:50 +02:00
obj . push_back ( Pair ( " pooledtx " , ( uint64_t ) mempool . size ( ) ) ) ;
2014-08-31 22:32:52 +02:00
obj . push_back ( Pair ( " testnet " , Params ( ) . TestnetToBeDeprecatedFieldRPC ( ) ) ) ;
2014-06-12 14:52:12 +02:00
obj . push_back ( Pair ( " chain " , Params ( ) . NetworkIDString ( ) ) ) ;
2013-12-08 15:26:08 +01:00
obj . push_back ( Pair ( " generate " , getgenerate ( params , false ) ) ) ;
2012-08-21 08:21:33 +02:00
return obj ;
}
2014-12-01 13:51:45 +01:00
// NOTE: Unlike wallet RPC (which use BTC values), mining RPCs follow GBT (BIP 22) in using satoshi amounts
2015-05-18 14:02:18 +02:00
UniValue prioritisetransaction ( const UniValue & params , bool fHelp )
2012-07-11 20:52:41 +02:00
{
if ( fHelp | | params . size ( ) ! = 3 )
throw runtime_error (
" prioritisetransaction <txid> <priority delta> <fee delta> \n "
2014-07-15 02:11:55 +02:00
" Accepts the transaction into mined blocks at a higher (or lower) priority \n "
" \n Arguments: \n "
" 1. \" txid \" (string, required) The transaction id. \n "
" 2. priority delta (numeric, required) The priority to add or subtract. \n "
" The transaction selection algorithm considers the tx as it would have a higher priority. \n "
" (priority of a transaction is calculated: coinage * value_in_satoshis / txsize) \n "
2014-12-01 13:51:45 +01:00
" 3. fee delta (numeric, required) The fee value (in satoshis) to add (or subtract, if negative). \n "
2014-07-15 02:11:55 +02:00
" The fee is not actually paid, only the algorithm for selecting transactions into a block \n "
" considers the transaction as it would have paid a higher (or lower) fee. \n "
" \n Result \n "
" true (boolean) Returns true \n "
" \n Examples: \n "
2014-12-01 13:51:45 +01:00
+ HelpExampleCli ( " prioritisetransaction " , " \" txid \" 0.0 10000 " )
+ HelpExampleRpc ( " prioritisetransaction " , " \" txid \" , 0.0, 10000 " )
2014-07-15 02:11:55 +02:00
) ;
2012-07-11 20:52:41 +02:00
2014-10-19 10:46:17 +02:00
LOCK ( cs_main ) ;
2014-07-15 02:11:55 +02:00
2014-10-19 10:46:17 +02:00
uint256 hash = ParseHashStr ( params [ 0 ] . get_str ( ) , " txid " ) ;
2014-12-01 13:51:45 +01:00
CAmount nAmount = params [ 2 ] . get_int64 ( ) ;
2014-07-15 02:11:55 +02:00
mempool . PrioritiseTransaction ( hash , params [ 0 ] . get_str ( ) , params [ 1 ] . get_real ( ) , nAmount ) ;
2012-07-11 20:52:41 +02:00
return true ;
}
2014-10-30 03:56:33 +01:00
// NOTE: Assumes a conclusive result; if result is inconclusive, it must be handled by caller
2015-05-13 21:29:19 +02:00
static UniValue BIP22ValidationResult ( const CValidationState & state )
2014-10-30 03:56:33 +01:00
{
if ( state . IsValid ( ) )
2015-05-18 14:02:18 +02:00
return NullUniValue ;
2014-10-30 03:56:33 +01:00
std : : string strRejectReason = state . GetRejectReason ( ) ;
if ( state . IsError ( ) )
throw JSONRPCError ( RPC_VERIFY_ERROR , strRejectReason ) ;
if ( state . IsInvalid ( ) )
{
if ( strRejectReason . empty ( ) )
return " rejected " ;
return strRejectReason ;
}
// Should be impossible
return " valid? " ;
}
2015-05-18 14:02:18 +02:00
UniValue getblocktemplate ( const UniValue & params , bool fHelp )
2012-08-21 08:21:33 +02:00
{
2012-10-24 18:39:46 +02:00
if ( fHelp | | params . size ( ) > 1 )
2012-08-21 08:21:33 +02:00
throw runtime_error (
2013-10-29 12:29:44 +01:00
" getblocktemplate ( \" jsonrequestobject \" ) \n "
" \n If 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 "
" \n Arguments: \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 "
" \n Result: \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 "
" \n Examples: \n "
+ HelpExampleCli ( " getblocktemplate " , " " )
+ HelpExampleRpc ( " getblocktemplate " , " " )
) ;
2012-08-21 08:21:33 +02:00
2014-10-19 10:46:17 +02:00
LOCK ( cs_main ) ;
2012-08-21 08:21:33 +02:00
std : : string strMode = " template " ;
2015-05-13 21:29:19 +02:00
UniValue lpval = NullUniValue ;
2012-08-21 08:21:33 +02:00
if ( params . size ( ) > 0 )
{
2015-05-18 14:02:18 +02:00
const UniValue & oparam = params [ 0 ] . get_obj ( ) ;
const UniValue & modeval = find_value ( oparam , " mode " ) ;
2014-08-20 21:15:16 +02:00
if ( modeval . isStr ( ) )
2012-08-21 08:21:33 +02:00
strMode = modeval . get_str ( ) ;
2014-08-20 21:15:16 +02:00
else if ( modeval . isNull ( ) )
2012-09-01 09:12:50 +02:00
{
/* Do nothing */
}
2012-08-21 08:21:33 +02:00
else
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_INVALID_PARAMETER , " Invalid mode " ) ;
2012-05-13 06:43:24 +02:00
lpval = find_value ( oparam , " longpollid " ) ;
2012-09-10 04:55:03 +02:00
if ( strMode = = " proposal " )
{
2015-05-18 14:02:18 +02:00
const UniValue & dataval = find_value ( oparam , " data " ) ;
2015-06-04 21:39:44 +02:00
if ( ! dataval . isStr ( ) )
2012-09-10 04:55:03 +02:00
throw JSONRPCError ( RPC_TYPE_ERROR , " Missing data String key for proposal " ) ;
CBlock block ;
if ( ! DecodeHexBlk ( block , dataval . get_str ( ) ) )
throw JSONRPCError ( RPC_DESERIALIZATION_ERROR , " Block decode failed " ) ;
uint256 hash = block . GetHash ( ) ;
BlockMap : : iterator mi = mapBlockIndex . find ( hash ) ;
if ( mi ! = mapBlockIndex . end ( ) ) {
CBlockIndex * pindex = mi - > second ;
if ( pindex - > IsValid ( BLOCK_VALID_SCRIPTS ) )
return " duplicate " ;
if ( pindex - > nStatus & BLOCK_FAILED_MASK )
return " duplicate-invalid " ;
return " duplicate-inconclusive " ;
}
CBlockIndex * const pindexPrev = chainActive . Tip ( ) ;
// TestBlockValidity only supports blocks built on the current Tip
if ( block . hashPrevBlock ! = pindexPrev - > GetBlockHash ( ) )
return " inconclusive-not-best-prevblk " ;
CValidationState state ;
2015-04-20 00:17:11 +02:00
TestBlockValidity ( state , Params ( ) , block , pindexPrev , false , true ) ;
2012-09-10 04:55:03 +02:00
return BIP22ValidationResult ( state ) ;
}
2012-08-21 08:21:33 +02:00
}
if ( strMode ! = " template " )
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_INVALID_PARAMETER , " Invalid mode " ) ;
2012-08-21 08:21:33 +02:00
if ( vNodes . empty ( ) )
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_CLIENT_NOT_CONNECTED , " Bitcoin is not connected! " ) ;
2012-08-21 08:21:33 +02:00
if ( IsInitialBlockDownload ( ) )
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_CLIENT_IN_INITIAL_DOWNLOAD , " Bitcoin is downloading blocks... " ) ;
2012-08-21 08:21:33 +02:00
static unsigned int nTransactionsUpdatedLast ;
2012-05-13 06:43:24 +02:00
2014-08-20 21:15:16 +02:00
if ( ! lpval . isNull ( ) )
2012-05-13 06:43:24 +02:00
{
// Wait to respond until either the best block changes, OR a minute has passed and there are more transactions
uint256 hashWatchedChain ;
boost : : system_time checktxtime ;
unsigned int nTransactionsUpdatedLastLP ;
2014-08-20 21:15:16 +02:00
if ( lpval . isStr ( ) )
2012-05-13 06:43:24 +02:00
{
// Format: <hashBestChain><nTransactionsUpdatedLast>
std : : string lpstr = lpval . get_str ( ) ;
hashWatchedChain . SetHex ( lpstr . substr ( 0 , 64 ) ) ;
nTransactionsUpdatedLastLP = atoi64 ( lpstr . substr ( 64 ) ) ;
}
else
{
// NOTE: Spec does not specify behaviour for non-string longpollid, but this makes testing easier
hashWatchedChain = chainActive . Tip ( ) - > GetBlockHash ( ) ;
nTransactionsUpdatedLastLP = nTransactionsUpdatedLast ;
}
// Release the wallet and main lock while waiting
LEAVE_CRITICAL_SECTION ( cs_main ) ;
{
checktxtime = boost : : get_system_time ( ) + boost : : posix_time : : minutes ( 1 ) ;
boost : : unique_lock < boost : : mutex > lock ( csBestBlock ) ;
while ( chainActive . Tip ( ) - > GetBlockHash ( ) = = hashWatchedChain & & IsRPCRunning ( ) )
{
if ( ! cvBlockChange . timed_wait ( lock , checktxtime ) )
{
// Timeout: Check transactions for update
if ( mempool . GetTransactionsUpdated ( ) ! = nTransactionsUpdatedLastLP )
break ;
checktxtime + = boost : : posix_time : : seconds ( 10 ) ;
}
}
}
ENTER_CRITICAL_SECTION ( cs_main ) ;
if ( ! IsRPCRunning ( ) )
throw JSONRPCError ( RPC_CLIENT_NOT_CONNECTED , " Shutting down " ) ;
// TODO: Maybe recheck connections/IBD and (if something wrong) send an expires-immediately template to stop miners?
}
// Update block
2012-08-21 08:21:33 +02:00
static CBlockIndex * pindexPrev ;
2013-04-13 07:13:08 +02:00
static int64_t nStart ;
2012-12-19 21:21:21 +01:00
static CBlockTemplate * pblocktemplate ;
2013-10-10 23:07:44 +02:00
if ( pindexPrev ! = chainActive . Tip ( ) | |
2013-08-27 07:51:57 +02:00
( mempool . GetTransactionsUpdated ( ) ! = nTransactionsUpdatedLast & & GetTime ( ) - nStart > 5 ) )
2012-08-21 08:21:33 +02:00
{
// Clear pindexPrev so future calls make a new block, despite any failures from here on
pindexPrev = NULL ;
// Store the pindexBest used before CreateNewBlock, to avoid races
2013-08-27 07:51:57 +02:00
nTransactionsUpdatedLast = mempool . GetTransactionsUpdated ( ) ;
2015-04-10 07:33:06 +02:00
CBlockIndex * pindexPrevNew = chainActive . Tip ( ) ;
2012-08-21 08:21:33 +02:00
nStart = GetTime ( ) ;
// Create new block
2012-12-19 21:21:21 +01:00
if ( pblocktemplate )
2012-08-21 08:21:33 +02:00
{
2012-12-19 21:21:21 +01:00
delete pblocktemplate ;
pblocktemplate = NULL ;
2012-08-21 08:21:33 +02:00
}
2013-08-24 06:45:17 +02:00
CScript scriptDummy = CScript ( ) < < OP_TRUE ;
2015-04-10 07:33:06 +02:00
pblocktemplate = CreateNewBlock ( scriptDummy ) ;
2012-12-19 21:21:21 +01:00
if ( ! pblocktemplate )
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_OUT_OF_MEMORY , " Out of memory " ) ;
2012-08-21 08:21:33 +02:00
// Need to update only after we know CreateNewBlock succeeded
pindexPrev = pindexPrevNew ;
}
2012-12-19 21:21:21 +01:00
CBlock * pblock = & pblocktemplate - > block ; // pointer for convenience
2012-08-21 08:21:33 +02:00
// Update nTime
2015-04-10 18:42:50 +02:00
UpdateTime ( pblock , Params ( ) . GetConsensus ( ) , pindexPrev ) ;
2012-08-21 08:21:33 +02:00
pblock - > nNonce = 0 ;
2015-05-10 14:48:35 +02:00
UniValue aCaps ( UniValue : : VARR ) ; aCaps . push_back ( " proposal " ) ;
2012-09-10 04:55:03 +02:00
2015-05-10 14:48:35 +02:00
UniValue transactions ( UniValue : : VARR ) ;
2012-08-21 08:21:33 +02:00
map < uint256 , int64_t > setTxIndex ;
int i = 0 ;
2015-05-31 15:36:44 +02:00
BOOST_FOREACH ( const CTransaction & tx , pblock - > vtx ) {
2012-08-21 08:21:33 +02:00
uint256 txHash = tx . GetHash ( ) ;
setTxIndex [ txHash ] = i + + ;
if ( tx . IsCoinBase ( ) )
continue ;
2015-05-10 14:48:35 +02:00
UniValue entry ( UniValue : : VOBJ ) ;
2012-08-21 08:21:33 +02:00
2014-06-24 05:10:24 +02:00
entry . push_back ( Pair ( " data " , EncodeHexTx ( tx ) ) ) ;
2012-08-21 08:21:33 +02:00
entry . push_back ( Pair ( " hash " , txHash . GetHex ( ) ) ) ;
2015-05-10 14:48:35 +02:00
UniValue deps ( UniValue : : VARR ) ;
Ultraprune
This switches bitcoin's transaction/block verification logic to use a
"coin database", which contains all unredeemed transaction output scripts,
amounts and heights.
The name ultraprune comes from the fact that instead of a full transaction
index, we only (need to) keep an index with unspent outputs. For now, the
blocks themselves are kept as usual, although they are only necessary for
serving, rescanning and reorganizing.
The basic datastructures are CCoins (representing the coins of a single
transaction), and CCoinsView (representing a state of the coins database).
There are several implementations for CCoinsView. A dummy, one backed by
the coins database (coins.dat), one backed by the memory pool, and one
that adds a cache on top of it. FetchInputs, ConnectInputs, ConnectBlock,
DisconnectBlock, ... now operate on a generic CCoinsView.
The block switching logic now builds a single cached CCoinsView with
changes to be committed to the database before any changes are made.
This means no uncommitted changes are ever read from the database, and
should ease the transition to another database layer which does not
support transactions (but does support atomic writes), like LevelDB.
For the getrawtransaction() RPC call, access to a txid-to-disk index
would be preferable. As this index is not necessary or even useful
for any other part of the implementation, it is not provided. Instead,
getrawtransaction() uses the coin database to find the block height,
and then scans that block to find the requested transaction. This is
slow, but should suffice for debug purposes.
2012-07-01 18:54:00 +02:00
BOOST_FOREACH ( const CTxIn & in , tx . vin )
2012-08-21 08:21:33 +02:00
{
Ultraprune
This switches bitcoin's transaction/block verification logic to use a
"coin database", which contains all unredeemed transaction output scripts,
amounts and heights.
The name ultraprune comes from the fact that instead of a full transaction
index, we only (need to) keep an index with unspent outputs. For now, the
blocks themselves are kept as usual, although they are only necessary for
serving, rescanning and reorganizing.
The basic datastructures are CCoins (representing the coins of a single
transaction), and CCoinsView (representing a state of the coins database).
There are several implementations for CCoinsView. A dummy, one backed by
the coins database (coins.dat), one backed by the memory pool, and one
that adds a cache on top of it. FetchInputs, ConnectInputs, ConnectBlock,
DisconnectBlock, ... now operate on a generic CCoinsView.
The block switching logic now builds a single cached CCoinsView with
changes to be committed to the database before any changes are made.
This means no uncommitted changes are ever read from the database, and
should ease the transition to another database layer which does not
support transactions (but does support atomic writes), like LevelDB.
For the getrawtransaction() RPC call, access to a txid-to-disk index
would be preferable. As this index is not necessary or even useful
for any other part of the implementation, it is not provided. Instead,
getrawtransaction() uses the coin database to find the block height,
and then scans that block to find the requested transaction. This is
slow, but should suffice for debug purposes.
2012-07-01 18:54:00 +02:00
if ( setTxIndex . count ( in . prevout . hash ) )
deps . push_back ( setTxIndex [ in . prevout . hash ] ) ;
}
entry . push_back ( Pair ( " depends " , deps ) ) ;
2012-08-21 08:21:33 +02:00
2013-02-08 00:54:22 +01:00
int index_in_template = i - 1 ;
2013-01-04 05:58:36 +01:00
entry . push_back ( Pair ( " fee " , pblocktemplate - > vTxFees [ index_in_template ] ) ) ;
entry . push_back ( Pair ( " sigops " , pblocktemplate - > vTxSigOps [ index_in_template ] ) ) ;
2012-08-21 08:21:33 +02:00
transactions . push_back ( entry ) ;
}
2015-05-10 14:48:35 +02:00
UniValue aux ( UniValue : : VOBJ ) ;
2012-08-21 08:21:33 +02:00
aux . push_back ( Pair ( " flags " , HexStr ( COINBASE_FLAGS . begin ( ) , COINBASE_FLAGS . end ( ) ) ) ) ;
2014-12-16 15:43:03 +01:00
arith_uint256 hashTarget = arith_uint256 ( ) . SetCompact ( pblock - > nBits ) ;
2012-08-21 08:21:33 +02:00
2015-05-10 14:48:35 +02:00
static UniValue aMutable ( UniValue : : VARR ) ;
2012-08-21 08:21:33 +02:00
if ( aMutable . empty ( ) )
{
aMutable . push_back ( " time " ) ;
aMutable . push_back ( " transactions " ) ;
aMutable . push_back ( " prevblock " ) ;
}
2015-05-10 14:48:35 +02:00
UniValue result ( UniValue : : VOBJ ) ;
2012-09-10 04:55:03 +02:00
result . push_back ( Pair ( " capabilities " , aCaps ) ) ;
2012-08-21 08:21:33 +02:00
result . push_back ( Pair ( " version " , pblock - > nVersion ) ) ;
result . push_back ( Pair ( " previousblockhash " , pblock - > hashPrevBlock . GetHex ( ) ) ) ;
result . push_back ( Pair ( " transactions " , transactions ) ) ;
result . push_back ( Pair ( " coinbaseaux " , aux ) ) ;
result . push_back ( Pair ( " coinbasevalue " , ( int64_t ) pblock - > vtx [ 0 ] . vout [ 0 ] . nValue ) ) ;
2012-05-13 06:43:24 +02:00
result . push_back ( Pair ( " longpollid " , chainActive . Tip ( ) - > GetBlockHash ( ) . GetHex ( ) + i64tostr ( nTransactionsUpdatedLast ) ) ) ;
2012-08-21 08:21:33 +02:00
result . push_back ( Pair ( " target " , hashTarget . GetHex ( ) ) ) ;
result . push_back ( Pair ( " mintime " , ( int64_t ) pindexPrev - > GetMedianTimePast ( ) + 1 ) ) ;
result . push_back ( Pair ( " mutable " , aMutable ) ) ;
result . push_back ( Pair ( " noncerange " , " 00000000ffffffff " ) ) ;
result . push_back ( Pair ( " sigoplimit " , ( int64_t ) MAX_BLOCK_SIGOPS ) ) ;
result . push_back ( Pair ( " sizelimit " , ( int64_t ) MAX_BLOCK_SIZE ) ) ;
2014-06-28 23:36:06 +02:00
result . push_back ( Pair ( " curtime " , pblock - > GetBlockTime ( ) ) ) ;
2014-06-27 13:28:08 +02:00
result . push_back ( Pair ( " bits " , strprintf ( " %08x " , pblock - > nBits ) ) ) ;
2012-08-21 08:21:33 +02:00
result . push_back ( Pair ( " height " , ( int64_t ) ( pindexPrev - > nHeight + 1 ) ) ) ;
return result ;
}
2014-10-20 06:18:00 +02:00
class submitblock_StateCatcher : public CValidationInterface
{
public :
uint256 hash ;
bool found ;
CValidationState state ;
submitblock_StateCatcher ( const uint256 & hashIn ) : hash ( hashIn ) , found ( false ) , state ( ) { } ;
protected :
virtual void BlockChecked ( const CBlock & block , const CValidationState & stateIn ) {
if ( block . GetHash ( ) ! = hash )
return ;
found = true ;
state = stateIn ;
} ;
} ;
2015-05-18 14:02:18 +02:00
UniValue submitblock ( const UniValue & params , bool fHelp )
2012-08-21 08:21:33 +02:00
{
if ( fHelp | | params . size ( ) < 1 | | params . size ( ) > 2 )
throw runtime_error (
2013-10-29 12:29:44 +01:00
" submitblock \" hexdata \" ( \" jsonparametersobject \" ) \n "
" \n Attempts 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 "
" \n Arguments \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 "
" \n Result: \n "
" \n Examples: \n "
+ HelpExampleCli ( " submitblock " , " \" mydata \" " )
+ HelpExampleRpc ( " submitblock " , " \" mydata \" " )
) ;
2012-08-21 08:21:33 +02:00
2014-11-18 20:09:20 +01:00
CBlock block ;
if ( ! DecodeHexBlk ( block , params [ 0 ] . get_str ( ) ) )
2012-10-04 09:34:44 +02:00
throw JSONRPCError ( RPC_DESERIALIZATION_ERROR , " Block decode failed " ) ;
2012-08-21 08:21:33 +02:00
2014-11-18 20:09:20 +01:00
uint256 hash = block . GetHash ( ) ;
2015-04-13 18:55:41 +02:00
bool fBlockPresent = false ;
{
LOCK ( cs_main ) ;
BlockMap : : iterator mi = mapBlockIndex . find ( hash ) ;
if ( mi ! = mapBlockIndex . end ( ) ) {
CBlockIndex * pindex = mi - > second ;
if ( pindex - > IsValid ( BLOCK_VALID_SCRIPTS ) )
return " duplicate " ;
if ( pindex - > nStatus & BLOCK_FAILED_MASK )
return " duplicate-invalid " ;
// Otherwise, we might only have the header - process the block before returning
fBlockPresent = true ;
}
2012-08-21 08:21:33 +02:00
}
2013-01-27 00:14:11 +01:00
CValidationState state ;
2014-11-18 20:09:20 +01:00
submitblock_StateCatcher sc ( block . GetHash ( ) ) ;
2014-10-20 06:18:00 +02:00
RegisterValidationInterface ( & sc ) ;
2015-04-20 00:17:11 +02:00
bool fAccepted = ProcessNewBlock ( state , Params ( ) , NULL , & block , true , NULL ) ;
2014-10-20 06:18:00 +02:00
UnregisterValidationInterface ( & sc ) ;
2015-04-13 18:55:41 +02:00
if ( fBlockPresent )
2014-11-18 20:09:20 +01:00
{
if ( fAccepted & & ! sc . found )
return " duplicate-inconclusive " ;
return " duplicate " ;
}
2014-10-20 06:18:00 +02:00
if ( fAccepted )
{
if ( ! sc . found )
return " inconclusive " ;
state = sc . state ;
}
2014-10-30 03:56:33 +01:00
return BIP22ValidationResult ( state ) ;
2012-08-21 08:21:33 +02:00
}
2014-03-17 13:19:54 +01:00
2015-05-18 14:02:18 +02:00
UniValue estimatefee ( const UniValue & params , bool fHelp )
2014-03-17 13:19:54 +01:00
{
if ( fHelp | | params . size ( ) ! = 1 )
throw runtime_error (
" estimatefee nblocks \n "
2015-07-08 21:40:14 +02:00
" \n Estimates the approximate fee per kilobyte needed for a transaction to begin \n "
" confirmation within nblocks blocks. \n "
2014-03-17 13:19:54 +01:00
" \n Arguments: \n "
" 1. nblocks (numeric) \n "
" \n Result: \n "
2015-07-08 21:40:14 +02:00
" n (numeric) estimated fee-per-kilobyte \n "
2014-03-17 13:19:54 +01:00
" \n "
2015-07-08 21:40:14 +02:00
" A negative value is returned if not enough transactions and blocks \n "
" have been observed to make an estimate. \n "
2014-03-17 13:19:54 +01:00
" \n Example: \n "
+ HelpExampleCli ( " estimatefee " , " 6 " )
) ;
2014-08-20 21:15:16 +02:00
RPCTypeCheck ( params , boost : : assign : : list_of ( UniValue : : VNUM ) ) ;
2014-03-17 13:19:54 +01:00
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 ( ) ) ;
}
2015-05-18 14:02:18 +02:00
UniValue estimatepriority ( const UniValue & params , bool fHelp )
2014-03-17 13:19:54 +01:00
{
if ( fHelp | | params . size ( ) ! = 1 )
throw runtime_error (
" estimatepriority nblocks \n "
2015-07-08 21:40:14 +02:00
" \n Estimates the approximate priority a zero-fee transaction needs to begin \n "
" confirmation within nblocks blocks. \n "
2014-03-17 13:19:54 +01:00
" \n Arguments: \n "
" 1. nblocks (numeric) \n "
" \n Result: \n "
2015-07-08 21:40:14 +02:00
" n (numeric) estimated priority \n "
2014-03-17 13:19:54 +01:00
" \n "
2015-07-08 21:40:14 +02:00
" A negative value is returned if not enough transactions and blocks \n "
" have been observed to make an estimate. \n "
2014-03-17 13:19:54 +01:00
" \n Example: \n "
+ HelpExampleCli ( " estimatepriority " , " 6 " )
) ;
2014-08-20 21:15:16 +02:00
RPCTypeCheck ( params , boost : : assign : : list_of ( UniValue : : VNUM ) ) ;
2014-03-17 13:19:54 +01:00
int nBlocks = params [ 0 ] . get_int ( ) ;
if ( nBlocks < 1 )
nBlocks = 1 ;
return mempool . estimatePriority ( nBlocks ) ;
}